diff --git a/fern.schema.json b/fern.schema.json index 349f5983914..e5cc6843dc6 100644 --- a/fern.schema.json +++ b/fern.schema.json @@ -497,6 +497,16 @@ } ] }, + "inline": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, "docs": { "oneOf": [ { @@ -700,6 +710,16 @@ } ] }, + "inline": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, "docs": { "oneOf": [ { @@ -1033,6 +1053,16 @@ } ] }, + "inline": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, "docs": { "oneOf": [ { @@ -1189,6 +1219,16 @@ } ] }, + "inline": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, "docs": { "oneOf": [ { @@ -1274,6 +1314,16 @@ } ] }, + "inline": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, "docs": { "oneOf": [ { diff --git a/fern/apis/fern-definition/definition/commons.yml b/fern/apis/fern-definition/definition/commons.yml index 288ed436638..f3eebfb303f 100644 --- a/fern/apis/fern-definition/definition/commons.yml +++ b/fern/apis/fern-definition/definition/commons.yml @@ -1,39 +1,39 @@ -imports: +imports: availability: availability.yml -types: - WithDocsSchema: - properties: +types: + WithDocsSchema: + properties: docs: optional - - WithName: - properties: + + WithName: + properties: name: optional - - WithAvailability: - properties: + + WithAvailability: + properties: availability: optional - - WithDisplayName: - properties: + + WithDisplayName: + properties: display-name: optional - - WithAudiences: - properties: + + WithAudiences: + properties: audiences: optional> - - DeclarationSchema: - extends: + + DeclarationSchema: + extends: - WithDocsSchema - WithAvailability - WithAudiences - - DeclarationWithoutDocsSchema: - extends: + + DeclarationWithoutDocsSchema: + extends: - WithAvailability - WithAudiences - - DeclarationWithNameSchema: - extends: + + DeclarationWithNameSchema: + extends: - DeclarationSchema - - WithName \ No newline at end of file + - WithName diff --git a/fern/apis/fern-definition/definition/service.yml b/fern/apis/fern-definition/definition/service.yml index 98ce8541c6c..281af2e958b 100644 --- a/fern/apis/fern-definition/definition/service.yml +++ b/fern/apis/fern-definition/definition/service.yml @@ -1,4 +1,4 @@ -imports: +imports: commons: commons.yml types: types.yml examples: examples.yml @@ -6,37 +6,37 @@ imports: source: source.yml variables: variables.yml -types: - HttpServiceSchema: - extends: +types: + HttpServiceSchema: + extends: - commons.DeclarationWithoutDocsSchema - commons.WithDisplayName - properties: + properties: auth: boolean url: optional base-path: string path-parameters: optional> idempotent: optional headers: optional> - transport: optional + transport: optional source: optional endpoints: map - ServiceTransport: - properties: - grpc: optional - - GrpcTransport: - properties: - service-name: + ServiceTransport: + properties: + grpc: optional + + GrpcTransport: + properties: + service-name: type: string docs: "The name of the gRPC service." - - HttpEndpointSchema: - extends: + + HttpEndpointSchema: + extends: - commons.WithDisplayName - commons.DeclarationSchema - properties: + properties: method: optional base-path: optional path: string @@ -53,143 +53,143 @@ types: pagination: optional transport: optional source: optional - - HttpMethodSchema: - enum: + + HttpMethodSchema: + enum: - GET - POST - PUT - PATCH - DELETE - - HttpRequest: + + HttpRequest: discriminated: false - union: + union: - string - HttpRequestSchema HttpRequestSchema: - extends: + extends: - commons.WithName - commons.WithDocsSchema - properties: + properties: content-type: optional path-parameters: optional> query-parameters: optional> headers: optional> body: optional - + TypeReferenceDeclarationWithEnvOverride: discriminated: false - union: + union: - string - TypeReferenceDeclarationWithEnvOverrideSchema - TypeReferenceDeclarationWithEnvOverrideSchema: + TypeReferenceDeclarationWithEnvOverrideSchema: extends: types.TypeReferenceDeclarationWithName - properties: + properties: env: optional HttpHeaderSchema: TypeReferenceDeclarationWithEnvOverride - - HttpRequestBodySchema: + + HttpRequestBodySchema: discriminated: false - union: + union: - string - HttpReferencedRequestBodySchema - HttpInlineRequestBodySchema - - HttpReferencedRequestBodySchema: - extends: + + HttpReferencedRequestBodySchema: + extends: - commons.WithDocsSchema properties: type: string - HttpInlineRequestBodySchema: - properties: + HttpInlineRequestBodySchema: + properties: extends: optional extra-properties: optional properties: optional> - - HttpInlineRequestBodyPropertySchema: + + HttpInlineRequestBodyPropertySchema: discriminated: false - union: + union: - string - TypeReferenceDeclarationWithContentTypeSchema - - TypeReferenceDeclarationWithContentTypeSchema: + + TypeReferenceDeclarationWithContentTypeSchema: extends: types.TypeReferenceDeclarationWithName - properties: + properties: content-type: optional - - HttpQueryParameterSchema: + + HttpQueryParameterSchema: discriminated: false - union: + union: - string - QueryParameterTypeReferenceDetailed - - QueryParameterTypeReferenceDetailed: - extends: + + QueryParameterTypeReferenceDetailed: + extends: - types.TypeReferenceDeclarationWithName - properties: + properties: allow-multiple: optional - - HttpResponseSchema: + + HttpResponseSchema: discriminated: false - union: + union: - string - HttpResponseSchemaDetailed - - HttpResponseSchemaDetailed: - extends: + + HttpResponseSchemaDetailed: + extends: - commons.WithDocsSchema - properties: + properties: type: string property: optional status-code: optional - HttpResponseStreamSchema: + HttpResponseStreamSchema: discriminated: false - union: + union: - string - HttpResponseStreamSchemaDetailed - - HttpResponseStreamSchemaDetailed: - extends: + + HttpResponseStreamSchemaDetailed: + extends: - commons.WithDocsSchema - properties: + properties: type: string format: optional terminator: optional - StreamFormat: - enum: + StreamFormat: + enum: - sse - json - - HttpPathParameterSchema: + + HttpPathParameterSchema: discriminated: false - union: + union: - types.TypeReferenceSchema - variables.VariableReferenceSchema - - Pagination: + + Pagination: discriminated: false - union: + union: - pagination.PaginationSchema - boolean - - ResponseErrorsSchema: + + ResponseErrorsSchema: type: list - ResponseError: + ResponseError: discriminated: false - union: + union: - string - ResponseErrorWithDocsSchema - - ResponseErrorWithDocsSchema: - extends: + + ResponseErrorWithDocsSchema: + extends: - commons.WithDocsSchema - properties: + properties: error: string diff --git a/fern/apis/fern-definition/definition/types.yml b/fern/apis/fern-definition/definition/types.yml index 0b78c7b030d..3352aebba2b 100644 --- a/fern/apis/fern-definition/definition/types.yml +++ b/fern/apis/fern-definition/definition/types.yml @@ -1,151 +1,152 @@ -imports: +imports: commons: commons.yml encoding: encoding.yml validation: validation.yml examples: examples.yml source: source.yml -types: - TypeDeclarationSchema: +types: + TypeDeclarationSchema: discriminated: false - union: + union: - string - ObjectSchema - EnumSchema - DiscriminatedUnionSchema - UndiscriminatedUnionSchema - AliasSchema - - # InlinedTypeDeclaration: + + # InlinedTypeDeclaration: # discriminated: false - # union: + # union: # - InlinedObjectSchema # - InlinedEnumSchema # - InlinedDiscriminatedUnionSchema # - InlinedUndiscriminatedUnionSchema - - # InlinedObjectSchema: + + # InlinedObjectSchema: # extends: ObjectSchema - # properties: + # properties: # name: string - # InlinedEnumSchema: + # InlinedEnumSchema: # extends: EnumSchema - # properties: + # properties: # name: string - - # InlinedDiscriminatedUnionSchema: + + # InlinedDiscriminatedUnionSchema: # extends: DiscriminatedUnionSchema - # properties: - # name: string + # properties: + # name: string - # InlinedUndiscriminatedUnionSchema: + # InlinedUndiscriminatedUnionSchema: # extends: UndiscriminatedUnionSchema - # properties: - # name: string + # properties: + # name: string - TypeReferenceSchema: + TypeReferenceSchema: discriminated: false - union: + union: - string - TypeReferenceDetailedSchema - - BaseTypeReferenceSchema: - extends: + + BaseTypeReferenceSchema: + extends: - commons.WithDocsSchema - commons.WithAvailability - properties: + properties: default: optional encoding: optional validation: optional - - TypeReferenceDetailedSchema: - extends: + + TypeReferenceDetailedSchema: + extends: - BaseTypeReferenceSchema - commons.WithName - commons.WithAudiences - properties: + properties: type: string - TypeReferenceDeclarationWithNameSchema: + TypeReferenceDeclarationWithNameSchema: discriminated: false - union: + union: - string - TypeReferenceDeclarationWithName - + TypeReferenceDeclarationWithName: - extends: + extends: - BaseTypeReferenceSchema - commons.WithName - commons.WithAudiences - properties: + properties: type: string - - BaseTypeDeclarationSchema: - extends: + + BaseTypeDeclarationSchema: + extends: - commons.WithDocsSchema - commons.WithAvailability - commons.WithAudiences - properties: + properties: examples: optional> encoding: optional source: optional - - ### Aliases #### + inline: optional - AliasSchema: + ### Aliases #### + + AliasSchema: extends: BaseTypeDeclarationSchema - properties: + properties: type: string validation: optional - + #### Objects #### - ObjectSchema: + ObjectSchema: extends: BaseTypeDeclarationSchema - properties: + properties: extends: optional properties: optional> extra-properties: optional - + ObjectPropertySchema: TypeReferenceDeclarationWithNameSchema - - ObjectExtendsSchema: + + ObjectExtendsSchema: discriminated: false - union: + union: - string - list # ObjectPropertyDeclaration: - # discriminated: false - # union: + # discriminated: false + # union: # - TypeReference # - InlinedTypeDeclaration - + #### Enums #### - - EnumSchema: + + EnumSchema: extends: BaseTypeDeclarationSchema - properties: + properties: default: optional enum: list - + EnumValue: discriminated: false - union: + union: - string - EnumValueSchema - - EnumValueSchema: - extends: + + EnumValueSchema: + extends: - commons.WithDocsSchema - commons.WithName - properties: + properties: value: string casing: optional - - CasingOverridesSchema: - properties: + + CasingOverridesSchema: + properties: camel: optional snake: optional pascal: optional @@ -153,71 +154,71 @@ types: #### Discriminated Union #### - SingleUnionTypeSchema: + SingleUnionTypeSchema: discriminated: false - union: + union: - string - - SingleUnionTypeDetailedSchema - - SingleUnionTypeDetailedSchema: - extends: + - SingleUnionTypeDetailedSchema + + SingleUnionTypeDetailedSchema: + extends: - commons.WithDocsSchema - commons.WithName - commons.WithAvailability - commons.WithDisplayName - properties: + properties: type: optional key: optional - - SingleUnionTypeKey: + + SingleUnionTypeKey: discriminated: false - union: + union: - string - SingleUnionTypeKeySchema - SingleUnionTypeKeySchema: - extends: + SingleUnionTypeKeySchema: + extends: - commons.WithName - properties: + properties: value: string - - DiscriminatedUnionSchema: + + DiscriminatedUnionSchema: extends: BaseTypeDeclarationSchema - properties: + properties: discriminant: optional extends: optional base-properties: optional> union: map - - UnionDiscriminant: + + UnionDiscriminant: discriminated: false - union: + union: - string - UnionDiscriminantSchema - - UnionDiscriminantSchema: - extends: + + UnionDiscriminantSchema: + extends: - commons.WithName - properties: + properties: value: string -#### Undiscriminated Union #### + #### Undiscriminated Union #### - UndiscriminatedUnionSchema: + UndiscriminatedUnionSchema: extends: BaseTypeDeclarationSchema - properties: + properties: discriminated: literal union: list - - SingleUndiscriminatedUnionTypeSchema: + + SingleUndiscriminatedUnionTypeSchema: discriminated: false - union: + union: - string - SingleUndiscriminatedUnionTypeDetailedSchema - + SingleUndiscriminatedUnionTypeDetailedSchema: - extends: + extends: - commons.WithDocsSchema - commons.WithDisplayName - properties: - type: string \ No newline at end of file + properties: + type: string diff --git a/fern/pages/changelogs/cli/2024-11-11.mdx b/fern/pages/changelogs/cli/2024-11-11.mdx index cee5e04d9c4..e4cbdcffd9f 100644 --- a/fern/pages/changelogs/cli/2024-11-11.mdx +++ b/fern/pages/changelogs/cli/2024-11-11.mdx @@ -1,5 +1,5 @@ ## 0.45.0-rc39 -**`(fix):`** The OpenAPI importer now supports correlating request and response examples by name. When an example name is shared +**`(fix):`** The OpenAPI importer now supports correlating request and response examples by name. When an example name is shared between a request body and response, they will be paired together in the generated Fern definition. diff --git a/fern/pages/changelogs/cli/2024-11-26.mdx b/fern/pages/changelogs/cli/2024-11-26.mdx new file mode 100644 index 00000000000..14dfd413993 --- /dev/null +++ b/fern/pages/changelogs/cli/2024-11-26.mdx @@ -0,0 +1,5 @@ +## 0.45.1 +**`(internal):`** Add `inline` field to type declarations in the Fern definition and IR. +Add support for importing inline types from OpenAPI into Fern definition and IR. + + diff --git a/package-yml.schema.json b/package-yml.schema.json index ea25e26f1c9..066469c46ac 100644 --- a/package-yml.schema.json +++ b/package-yml.schema.json @@ -517,6 +517,16 @@ } ] }, + "inline": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, "docs": { "oneOf": [ { @@ -720,6 +730,16 @@ } ] }, + "inline": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, "docs": { "oneOf": [ { @@ -1053,6 +1073,16 @@ } ] }, + "inline": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, "docs": { "oneOf": [ { @@ -1209,6 +1239,16 @@ } ] }, + "inline": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, "docs": { "oneOf": [ { @@ -1294,6 +1334,16 @@ } ] }, + "inline": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, "docs": { "oneOf": [ { diff --git a/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/converters/ExampleEndpointFactory.ts b/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/converters/ExampleEndpointFactory.ts index 918e0e9de61..1a63a057b4f 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/converters/ExampleEndpointFactory.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-parser/src/openapi/v3/converters/ExampleEndpointFactory.ts @@ -571,7 +571,8 @@ function convertMultipartRequestToSchema(request: RequestWithExample.Multipart): generatedName: property.key, nameOverride: undefined, availability: undefined, - readonly: undefined + readonly: undefined, + inline: undefined }; }) .filter(isNonNullish), diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/ada.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/ada.json index bf145c9b59b..230d517d5a7 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/ada.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/ada.json @@ -277,6 +277,7 @@ "EndUser": "unknown", "EndUserCreatedWebhookPayload": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional", "timestamp": "optional", @@ -289,6 +290,7 @@ "EndUserRequest": "unknown", "EndUserUpdatedWebhookPayload": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional", "timestamp": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/anyOf.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/anyOf.json index b0be7e7f005..cf8ad12d6e2 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/anyOf.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/anyOf.json @@ -58,6 +58,7 @@ "Response": { "docs": "A generic response type used throughout the API. ", + "inline": undefined, "properties": { "value": { "docs": "An optional numerical value. diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/apiture.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/apiture.json index 813246030a3..e53655a955b 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/apiture.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/apiture.json @@ -4142,6 +4142,7 @@ This error response may have one of the following `type` values: "types": { "AbstractBody": { "docs": "An abstract schema used to define other request and response body model schemas.", + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4153,6 +4154,7 @@ This error response may have one of the following `type` values: "AbstractBody", "AbstractPagedBodyFields", ], + "inline": undefined, "properties": { "start": { "docs": "The opaque cursor that specifies the starting location of this page of items.", @@ -4171,6 +4173,7 @@ This error response may have one of the following `type` values: }, "AbstractPagedBodyFields": { "docs": "Common properties of collection page responses.", + "inline": undefined, "properties": { "limit": { "default": 100, @@ -4205,6 +4208,7 @@ This error response may have one of the following `type` values: "AbstractBody", "AccountFields", ], + "inline": undefined, "properties": { "allows": { "docs": "Flags which indicate the permissions the current authorized user has on this account resource.", @@ -4276,6 +4280,7 @@ This error response may have one of the following `type` values: }, "AccountBalance": { "docs": "The current balances of the given account.", + "inline": undefined, "properties": { "available": { "docs": "The available balance: the funds available for use. This is the string representation of the exact decimal amount.", @@ -4311,6 +4316,7 @@ This error response may have one of the following `type` values: "extends": [ "AbstractBody", ], + "inline": undefined, "properties": { "items": { "docs": "An array of items, one for each of the `?accounts=` in the request, returned in the same order.", @@ -4323,6 +4329,7 @@ This error response may have one of the following `type` values: }, "AccountFields": { "docs": "Fragment schema use to build other account schemas.", + "inline": undefined, "properties": { "id": { "docs": "The unique identifier for this account resource. This is an immutable opaque string.", @@ -4362,6 +4369,7 @@ This error response may have one of the following `type` values: }, "AccountItem": { "docs": "An account item in a list items in the `accounts` schema.", + "inline": undefined, "properties": { "allows": { "type": "AccountPermissions", @@ -4397,6 +4405,7 @@ This error response may have one of the following `type` values: "extends": [ "AbstractBody", ], + "inline": undefined, "properties": { "id": "ReadOnlyResourceId", "name": { @@ -4416,6 +4425,7 @@ This error response may have one of the following `type` values: }, "AccountJointOwners": { "docs": undefined, + "inline": undefined, "properties": { "items": { "docs": "An array containing account joint owner items.", @@ -4453,6 +4463,7 @@ Account transfers are only allowed between `internal` and `external` accounts. A }, "AccountPermissions": { "docs": "Flags which indicate the permissions the current authorized user has on this account item resource. Most of these properties may only be `true` for internal accounts. These permissions are available in account items in the [`accounts`](#schema-accounts) list. See [`fullAccountPermissions`](#schema-fullAccountPermissions) for all capabilities a customer has on an account (the `account.allows` object in the [`account`](#schema-account) object response from [`getAccount`](#op-getAccount).)", + "inline": undefined, "properties": { "billPay": { "docs": "If `true`, the customer may use this account for Bill Pay.", @@ -4502,6 +4513,7 @@ Account transfers are only allowed between `internal` and `external` accounts. A "extends": [ "AbstractBody", ], + "inline": undefined, "properties": { "count": { "docs": "The total number of accounts for which the user has access. This value ignores any filters. This value is _optional_ and may be omitted if the count is not computable efficiently.", @@ -4664,6 +4676,7 @@ Account transfers are only allowed between `internal` and `external` accounts. A "extends": [ "AddressFields", ], + "inline": undefined, "properties": { "postalCode": { "docs": "The postal code, which varies in format by country. If `countryCode` is `US`, this should be a five digit US ZIP code or ten character ZIP+4.", @@ -4702,6 +4715,7 @@ Account transfers are only allowed between `internal` and `external` accounts. A }, "AddressFields": { "docs": "Properties of a simple address, used to compose other addresses.", + "inline": undefined, "properties": { "address1": { "docs": "The first line of the postal address. In the US, this typically includes the building number and street name.", @@ -4760,6 +4774,7 @@ Account transfers are only allowed between `internal` and `external` accounts. A }, "ApiProblem": { "docs": "API problem or error, as per [RFC 7807 application/problem+json](https://tools.ietf.org/html/rfc7807).", + "inline": undefined, "properties": { "attributes": { "docs": "Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.", @@ -4816,6 +4831,7 @@ Account transfers are only allowed between `internal` and `external` accounts. A }, "ChallengeFactor": { "docs": "An challenge factor. See [`requiredIdentityChallenge`](#schema-requiredIdentityChallenge) for multiple examples.", + "inline": undefined, "properties": { "labels": { "docs": "A list of text label which identifies the channel(s) though which the user completes the challenge. For an `sms` or `voice` challenge, the only label item is the last four digits of the corresponding phone number. For an `email` challenge, each label is the masked email address.", @@ -4889,6 +4905,7 @@ Account transfers are only allowed between `internal` and `external` accounts. A }, "ChallengeSecurityQuestion": { "docs": "A single security question within the `questions` array of the [`challengeSecurityQuestions`](#schema-challengeSecurityQuestions)", + "inline": undefined, "properties": { "id": { "docs": "The unique ID of security question prompt. This should be included in the [`challengeVerification`](#schema-challengeVerification) response as the `promptId`.", @@ -4911,6 +4928,7 @@ Account transfers are only allowed between `internal` and `external` accounts. A }, "ChallengeSecurityQuestions": { "docs": "Describes a `securityQuestions` challenge. This is omitted if the challenge `type` is not `securityQuestions`.", + "inline": undefined, "properties": { "questions": { "docs": "The array of security questions.", @@ -4947,6 +4965,7 @@ Account transfers are only allowed between `internal` and `external` accounts. A }, "CutoffTime": { "docs": "A representation of a cutoff time for a money movement process at a financial institution.", + "inline": undefined, "properties": { "time": { "docs": "The cutoff time for a product formatted in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) `time` format: `hh:mm`. The time is expressed in 24 hour time and is set to the local time zone of the financial institution.", @@ -5021,6 +5040,7 @@ Account transfers are only allowed between `internal` and `external` accounts. A "extends": [ "AbstractBody", ], + "inline": undefined, "properties": { "items": { "docs": "A list of cutoff times for a financial institution.", @@ -5055,6 +5075,7 @@ The client can use this value to localize the `items[].time` values to the local "extends": [ "AbstractBody", ], + "inline": undefined, "properties": { "items": "unknown", "limit": { @@ -5155,6 +5176,7 @@ The client can use this value to localize the `items[].time` values to the local "extends": [ "AccountPermissions", ], + "inline": undefined, "properties": { "manageJointOwners": { "docs": "If `true`, the customer can list the other joint owners on the account and invite new joint owners.", @@ -5174,6 +5196,7 @@ The client can use this value to localize the `items[].time` values to the local "extends": [ "AbstractBody", ], + "inline": undefined, "properties": { "incompleteAccounts": { "docs": "Pass these values as the `?accounts=` query parameter on the next retry of the [`listAccountBalances`](#op-listAccountBalances) operation. This value is empty if the client has reached the retry limit.", @@ -5204,6 +5227,7 @@ The client can use this value to localize the `items[].time` values to the local "extends": [ "AbstractBody", ], + "inline": undefined, "properties": { "retryCount": { "docs": "Pass this value as the as the `?retryCount=` parameter with the next retry of the [`listTransactions`](#op-listTransactions) operation.", @@ -5271,6 +5295,7 @@ The client can use this value to localize the `items[].time` values to the local "extends": [ "AbstractBody", ], + "inline": undefined, "properties": { "found": { "docs": "`true` if a financial institution was found matching the requested FI locator, `false` if none was found.", @@ -5295,6 +5320,7 @@ The client can use this value to localize the `items[].time` values to the local "AbstractBody", "JointOwnerInvitationFields", ], + "inline": undefined, "properties": { "id": { "docs": "The unique ID of the invitation.", @@ -5307,6 +5333,7 @@ The client can use this value to localize the `items[].time` values to the local }, "JointOwnerInvitationFields": { "docs": "Fields used to compose other joint owner invitation schemas.", + "inline": undefined, "properties": { "disallowDebitCardAccess": { "default": false, @@ -5390,6 +5417,7 @@ The client can use this value to localize the `items[].time` values to the local }, "OverdraftAccountFields": { "docs": "Fields of an overdraft protection account, used to compose other schemas.", + "inline": undefined, "properties": { "id": { "docs": "The unique ID of the account resource. Use this as the `{accountId}` in [`getAccount`](#op-getAccount) or [`listAccountBalances`](#op-listAccountBalances).", @@ -5423,6 +5451,7 @@ The client can use this value to localize the `items[].time` values to the local "AbstractBody", "OverdraftProtectionFields", ], + "inline": undefined, "properties": { "maximumOverdraftAccounts": { "docs": "The maximum number of overdraft protection accounts that may be linked to the account.", @@ -5442,6 +5471,7 @@ The client can use this value to localize the `items[].time` values to the local }, "OverdraftProtectionFields": { "docs": "Fields used to compose other overdraft protection schemas.", + "inline": undefined, "properties": { "accounts": { "type": "optional", @@ -5467,6 +5497,7 @@ The client can use this value to localize the `items[].time` values to the local "AbstractBody", "ApiProblem", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -5474,6 +5505,7 @@ The client can use this value to localize the `items[].time` values to the local }, "ProductReference": { "docs": "A reference to a banking product.", + "inline": undefined, "properties": { "code": { "docs": "The product's product code. Codes are unique to the financial institution.", @@ -5574,6 +5606,7 @@ The client can use this value to localize the `items[].time` values to the local }, "RequiredIdentityChallenge": { "docs": "A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 [Unauthorized problem response](#schema-apiProblem) when the 401 problem type name is `challengeRequired`. See the "Challenge API" for details.", + "inline": undefined, "properties": { "challengeId": { "docs": "The unique ID of this challenge instance. This is an opaque string. This is passed when starting a challenge factor or when validating the identity challenge responses.", @@ -5604,6 +5637,7 @@ The client can use this value to localize the `items[].time` values to the local }, "SimpleInstitution": { "docs": "A simple representation of a financial institution.", + "inline": undefined, "properties": { "address": { "docs": "The financial institution's postal mailing address.", @@ -5650,6 +5684,7 @@ The client can use this value to localize the `items[].time` values to the local }, "TimestampFields": { "docs": "Timestamps which describe when a resource was created or last updated.", + "inline": undefined, "properties": { "createdAt": { "docs": "The date-time when this resource was created, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. This is derived and immutable.", @@ -5666,6 +5701,7 @@ The client can use this value to localize the `items[].time` values to the local }, "TransactionCategories": { "docs": undefined, + "inline": undefined, "properties": { "items": { "docs": "An array containing transaction category items.", @@ -5678,6 +5714,7 @@ The client can use this value to localize the `items[].time` values to the local }, "TransactionCategorization": { "docs": "The transaction categorization.", + "inline": undefined, "properties": { "id": { "docs": "The unique ID of this transaction's category.", @@ -5703,6 +5740,7 @@ The client can use this value to localize the `items[].time` values to the local "AbstractBody", "TransactionCategorization", ], + "inline": undefined, "properties": { "type": { "type": "TransactionCategoryType", @@ -5754,6 +5792,7 @@ The client can use this value to localize the `items[].time` values to the local }, "TransactionCheck": { "docs": "Describes a check associated with a transaction for a checking account. This object is only present if the transaction `type` is `debit` and the `subtype` is `check`.", + "inline": undefined, "properties": { "imageBack_url": { "docs": "The URL for downloading the image of the front of the check.", @@ -5793,6 +5832,7 @@ The client can use this value to localize the `items[].time` values to the local }, "TransactionFields": { "docs": "Common fields of the transaction resource used to build other model schemas.", + "inline": undefined, "properties": { "amount": { "docs": "The transaction amount in dollars. This value is negative if the transaction is a debit and positive if it is a credit.", @@ -5897,6 +5937,7 @@ The client can use this value to localize the `items[].time` values to the local "AbstractBody", "TransactionFields", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -5904,6 +5945,7 @@ The client can use this value to localize the `items[].time` values to the local }, "TransactionMerchant": { "docs": "Describes the merchant associated with a transaction.", + "inline": undefined, "properties": { "logo_url": { "docs": "The optional URL of the merchant's logo. This image must be an image resource (SVG, PNG, GIF, JPEG image) that does not require any authentication. The URL may contain query parameters.", @@ -6010,6 +6052,7 @@ The client can use this value to localize the `items[].time` values to the local "extends": [ "AbstractPagedBody", ], + "inline": undefined, "properties": { "count": { "docs": "The total number of transactions which satisfy the request filters. This is optional and only included if the service can calculate it.", @@ -6037,6 +6080,7 @@ The client can use this value to localize the `items[].time` values to the local "AbstractBody", "TransferItem", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -6044,6 +6088,7 @@ The client can use this value to localize the `items[].time` values to the local }, "TransferAccountReference": { "docs": "A reference to a banking account used within an account to account transfer. This object may be set from an account's `account.reference` object.", + "inline": undefined, "properties": { "id": { "docs": "The unique ID of a banking account.", @@ -6074,6 +6119,7 @@ The client can use this value to localize the `items[].time` values to the local }, "TransferDateRestriction": { "docs": "A date where a transfer restriction occurs, and the `reason` it is restricted. If the `reason` is `holiday`, `closure` and the transfer is an ACH transfer, the object also contains either a `debitOn` or `creditOn` date or both.", + "inline": undefined, "properties": { "creditOn": { "docs": "The date the local financial institution account is credited in [RFC 3339 `YYYY-MM-DD`](https://tools.ietf.org/html/rfc3339) date format. This is derived from the `date` based on the `risk` level. The credit-on date normally falls one business day after the restricted `date`. This property is only returned if the payment `type` is `achDebit` or `ach`.", @@ -6170,6 +6216,7 @@ The response may include dates prior to requested the start date, as that is use "extends": [ "AbstractBody", ], + "inline": undefined, "properties": { "accuracyEndsOn": { "docs": "The service only knows [bank holidays](https://www.federalreserve.gov/aboutthefed/k8.htm) for about two to four years in advance. This date is the end of that known holiday schedule, although the requested dates may extend well beyond this date. Any dates in the response beyond this date may omit holidays but may include other restricted dates based on the financial institution's normal scheduled closures such as Saturdays and Sundays.", @@ -6192,6 +6239,7 @@ The response may include dates prior to requested the start date, as that is use }, "TransferFields": { "docs": "Common fields of the transfer resource used to build other model schemas.", + "inline": undefined, "properties": { "amount": { "docs": "The amount of money to transfer between accounts.", @@ -6311,6 +6359,7 @@ The response may include dates prior to requested the start date, as that is use "TransferFields", "TimestampFields", ], + "inline": undefined, "properties": { "id": { "docs": "The unique identifier for this transfer resource. This is an immutable opaque string.", @@ -6348,6 +6397,7 @@ The response may include dates prior to requested the start date, as that is use "extends": [ "TransferSchedule", ], + "inline": undefined, "properties": { "creditsOn": { "docs": "The effective the transfer is scheduled to credit the target account, in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) `date` format. This is derived from the `scheduledOn` date, based on the financial institution's transfer rules.", @@ -6408,6 +6458,7 @@ The response may include dates prior to requested the start date, as that is use "docs": "The scheduled date when the transfer should be completed, the recurrence, if any, and other derived dates based on the scheduled date. For recurring transfer schedules, `endsOn`, `count`, and `amountLimit` are mutually exclusive.", + "inline": undefined, "properties": { "amountLimit": { "docs": "For recurring schedules (`frequency` is not `once`), this is the total dollar amount limit including the first transfer. No transfers are scheduled if they would exceed this amount. This property is ignored if `frequency` is `once`.", @@ -6493,6 +6544,7 @@ For recurring transfer schedules, `endsOn`, `count`, and `amountLimit` are mutua }, "TransferScheduleItem": { "docs": "Summary representation of a transfer schedule resource in transfer schedule list.", + "inline": undefined, "properties": { "effectiveOn": { "docs": "The effective date of the recurrence in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format. When the effective date differs from the scheduled date, it is due to a banking holiday, weekend, or other non-business day. The date is adjusted to before the scheduled date when the transfer direction is `credit` and adjusted to after the scheduled date when the transfer direction is `debit`.", @@ -6524,6 +6576,7 @@ For recurring transfer schedules, `endsOn`, `count`, and `amountLimit` are mutua "extends": [ "AbstractBody", ], + "inline": undefined, "properties": { "items": { "docs": "An array containing upcoming transfer schedule items.", @@ -6643,6 +6696,7 @@ For recurring transfer schedules, `endsOn`, `count`, and `amountLimit` are mutua "extends": [ "AbstractPagedBody", ], + "inline": undefined, "properties": { "count": { "docs": "The number of transfers that meet the filters in the `listTransfers` operation. This is optional and only included if the service can calculate it efficiently.", @@ -6669,6 +6723,7 @@ For recurring transfer schedules, `endsOn`, `count`, and `amountLimit` are mutua "extends": [ "SimpleInstitution", ], + "inline": undefined, "properties": { "localClearingCode": { "docs": "The clearing code used to identify the financial institution for select countries.", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/application-json.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/application-json.json index e2c70ce1468..38a6d0941a4 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/application-json.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/application-json.json @@ -65,6 +65,7 @@ "types": { "Data": { "docs": undefined, + "inline": undefined, "properties": { "bar": "optional", "foo": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/aries.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/aries.json index a2ba8aa0d7c..ce5781685ec 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/aries.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/aries.json @@ -89,6 +89,7 @@ "types": { "AMLRecord": { "docs": undefined, + "inline": undefined, "properties": { "aml": { "type": "optional>", @@ -106,6 +107,7 @@ }, "ActionMenuFetchResult": { "docs": undefined, + "inline": undefined, "properties": { "result": { "type": "optional", @@ -122,6 +124,7 @@ "ActionMenuModulesResult": "map", "AdminConfig": { "docs": undefined, + "inline": undefined, "properties": { "config": { "docs": "Configuration settings", @@ -134,6 +137,7 @@ }, "AdminConfigConfig": { "docs": "Configuration settings", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -141,6 +145,7 @@ }, "AdminModules": { "docs": undefined, + "inline": undefined, "properties": { "result": { "docs": "List of admin modules", @@ -155,6 +160,7 @@ "AdminShutdown": "map", "AdminStatus": { "docs": undefined, + "inline": undefined, "properties": { "conductor": { "docs": "Conductor statistics", @@ -179,6 +185,7 @@ }, "AdminStatusConductor": { "docs": "Conductor statistics", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -186,6 +193,7 @@ }, "AdminStatusLiveliness": { "docs": undefined, + "inline": undefined, "properties": { "alive": { "docs": "Liveliness status", @@ -198,6 +206,7 @@ }, "AdminStatusReadiness": { "docs": undefined, + "inline": undefined, "properties": { "ready": { "docs": "Readiness status", @@ -210,6 +219,7 @@ }, "AdminStatusTiming": { "docs": "Timing results", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -217,6 +227,7 @@ }, "AttachDecorator": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Attachment identifier", @@ -258,6 +269,7 @@ }, "AttachDecoratorData": { "docs": undefined, + "inline": undefined, "properties": { "base64": { "docs": "Base64-encoded data", @@ -297,6 +309,7 @@ }, "AttachDecoratorData1Jws": { "docs": undefined, + "inline": undefined, "properties": { "header": { "type": "AttachDecoratorDataJWSHeader", @@ -328,6 +341,7 @@ }, "AttachDecoratorDataJWS": { "docs": undefined, + "inline": undefined, "properties": { "header": { "type": "optional", @@ -363,6 +377,7 @@ }, "AttachDecoratorDataJWSHeader": { "docs": undefined, + "inline": undefined, "properties": { "kid": { "docs": "Key identifier, in W3C did:key or DID URL format", @@ -385,6 +400,7 @@ }, "AttachmentDef": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "Attachment identifier", @@ -417,6 +433,7 @@ }, "AttributeMimeTypesResult": { "docs": undefined, + "inline": undefined, "properties": { "results": { "type": "optional>>", @@ -429,6 +446,7 @@ "BasicMessageModuleResponse": "map", "ClaimFormat": { "docs": undefined, + "inline": undefined, "properties": { "jwt": { "type": "optional", @@ -455,6 +473,7 @@ }, "ClaimFormatJwtVc": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -462,6 +481,7 @@ }, "ClaimFormatJwtVp": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -469,6 +489,7 @@ }, "ClaimFormatLdpVc": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -476,6 +497,7 @@ }, "ClaimFormatLdpVp": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -483,6 +505,7 @@ }, "ConnRecord": { "docs": undefined, + "inline": undefined, "properties": { "accept": { "docs": "Connection acceptance: manual or auto", @@ -662,6 +685,7 @@ }, "ConnectionInvitation": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -708,6 +732,7 @@ }, "ConnectionList": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "List of connection records", @@ -720,6 +745,7 @@ }, "ConnectionMetadata": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "Dictionary of metadata associated with connection.", @@ -732,6 +758,7 @@ }, "ConnectionMetadataResults": { "docs": "Dictionary of metadata associated with connection.", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -740,6 +767,7 @@ "ConnectionModuleResponse": "map", "ConnectionStaticResult": { "docs": undefined, + "inline": undefined, "properties": { "my_did": { "docs": "Local DID", @@ -801,6 +829,7 @@ }, "Constraints": { "docs": undefined, + "inline": undefined, "properties": { "fields": { "type": "optional>", @@ -872,6 +901,7 @@ }, "CreateWalletResponse": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Time of record creation", @@ -930,6 +960,7 @@ }, "CreateWalletResponseSettings": { "docs": "Settings for this wallet.", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -937,6 +968,7 @@ }, "CreateWalletTokenResponse": { "docs": undefined, + "inline": undefined, "properties": { "token": { "docs": "Authorization token to authenticate wallet requests", @@ -949,6 +981,7 @@ }, "CredAttrSpec": { "docs": undefined, + "inline": undefined, "properties": { "mime-type": { "docs": "MIME type: omit for (null) default", @@ -969,6 +1002,7 @@ }, "CredDefValue": { "docs": undefined, + "inline": undefined, "properties": { "primary": { "type": "optional", @@ -983,6 +1017,7 @@ }, "CredDefValuePrimary": { "docs": undefined, + "inline": undefined, "properties": { "n": { "type": "optional", @@ -1030,6 +1065,7 @@ }, "CredDefValueRevocation": { "docs": undefined, + "inline": undefined, "properties": { "g": { "type": "optional", @@ -1071,6 +1107,7 @@ }, "CredInfoList": { "docs": undefined, + "inline": undefined, "properties": { "results": { "type": "optional>", @@ -1082,6 +1119,7 @@ }, "CredRevIndyRecordsResult": { "docs": undefined, + "inline": undefined, "properties": { "rev_reg_delta": { "docs": "Indy revocation registry delta", @@ -1094,6 +1132,7 @@ }, "CredRevIndyRecordsResultRevRegDelta": { "docs": "Indy revocation registry delta", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -1101,6 +1140,7 @@ }, "CredRevRecordDetailsResult": { "docs": undefined, + "inline": undefined, "properties": { "results": { "type": "optional>", @@ -1112,6 +1152,7 @@ }, "CredRevRecordResult": { "docs": undefined, + "inline": undefined, "properties": { "result": { "type": "optional", @@ -1123,6 +1164,7 @@ }, "CredRevokedResult": { "docs": undefined, + "inline": undefined, "properties": { "revoked": { "docs": "Whether credential is revoked on the ledger", @@ -1135,6 +1177,7 @@ }, "Credential": { "docs": undefined, + "inline": undefined, "properties": { "@context": { "docs": "The JSON-LD context of the credential", @@ -1190,6 +1233,7 @@ }, "CredentialDefinition": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "Credential definition identifier", @@ -1233,6 +1277,7 @@ }, "CredentialDefinitionGetResult": { "docs": undefined, + "inline": undefined, "properties": { "credential_definition": { "type": "optional", @@ -1244,6 +1289,7 @@ }, "CredentialDefinitionSendResult": { "docs": undefined, + "inline": undefined, "properties": { "credential_definition_id": { "docs": "Credential definition identifier", @@ -1266,6 +1312,7 @@ }, "CredentialDefinitionsCreatedResult": { "docs": undefined, + "inline": undefined, "properties": { "credential_definition_ids": { "type": "optional>", @@ -1277,6 +1324,7 @@ }, "CredentialOffer": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -1303,6 +1351,7 @@ }, "CredentialPreview": { "docs": undefined, + "inline": undefined, "properties": { "@type": { "docs": "Message type identifier", @@ -1320,6 +1369,7 @@ }, "CredentialProposal": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -1391,6 +1441,7 @@ }, "CredentialStatusOptions": { "docs": undefined, + "inline": undefined, "properties": { "type": { "docs": "Credential status method type to use for the credential. Should match status method registered in the Verifiable Credential Extension Registry", @@ -1403,6 +1454,7 @@ }, "DID": { "docs": undefined, + "inline": undefined, "properties": { "did": { "docs": "DID of interest", @@ -1443,6 +1495,7 @@ }, "DIDCreateOptions": { "docs": undefined, + "inline": undefined, "properties": { "did": { "docs": "Specify final value of the did (including did:: prefix)if the method supports or requires so.", @@ -1465,6 +1518,7 @@ }, "DIDEndpoint": { "docs": undefined, + "inline": undefined, "properties": { "did": { "docs": "DID of interest", @@ -1493,6 +1547,7 @@ }, "DIDList": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "DID list", @@ -1505,6 +1560,7 @@ }, "DIDResult": { "docs": undefined, + "inline": undefined, "properties": { "result": { "type": "optional", @@ -1516,6 +1572,7 @@ }, "DIFField": { "docs": undefined, + "inline": undefined, "properties": { "filter": { "type": "optional", @@ -1542,6 +1599,7 @@ }, "DIFHolder": { "docs": undefined, + "inline": undefined, "properties": { "directive": { "docs": "Preference", @@ -1557,6 +1615,7 @@ }, "DIFOptions": { "docs": undefined, + "inline": undefined, "properties": { "challenge": { "docs": "Challenge protect against replay attack", @@ -1579,6 +1638,7 @@ }, "DIFPresSpec": { "docs": undefined, + "inline": undefined, "properties": { "issuer_id": { "docs": "Issuer identifier to sign the presentation, if different from current public DID", @@ -1602,6 +1662,7 @@ }, "DIFProofProposal": { "docs": undefined, + "inline": undefined, "properties": { "input_descriptors": { "type": "optional>", @@ -1616,6 +1677,7 @@ }, "DIFProofRequest": { "docs": undefined, + "inline": undefined, "properties": { "options": { "type": "optional", @@ -1669,6 +1731,7 @@ }, "DifPresSpecRecordIds": { "docs": "Mapping of input_descriptor id to list of stored W3C credential record_id", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -1676,6 +1739,7 @@ }, "DifPresSpecRevealDoc": { "docs": "reveal doc [JSON-LD frame] dict used to derive the credential when selective disclosure is required", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -1683,6 +1747,7 @@ }, "Disclose": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -1703,6 +1768,7 @@ }, "Disclosures": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -1723,6 +1789,7 @@ }, "Doc": { "docs": undefined, + "inline": undefined, "properties": { "credential": { "docs": "Credential to sign", @@ -1736,6 +1803,7 @@ }, "DocCredential": { "docs": "Credential to sign", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -1747,6 +1815,7 @@ }, "EndorserInfo": { "docs": undefined, + "inline": undefined, "properties": { "endorser_did": { "docs": "Endorser DID", @@ -1763,6 +1832,7 @@ }, "EndpointsResult": { "docs": undefined, + "inline": undefined, "properties": { "my_endpoint": { "docs": "My endpoint", @@ -1791,6 +1861,7 @@ }, "Filter": { "docs": undefined, + "inline": undefined, "properties": { "const": { "docs": "Const", @@ -1846,6 +1917,7 @@ }, "Generated": { "docs": undefined, + "inline": undefined, "properties": { "master_secret": { "type": "optional", @@ -1881,6 +1953,7 @@ }, "GetDIDEndpointResponse": { "docs": undefined, + "inline": undefined, "properties": { "endpoint": { "docs": "Full verification key", @@ -1899,6 +1972,7 @@ }, "GetDIDVerkeyResponse": { "docs": undefined, + "inline": undefined, "properties": { "verkey": { "docs": "Full verification key", @@ -1917,6 +1991,7 @@ }, "GetNymRoleResponse": { "docs": undefined, + "inline": undefined, "properties": { "role": { "docs": "Ledger role", @@ -1944,6 +2019,7 @@ "HolderModuleResponse": "map", "IndyAttrValue": { "docs": undefined, + "inline": undefined, "properties": { "encoded": { "docs": "Attribute encoded value", @@ -1966,6 +2042,7 @@ }, "IndyCredAbstract": { "docs": undefined, + "inline": undefined, "properties": { "cred_def_id": { "docs": "Credential definition identifier", @@ -2009,6 +2086,7 @@ }, "IndyCredInfo": { "docs": undefined, + "inline": undefined, "properties": { "attrs": { "docs": "Attribute names and value", @@ -2065,6 +2143,7 @@ }, "IndyCredPrecis": { "docs": undefined, + "inline": undefined, "properties": { "cred_info": { "type": "optional", @@ -2090,6 +2169,7 @@ }, "IndyCredRequest": { "docs": undefined, + "inline": undefined, "properties": { "blinded_ms": { "docs": "Blinded master secret", @@ -2136,6 +2216,7 @@ }, "IndyCredRequestBlindedMs": { "docs": "Blinded master secret", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -2143,6 +2224,7 @@ }, "IndyCredRequestBlindedMsCorrectnessProof": { "docs": "Blinded master secret correctness proof", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -2150,6 +2232,7 @@ }, "IndyCredential": { "docs": undefined, + "inline": undefined, "properties": { "cred_def_id": { "docs": "Credential definition identifier", @@ -2208,6 +2291,7 @@ }, "IndyCredentialRevReg": { "docs": "Revocation registry state", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -2215,6 +2299,7 @@ }, "IndyCredentialSignatureCorrectnessProof": { "docs": "Credential signature correctness proof", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -2226,6 +2311,7 @@ }, "IndyEQProof": { "docs": undefined, + "inline": undefined, "properties": { "a_prime": { "type": "optional", @@ -2276,6 +2362,7 @@ }, "IndyGEProof": { "docs": undefined, + "inline": undefined, "properties": { "alpha": { "type": "optional", @@ -2314,6 +2401,7 @@ }, "IndyGEProofPred": { "docs": undefined, + "inline": undefined, "properties": { "attr_name": { "docs": "Attribute name, indy-canonicalized", @@ -2346,6 +2434,7 @@ }, "IndyKeyCorrectnessProof": { "docs": undefined, + "inline": undefined, "properties": { "c": { "docs": "c in key correctness proof", @@ -2378,6 +2467,7 @@ }, "IndyNonRevocProof": { "docs": undefined, + "inline": undefined, "properties": { "c_list": { "type": "optional>", @@ -2392,6 +2482,7 @@ }, "IndyNonRevocationInterval": { "docs": undefined, + "inline": undefined, "properties": { "from": { "docs": "Earliest time of interest in non-revocation interval", @@ -2422,6 +2513,7 @@ }, "IndyPresAttrSpec": { "docs": undefined, + "inline": undefined, "properties": { "cred_def_id": { "type": "optional", @@ -2455,6 +2547,7 @@ }, "IndyPresPredSpec": { "docs": undefined, + "inline": undefined, "properties": { "cred_def_id": { "docs": "Credential definition identifier", @@ -2509,6 +2602,7 @@ }, "IndyPresPreview": { "docs": undefined, + "inline": undefined, "properties": { "@type": { "docs": "Message type identifier", @@ -2523,6 +2617,7 @@ }, "IndyPresSpec": { "docs": undefined, + "inline": undefined, "properties": { "requested_attributes": { "docs": "Nested object mapping proof request attribute referents to requested-attribute specifiers", @@ -2547,6 +2642,7 @@ }, "IndyPrimaryProof": { "docs": undefined, + "inline": undefined, "properties": { "eq_proof": { "type": "optional", @@ -2566,6 +2662,7 @@ }, "IndyProof": { "docs": undefined, + "inline": undefined, "properties": { "identifiers": { "docs": "Indy proof.identifiers content", @@ -2584,6 +2681,7 @@ }, "IndyProofIdentifier": { "docs": undefined, + "inline": undefined, "properties": { "cred_def_id": { "docs": "Credential definition identifier", @@ -2633,6 +2731,7 @@ }, "IndyProofProof": { "docs": undefined, + "inline": undefined, "properties": { "aggregated_proof": { "type": "optional", @@ -2648,6 +2747,7 @@ }, "IndyProofProofAggregatedProof": { "docs": undefined, + "inline": undefined, "properties": { "c_hash": { "docs": "c_hash value", @@ -2664,6 +2764,7 @@ }, "IndyProofProofProofsProof": { "docs": undefined, + "inline": undefined, "properties": { "non_revoc_proof": { "type": "optional", @@ -2686,6 +2787,7 @@ }, "IndyProofReqAttrSpec": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "Attribute name", @@ -2709,6 +2811,7 @@ }, "IndyProofReqAttrSpecNonRevoked": { "docs": undefined, + "inline": undefined, "properties": { "from": { "docs": "Earliest time of interest in non-revocation interval", @@ -2739,6 +2842,7 @@ }, "IndyProofReqPredSpec": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "Attribute name", @@ -2766,6 +2870,7 @@ }, "IndyProofReqPredSpecNonRevoked": { "docs": undefined, + "inline": undefined, "properties": { "from": { "docs": "Earliest time of interest in non-revocation interval", @@ -2820,6 +2925,7 @@ }, "IndyProofRequest": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "Proof request name", @@ -2863,6 +2969,7 @@ }, "IndyProofRequestNonRevoked": { "docs": undefined, + "inline": undefined, "properties": { "from": { "docs": "Earliest time of interest in non-revocation interval", @@ -2893,6 +3000,7 @@ }, "IndyProofRequestedProof": { "docs": undefined, + "inline": undefined, "properties": { "predicates": { "docs": "Proof requested proof predicates.", @@ -2921,6 +3029,7 @@ }, "IndyProofRequestedProofPredicate": { "docs": undefined, + "inline": undefined, "properties": { "sub_proof_index": { "docs": "Sub-proof index", @@ -2933,6 +3042,7 @@ }, "IndyProofRequestedProofRevealedAttr": { "docs": undefined, + "inline": undefined, "properties": { "encoded": { "docs": "Encoded value", @@ -2959,6 +3069,7 @@ }, "IndyProofRequestedProofRevealedAttrGroup": { "docs": undefined, + "inline": undefined, "properties": { "sub_proof_index": { "docs": "Sub-proof index", @@ -2975,6 +3086,7 @@ }, "IndyProofRequestedProofSelfAttestedAttrs": { "docs": "Proof requested proof self-attested attributes", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -2982,6 +3094,7 @@ }, "IndyProofRequestedProofUnrevealedAttrs": { "docs": "Unrevealed attributes", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -2989,6 +3102,7 @@ }, "IndyRequestedCredsRequestedAttr": { "docs": undefined, + "inline": undefined, "properties": { "cred_id": { "docs": "Wallet credential identifier (typically but not necessarily a UUID)", @@ -3005,6 +3119,7 @@ }, "IndyRequestedCredsRequestedPred": { "docs": undefined, + "inline": undefined, "properties": { "cred_id": { "docs": "Wallet credential identifier (typically but not necessarily a UUID)", @@ -3028,6 +3143,7 @@ }, "IndyRevRegDef": { "docs": undefined, + "inline": undefined, "properties": { "credDefId": { "docs": "Credential definition identifier", @@ -3077,6 +3193,7 @@ }, "IndyRevRegDefValue": { "docs": undefined, + "inline": undefined, "properties": { "issuanceType": { "docs": "Issuance type", @@ -3117,6 +3234,7 @@ }, "IndyRevRegDefValuePublicKeys": { "docs": undefined, + "inline": undefined, "properties": { "accumKey": { "type": "optional", @@ -3128,6 +3246,7 @@ }, "IndyRevRegDefValuePublicKeysAccumKey": { "docs": undefined, + "inline": undefined, "properties": { "z": { "docs": "Value for z", @@ -3140,6 +3259,7 @@ }, "IndyRevRegEntry": { "docs": undefined, + "inline": undefined, "properties": { "value": { "type": "optional", @@ -3161,6 +3281,7 @@ }, "IndyRevRegEntryValue": { "docs": undefined, + "inline": undefined, "properties": { "accum": { "docs": "Accumulator value", @@ -3181,6 +3302,7 @@ }, "InputDescriptors": { "docs": undefined, + "inline": undefined, "properties": { "constraints": { "type": "optional", @@ -3219,6 +3341,7 @@ "IntroModuleResponse": "map", "InvitationMessage": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -3257,6 +3380,7 @@ }, "InvitationRecord": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Time of record creation", @@ -3316,6 +3440,7 @@ }, "InvitationResult": { "docs": undefined, + "inline": undefined, "properties": { "connection_id": { "docs": "Connection identifier", @@ -3336,6 +3461,7 @@ "IssueCredentialModuleResponse": "map", "IssuerCredRevRecord": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Time of record creation", @@ -3410,6 +3536,7 @@ }, "IssuerRevRegRecord": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Time of record creation", @@ -3528,6 +3655,7 @@ }, "Keylist": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "List of keylist records", @@ -3540,6 +3668,7 @@ }, "KeylistQuery": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -3563,6 +3692,7 @@ }, "KeylistQueryFilter": { "docs": "Query dictionary object", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -3570,6 +3700,7 @@ }, "KeylistQueryPaginate": { "docs": undefined, + "inline": undefined, "properties": { "limit": { "docs": "Limit for keylist query", @@ -3586,6 +3717,7 @@ }, "KeylistUpdate": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -3606,6 +3738,7 @@ }, "KeylistUpdateRule": { "docs": undefined, + "inline": undefined, "properties": { "action": { "docs": "Action for specific key", @@ -3638,6 +3771,7 @@ }, "LDProofVCDetail": { "docs": undefined, + "inline": undefined, "properties": { "credential": "LdProofVcDetailCredential", "options": "LdProofVcDetailOptions", @@ -3648,6 +3782,7 @@ }, "LDProofVCDetailOptions": { "docs": undefined, + "inline": undefined, "properties": { "challenge": { "docs": "A challenge to include in the proof. SHOULD be provided by the requesting party of the credential (=holder)", @@ -3697,6 +3832,7 @@ }, "LedgerConfigInstance": { "docs": undefined, + "inline": undefined, "properties": { "genesis_file": { "docs": "genesis_file", @@ -3725,6 +3861,7 @@ }, "LedgerConfigList": { "docs": undefined, + "inline": undefined, "properties": { "ledger_config_list": "list", }, @@ -3735,6 +3872,7 @@ "LedgerModulesResult": "map", "LinkedDataProof": { "docs": undefined, + "inline": undefined, "properties": { "challenge": { "docs": "Associates a challenge with a proof, for use with a proofPurpose such as authentication", @@ -3797,6 +3935,7 @@ }, "MediationDeny": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -3819,6 +3958,7 @@ }, "MediationGrant": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -3842,6 +3982,7 @@ }, "MediationList": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "List of mediation records", @@ -3854,6 +3995,7 @@ }, "MediationRecord": { "docs": undefined, + "inline": undefined, "properties": { "connection_id": "string", "created_at": { @@ -3903,6 +4045,7 @@ }, "Menu": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -3935,6 +4078,7 @@ }, "MenuForm": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "Additional descriptive text for menu form", @@ -3959,6 +4103,7 @@ }, "MenuFormParam": { "docs": undefined, + "inline": undefined, "properties": { "default": { "docs": "Default parameter value", @@ -3991,6 +4136,7 @@ }, "MenuJson": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "Introductory text for the menu", @@ -4015,6 +4161,7 @@ }, "MenuOption": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "Additional descriptive text for menu option", @@ -4043,6 +4190,7 @@ "MultitenantModuleResponse": "map", "OobRecord": { "docs": undefined, + "inline": undefined, "properties": { "attach_thread_id": { "docs": "Connection record identifier", @@ -4144,6 +4292,7 @@ }, "PingRequestResponse": { "docs": undefined, + "inline": undefined, "properties": { "thread_id": { "docs": "Thread ID of the ping message", @@ -4156,6 +4305,7 @@ }, "PresentationDefinition": { "docs": undefined, + "inline": undefined, "properties": { "format": { "type": "optional", @@ -4191,6 +4341,7 @@ }, "PresentationProposal": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -4214,6 +4365,7 @@ }, "PresentationRequest": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -4237,6 +4389,7 @@ }, "ProtocolDescriptor": { "docs": undefined, + "inline": undefined, "properties": { "pid": "string", "roles": { @@ -4250,6 +4403,7 @@ }, "PublishRevocations": { "docs": undefined, + "inline": undefined, "properties": { "rrid2crid": { "docs": "Credential revocation ids by revocation registry id", @@ -4262,6 +4416,7 @@ }, "Queries": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -4281,6 +4436,7 @@ }, "Query": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -4301,6 +4457,7 @@ }, "QueryItem": { "docs": undefined, + "inline": undefined, "properties": { "feature-type": { "docs": "feature type", @@ -4330,6 +4487,7 @@ }, "RawEncoded": { "docs": undefined, + "inline": undefined, "properties": { "encoded": { "docs": "Encoded value", @@ -4352,6 +4510,7 @@ }, "ResolutionResult": { "docs": undefined, + "inline": undefined, "properties": { "did_document": { "docs": "DID Document", @@ -4368,6 +4527,7 @@ }, "ResolutionResultDidDocument": { "docs": "DID Document", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4375,6 +4535,7 @@ }, "ResolutionResultMetadata": { "docs": "Resolution metadata", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4382,6 +4543,7 @@ }, "RevRegIssuedResult": { "docs": undefined, + "inline": undefined, "properties": { "result": { "docs": "Number of credentials issued against revocation registry", @@ -4401,6 +4563,7 @@ }, "RevRegResult": { "docs": undefined, + "inline": undefined, "properties": { "result": { "type": "optional", @@ -4412,6 +4575,7 @@ }, "RevRegWalletUpdatedResult": { "docs": undefined, + "inline": undefined, "properties": { "accum_calculated": { "docs": "Calculated accumulator for phantom revocations", @@ -4432,6 +4596,7 @@ }, "RevRegWalletUpdatedResultAccumCalculated": { "docs": "Calculated accumulator for phantom revocations", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4439,6 +4604,7 @@ }, "RevRegWalletUpdatedResultAccumFixed": { "docs": "Applied ledger transaction to fix revocations", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4446,6 +4612,7 @@ }, "RevRegWalletUpdatedResultRevRegDelta": { "docs": "Indy revocation registry delta", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4453,6 +4620,7 @@ }, "RevRegsCreated": { "docs": undefined, + "inline": undefined, "properties": { "rev_reg_ids": { "type": "optional>", @@ -4465,6 +4633,7 @@ "RevocationModuleResponse": "map", "RouteRecord": { "docs": undefined, + "inline": undefined, "properties": { "connection_id": { "type": "optional", @@ -4510,6 +4679,7 @@ }, "Schema": { "docs": undefined, + "inline": undefined, "properties": { "attrNames": { "docs": "Schema attribute names", @@ -4567,6 +4737,7 @@ }, "SchemaGetResult": { "docs": undefined, + "inline": undefined, "properties": { "schema": { "type": "optional", @@ -4578,6 +4749,7 @@ }, "SchemaInputDescriptor": { "docs": undefined, + "inline": undefined, "properties": { "required": { "docs": "Required", @@ -4594,6 +4766,7 @@ }, "SchemaSendResult": { "docs": undefined, + "inline": undefined, "properties": { "schema": { "type": "optional", @@ -4619,6 +4792,7 @@ }, "SchemasCreatedResult": { "docs": undefined, + "inline": undefined, "properties": { "schema_ids": { "type": "optional>", @@ -4630,6 +4804,7 @@ }, "SchemasInputDescriptorFilter": { "docs": undefined, + "inline": undefined, "properties": { "oneof_filter": { "docs": "oneOf", @@ -4649,6 +4824,7 @@ }, "ServiceDecorator": { "docs": undefined, + "inline": undefined, "properties": { "recipientKeys": { "docs": "List of recipient keys", @@ -4669,6 +4845,7 @@ }, "SignResponse": { "docs": undefined, + "inline": undefined, "properties": { "error": { "docs": "Error text", @@ -4685,6 +4862,7 @@ }, "SignResponseSignedDoc": { "docs": "Signed document", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4692,6 +4870,7 @@ }, "SignatureOptions": { "docs": undefined, + "inline": undefined, "properties": { "challenge": { "type": "optional", @@ -4711,6 +4890,7 @@ }, "SignedDoc": { "docs": undefined, + "inline": undefined, "properties": { "proof": "SignedDocProof", }, @@ -4724,6 +4904,7 @@ }, "SubmissionRequirements": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "Count Value", @@ -4763,6 +4944,7 @@ }, "TAAAcceptance": { "docs": undefined, + "inline": undefined, "properties": { "mechanism": { "type": "optional", @@ -4784,6 +4966,7 @@ }, "TAAInfo": { "docs": undefined, + "inline": undefined, "properties": { "aml_record": { "type": "optional", @@ -4804,6 +4987,7 @@ }, "TAARecord": { "docs": undefined, + "inline": undefined, "properties": { "digest": { "type": "optional", @@ -4821,6 +5005,7 @@ }, "TAAResult": { "docs": undefined, + "inline": undefined, "properties": { "result": { "type": "optional", @@ -4832,6 +5017,7 @@ }, "TailsDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "message": { "type": "optional", @@ -4843,6 +5029,7 @@ }, "TransactionJobs": { "docs": undefined, + "inline": undefined, "properties": { "transaction_my_job": { "docs": "My transaction related job", @@ -4881,6 +5068,7 @@ }, "TransactionList": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "List of transaction records", @@ -4893,6 +5081,7 @@ }, "TransactionRecord": { "docs": undefined, + "inline": undefined, "properties": { "_type": { "docs": "Transaction type", @@ -4967,6 +5156,7 @@ }, "TransactionRecordMessagesAttachItem": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4974,6 +5164,7 @@ }, "TransactionRecordMetaData": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4981,6 +5172,7 @@ }, "TransactionRecordSignatureRequestItem": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4988,6 +5180,7 @@ }, "TransactionRecordSignatureResponseItem": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4995,6 +5188,7 @@ }, "TransactionRecordTiming": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -5002,6 +5196,7 @@ }, "TxnOrCredentialDefinitionSendResult": { "docs": undefined, + "inline": undefined, "properties": { "sent": { "type": "optional", @@ -5020,6 +5215,7 @@ }, "TxnOrPublishRevocationsResult": { "docs": undefined, + "inline": undefined, "properties": { "sent": { "type": "optional", @@ -5038,6 +5234,7 @@ }, "TxnOrRegisterLedgerNymResponse": { "docs": undefined, + "inline": undefined, "properties": { "success": { "docs": "Success of nym registration operation", @@ -5057,6 +5254,7 @@ }, "TxnOrRevRegResult": { "docs": undefined, + "inline": undefined, "properties": { "sent": { "type": "optional", @@ -5075,6 +5273,7 @@ }, "TxnOrSchemaSendResult": { "docs": undefined, + "inline": undefined, "properties": { "sent": { "type": "optional", @@ -5101,6 +5300,7 @@ }, "V10CredentialExchange": { "docs": undefined, + "inline": undefined, "properties": { "auto_issue": { "docs": "Issuer choice to issue to request in this credential exchange", @@ -5251,6 +5451,7 @@ }, "V10CredentialExchangeCredentialRequestMetadata": { "docs": "(Indy) credential request metadata", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -5268,6 +5469,7 @@ }, "V10CredentialExchangeListResult": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "Aries#0036 v1.0 credential exchange records", @@ -5294,6 +5496,7 @@ }, "V10DiscoveryExchangeListResult": { "docs": undefined, + "inline": undefined, "properties": { "results": { "type": "optional>", @@ -5309,6 +5512,7 @@ }, "V10DiscoveryRecord": { "docs": undefined, + "inline": undefined, "properties": { "connection_id": { "docs": "Connection identifier", @@ -5372,6 +5576,7 @@ "V10PresentProofModuleResponse": "map", "V10PresentationExchange": { "docs": undefined, + "inline": undefined, "properties": { "auto_present": { "docs": "Prover choice to auto-present proof as verifier requests", @@ -5469,6 +5674,7 @@ }, "V10PresentationExchangeList": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "Aries RFC 37 v1.0 presentation exchange records", @@ -5517,6 +5723,7 @@ }, "V20CredAttrSpec": { "docs": undefined, + "inline": undefined, "properties": { "mime-type": { "docs": "MIME type: omit for (null) default", @@ -5545,6 +5752,7 @@ }, "V20CredExFree": { "docs": undefined, + "inline": undefined, "properties": { "auto_remove": { "docs": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", @@ -5583,6 +5791,7 @@ }, "V20CredExRecord": { "docs": undefined, + "inline": undefined, "properties": { "auto_issue": { "docs": "Issuer choice to issue to request in this credential exchange", @@ -5677,6 +5886,7 @@ }, "V20CredExRecordByFormat": { "docs": undefined, + "inline": undefined, "properties": { "cred_issue": { "type": "optional", @@ -5697,6 +5907,7 @@ }, "V20CredExRecordByFormatCredIssue": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -5704,6 +5915,7 @@ }, "V20CredExRecordByFormatCredOffer": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -5711,6 +5923,7 @@ }, "V20CredExRecordByFormatCredProposal": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -5718,6 +5931,7 @@ }, "V20CredExRecordByFormatCredRequest": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -5745,6 +5959,7 @@ }, "V20CredExRecordDetail": { "docs": undefined, + "inline": undefined, "properties": { "cred_ex_record": { "type": "optional", @@ -5766,6 +5981,7 @@ }, "V20CredExRecordIndy": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Time of record creation", @@ -5834,6 +6050,7 @@ }, "V20CredExRecordIndyCredRequestMetadata": { "docs": "Credential request metadata for indy holder", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -5851,6 +6068,7 @@ }, "V20CredExRecordLdProof": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Time of record creation", @@ -5895,6 +6113,7 @@ }, "V20CredExRecordListResult": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "Credential exchange records and corresponding detail records", @@ -5964,6 +6183,7 @@ }, "V20CredFilter": { "docs": undefined, + "inline": undefined, "properties": { "indy": { "type": "optional", @@ -5978,6 +6198,7 @@ }, "V20CredFilterIndy": { "docs": undefined, + "inline": undefined, "properties": { "cred_def_id": { "docs": "Credential definition identifier", @@ -6044,6 +6265,7 @@ }, "V20CredFormat": { "docs": undefined, + "inline": undefined, "properties": { "attach_id": { "docs": "Attachment identifier", @@ -6060,6 +6282,7 @@ }, "V20CredIssue": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -6092,6 +6315,7 @@ }, "V20CredOffer": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -6127,6 +6351,7 @@ }, "V20CredPreview": { "docs": undefined, + "inline": undefined, "properties": { "@type": { "docs": "Message type identifier", @@ -6140,6 +6365,7 @@ }, "V20CredProposal": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -6175,6 +6401,7 @@ }, "V20CredRequest": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -6207,6 +6434,7 @@ }, "V20DiscoveryExchangeListResult": { "docs": undefined, + "inline": undefined, "properties": { "results": { "type": "optional>", @@ -6222,6 +6450,7 @@ }, "V20DiscoveryExchangeResult": { "docs": undefined, + "inline": undefined, "properties": { "results": { "type": "optional", @@ -6233,6 +6462,7 @@ }, "V20DiscoveryRecord": { "docs": undefined, + "inline": undefined, "properties": { "connection_id": { "docs": "Connection identifier", @@ -6296,6 +6526,7 @@ "V20IssueCredentialModuleResponse": "map", "V20Pres": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -6323,6 +6554,7 @@ }, "V20PresExRecord": { "docs": undefined, + "inline": undefined, "properties": { "auto_present": { "docs": "Prover choice to auto-present proof as verifier requests", @@ -6410,6 +6642,7 @@ }, "V20PresExRecordByFormat": { "docs": undefined, + "inline": undefined, "properties": { "pres": { "type": "optional", @@ -6427,6 +6660,7 @@ }, "V20PresExRecordByFormatPresProposal": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -6434,6 +6668,7 @@ }, "V20PresExRecordByFormatPresRequest": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -6451,6 +6686,7 @@ }, "V20PresExRecordList": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "Presentation exchange records", @@ -6530,6 +6766,7 @@ }, "V20PresFormat": { "docs": undefined, + "inline": undefined, "properties": { "attach_id": { "docs": "Attachment identifier", @@ -6546,6 +6783,7 @@ }, "V20PresProposal": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -6573,6 +6811,7 @@ }, "V20PresProposalByFormat": { "docs": undefined, + "inline": undefined, "properties": { "dif": { "type": "optional", @@ -6595,6 +6834,7 @@ }, "V20PresRequest": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -6626,6 +6866,7 @@ }, "V20PresRequestByFormat": { "docs": undefined, + "inline": undefined, "properties": { "dif": { "type": "optional", @@ -6657,6 +6898,7 @@ "V20PresentProofModuleResponse": "map", "VCRecord": { "docs": undefined, + "inline": undefined, "properties": { "contexts": { "type": "optional>", @@ -6699,6 +6941,7 @@ }, "VCRecordList": { "docs": undefined, + "inline": undefined, "properties": { "results": { "type": "optional>", @@ -6710,6 +6953,7 @@ }, "VcRecordCredValue": { "docs": "(JSON-serializable) credential value", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -6721,6 +6965,7 @@ }, "VerifyResponse": { "docs": undefined, + "inline": undefined, "properties": { "error": { "docs": "Error text", @@ -6734,6 +6979,7 @@ }, "WalletList": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "List of wallet records", @@ -6747,6 +6993,7 @@ "WalletModuleResponse": "map", "WalletRecord": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Time of record creation", @@ -6801,6 +7048,7 @@ }, "WalletRecordSettings": { "docs": "Settings for this wallet.", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -6808,6 +7056,7 @@ }, "WriteLedgerRequest": { "docs": undefined, + "inline": undefined, "properties": { "ledger_id": { "type": "optional", @@ -6839,6 +7088,7 @@ }, "jwt": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -6846,6 +7096,7 @@ }, "ldp": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -6853,6 +7104,7 @@ }, "metadata": { "docs": "Metadata dictionary", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -6870,6 +7122,7 @@ }, "pres": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -6887,6 +7140,7 @@ }, "signature": { "docs": "Credential signature", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -6894,6 +7148,7 @@ }, "witness": { "docs": "Witness for revocation proof", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -6978,6 +7233,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true AdminConfig: properties: config: @@ -6999,11 +7255,13 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true AdminStatusTiming: docs: Timing results properties: {} source: openapi: ../openapi.yml + inline: true AdminStatus: properties: conductor: @@ -7159,26 +7417,32 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true ClaimFormatJwtVc: properties: {} source: openapi: ../openapi.yml + inline: true ClaimFormatJwtVp: properties: {} source: openapi: ../openapi.yml + inline: true ldp: properties: {} source: openapi: ../openapi.yml + inline: true ClaimFormatLdpVc: properties: {} source: openapi: ../openapi.yml + inline: true ClaimFormatLdpVp: properties: {} source: openapi: ../openapi.yml + inline: true ClaimFormat: properties: jwt: @@ -7361,6 +7625,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true ConnectionMetadata: properties: results: @@ -7465,6 +7730,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true CreateWalletResponse: properties: created_at: @@ -7585,6 +7851,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true CredRevIndyRecordsResult: properties: rev_reg_delta: @@ -7929,6 +8196,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true DifPresSpecRevealDoc: docs: >- reveal doc [JSON-LD frame] dict used to derive the credential when @@ -7936,6 +8204,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true DIFPresSpec: properties: issuer_id: @@ -8004,6 +8273,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true Doc: properties: credential: @@ -8214,11 +8484,13 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true IndyCredRequestBlindedMsCorrectnessProof: docs: Blinded master secret correctness proof properties: {} source: openapi: ../openapi.yml + inline: true IndyCredRequest: properties: blinded_ms: @@ -8251,21 +8523,25 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true signature: docs: Credential signature properties: {} source: openapi: ../openapi.yml + inline: true IndyCredentialSignatureCorrectnessProof: docs: Credential signature correctness proof properties: {} source: openapi: ../openapi.yml + inline: true witness: docs: Witness for revocation proof properties: {} source: openapi: ../openapi.yml + inline: true IndyCredential: properties: cred_def_id: @@ -8690,11 +8966,13 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true IndyProofRequestedProofUnrevealedAttrs: docs: Unrevealed attributes properties: {} source: openapi: ../openapi.yml + inline: true IndyProofRequestedProof: properties: predicates: @@ -8871,6 +9149,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true InputDescriptors: properties: constraints: @@ -9105,6 +9384,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true KeylistQuery: properties: '@id': @@ -9642,11 +9922,13 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true ResolutionResultMetadata: docs: Resolution metadata properties: {} source: openapi: ../openapi.yml + inline: true ResolutionResult: properties: did_document: @@ -9677,16 +9959,19 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true RevRegWalletUpdatedResultAccumFixed: docs: Applied ledger transaction to fix revocations properties: {} source: openapi: ../openapi.yml + inline: true RevRegWalletUpdatedResultRevRegDelta: docs: Indy revocation registry delta properties: {} source: openapi: ../openapi.yml + inline: true RevRegWalletUpdatedResult: properties: accum_calculated: @@ -9829,6 +10114,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true SignResponse: properties: error: @@ -9971,22 +10257,27 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true TransactionRecordMetaData: properties: {} source: openapi: ../openapi.yml + inline: true TransactionRecordSignatureRequestItem: properties: {} source: openapi: ../openapi.yml + inline: true TransactionRecordSignatureResponseItem: properties: {} source: openapi: ../openapi.yml + inline: true TransactionRecordTiming: properties: {} source: openapi: ../openapi.yml + inline: true TransactionRecord: properties: _type: @@ -10084,6 +10375,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true V10CredentialExchangeInitiator: enum: - self @@ -10477,18 +10769,22 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true V20CredExRecordByFormatCredOffer: properties: {} source: openapi: ../openapi.yml + inline: true V20CredExRecordByFormatCredProposal: properties: {} source: openapi: ../openapi.yml + inline: true V20CredExRecordByFormatCredRequest: properties: {} source: openapi: ../openapi.yml + inline: true V20CredExRecordByFormat: properties: cred_issue: @@ -10516,6 +10812,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true V20CredExRecordIndy: properties: created_at: @@ -10922,14 +11219,17 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true V20PresExRecordByFormatPresProposal: properties: {} source: openapi: ../openapi.yml + inline: true V20PresExRecordByFormatPresRequest: properties: {} source: openapi: ../openapi.yml + inline: true V20PresExRecordByFormat: properties: pres: @@ -11018,6 +11318,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true VCRecord: properties: contexts: @@ -11080,6 +11381,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true WalletRecord: properties: created_at: @@ -12737,6 +13039,7 @@ docs: Simple messaging "types": { "ConnectionMetadataSetRequestMetadata": { "docs": "Dictionary of metadata to set for connection.", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -12744,6 +13047,7 @@ docs: Simple messaging }, "CreateInvitationRequestMetadata": { "docs": "Optional metadata to attach to the connection created with the invitation", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -12828,11 +13132,13 @@ docs: Simple messaging properties: {} source: openapi: ../openapi.yml + inline: true ConnectionMetadataSetRequestMetadata: docs: Dictionary of metadata to set for connection. properties: {} source: openapi: ../openapi.yml + inline: true imports: root: __package__.yml service: @@ -29200,6 +29506,7 @@ docs: Interaction with ledger }, "KeylistQueryFilterRequestFilter": { "docs": "Filter for keylist query", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -29741,6 +30048,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true GetMatchingMediationRecordsRequestState: enum: - request @@ -30888,6 +31196,7 @@ docs: Multitenant wallet management "types": { "InvitationCreateRequestMetadata": { "docs": "Optional metadata to attach to the connection created with the invitation", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -30903,6 +31212,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true service: auth: false base-path: '' diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/assembly.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/assembly.json index ceec06cc76d..28cf25bd848 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/assembly.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/assembly.json @@ -1300,6 +1300,7 @@ }, "AutoHighlightResult": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of times the key phrase appears in the audio file", @@ -1326,6 +1327,7 @@ "docs": "An array of results for the Key Phrases model, if it was enabled during the transcription request. See [Key phrases](https://www.assemblyai.com/docs/Models/key_phrases) for more information. ", + "inline": undefined, "properties": { "results": { "docs": "A temporally-sequential array of Key Phrases", @@ -1338,6 +1340,7 @@ See [Key phrases](https://www.assemblyai.com/docs/Models/key_phrases) for more i }, "Chapter": { "docs": "Chapter of the audio file", + "inline": undefined, "properties": { "end": { "docs": "The starting time, in milliseconds, for the chapter", @@ -1366,6 +1369,7 @@ See [Key phrases](https://www.assemblyai.com/docs/Models/key_phrases) for more i }, "ContentSafetyLabel": { "docs": undefined, + "inline": undefined, "properties": { "confidence": { "docs": "The confidence score for the topic being discussed, from 0 to 1", @@ -1400,6 +1404,7 @@ See [Key phrases](https://www.assemblyai.com/docs/Models/key_phrases) for more i }, "ContentSafetyLabelResult": { "docs": undefined, + "inline": undefined, "properties": { "labels": { "docs": "An array of objects, one per sensitive topic that was detected in the section", @@ -1436,6 +1441,7 @@ See [Key phrases](https://www.assemblyai.com/docs/Models/key_phrases) for more i }, "CreateTranscriptOptionalParameters": { "docs": "The parameters for creating a transcript", + "inline": undefined, "properties": { "audio_end_at": { "docs": "The point in time, in milliseconds, to stop transcribing in your media file", @@ -1585,6 +1591,7 @@ Valid values are in the range [0, 1] inclusive. }, "Entity": { "docs": "A detected entity", + "inline": undefined, "properties": { "end": { "docs": "The ending time, in milliseconds, for the detected entity in the audio file", @@ -1736,6 +1743,7 @@ Valid values are in the range [0, 1] inclusive. }, "Error": { "docs": undefined, + "inline": undefined, "properties": { "error": { "docs": "Error message", @@ -1753,6 +1761,7 @@ Valid values are in the range [0, 1] inclusive. "extends": [ "LemurBaseResponse", ], + "inline": undefined, "properties": { "response": { "docs": "The response generated by LeMUR.", @@ -1765,6 +1774,7 @@ Valid values are in the range [0, 1] inclusive. }, "LemurBaseParameters": { "docs": undefined, + "inline": undefined, "properties": { "context": { "docs": "Context to provide the model. This can be a string or a free-form JSON value.", @@ -1795,6 +1805,7 @@ Can be any value between 0.0 and 1.0 inclusive. "discriminated": false, "docs": "Context to provide the model. This can be a string or a free-form JSON value.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1805,6 +1816,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "LemurBaseResponse": { "docs": undefined, + "inline": undefined, "properties": { "request_id": { "docs": "The ID of the LeMUR request", @@ -1828,6 +1840,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "LemurQuestion": { "docs": undefined, + "inline": undefined, "properties": { "answer_format": { "docs": "How you want the answer to be returned. This can be any text. Can't be used with answer_options. Examples: "short sentence", "bullet points" @@ -1854,6 +1867,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "LemurQuestionAnswer": { "docs": "An answer generated by LeMUR and its question.", + "inline": undefined, "properties": { "answer": { "docs": "The answer generated by LeMUR.", @@ -1873,6 +1887,7 @@ Can be any value between 0.0 and 1.0 inclusive. "extends": [ "LemurBaseResponse", ], + "inline": undefined, "properties": { "response": { "docs": "The answers generated by LeMUR and their questions.", @@ -1887,6 +1902,7 @@ Can be any value between 0.0 and 1.0 inclusive. "discriminated": false, "docs": "Any context about the transcripts you wish to provide. This can be a string, or free-form JSON.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1900,6 +1916,7 @@ Can be any value between 0.0 and 1.0 inclusive. "extends": [ "LemurBaseResponse", ], + "inline": undefined, "properties": { "response": { "docs": "The response generated by LeMUR.", @@ -1915,6 +1932,7 @@ Can be any value between 0.0 and 1.0 inclusive. "extends": [ "LemurBaseResponse", ], + "inline": undefined, "properties": { "response": { "docs": "The response generated by LeMUR.", @@ -1927,6 +1945,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "PageDetails": { "docs": undefined, + "inline": undefined, "properties": { "current_url": "string", "limit": "integer", @@ -1940,6 +1959,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "ParagraphsResponse": { "docs": undefined, + "inline": undefined, "properties": { "audio_duration": "double", "confidence": { @@ -1995,6 +2015,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "PurgeLemurRequestDataResponse": { "docs": undefined, + "inline": undefined, "properties": { "deleted": { "docs": "Whether the request data was deleted.", @@ -2015,6 +2036,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "RealtimeTemporaryTokenResponse": { "docs": undefined, + "inline": undefined, "properties": { "token": { "docs": "The temporary authentication token for real-time transcription", @@ -2027,6 +2049,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "RedactedAudioResponse": { "docs": undefined, + "inline": undefined, "properties": { "redacted_audio_url": { "docs": "The URL of the redacted audio file", @@ -2047,6 +2070,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "SentencesResponse": { "docs": undefined, + "inline": undefined, "properties": { "audio_duration": "double", "confidence": { @@ -2078,6 +2102,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "SentimentAnalysisResult": { "docs": "The result of the sentiment analysis model.", + "inline": undefined, "properties": { "confidence": { "docs": "The confidence score for the detected sentiment of the sentence, from 0 to 1", @@ -2117,6 +2142,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "SeverityScoreSummary": { "docs": undefined, + "inline": undefined, "properties": { "high": { "type": "double", @@ -2201,6 +2227,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "Timestamp": { "docs": "Timestamp containing a start and end property in milliseconds.", + "inline": undefined, "properties": { "end": { "docs": "The end time in milliseconds", @@ -2217,6 +2244,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "TopicDetectionResult": { "docs": "THe result of the topic detection model.", + "inline": undefined, "properties": { "labels": "optional>", "text": { @@ -2231,6 +2259,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "TopicDetectionResultLabelsItem": { "docs": undefined, + "inline": true, "properties": { "label": { "docs": "The IAB taxonomical label for the label of the detected topic, where > denotes supertopic/subtopic relationship", @@ -2254,6 +2283,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "Transcript": { "docs": "A transcript object", + "inline": undefined, "properties": { "acoustic_model": { "availability": "deprecated", @@ -2532,6 +2562,7 @@ See [Speech recognition](https://www.assemblyai.com/docs/Models/speech_recogniti "docs": "An array of results for the Content Moderation model, if it was enabled during the transcription request. See [Content moderation](https://www.assemblyai.com/docs/Models/content_moderation) for more information. ", + "inline": true, "properties": { "results": "list", "status": { @@ -2545,6 +2576,7 @@ See [Content moderation](https://www.assemblyai.com/docs/Models/content_moderati }, "TranscriptCustomSpelling": { "docs": "Object containing words or phrases to replace, and the word or phrase to replace with", + "inline": undefined, "properties": { "from": { "docs": "Words or phrases to replace", @@ -2563,6 +2595,7 @@ See [Content moderation](https://www.assemblyai.com/docs/Models/content_moderati "docs": "An array of results for the Topic Detection model, if it was enabled during the transcription request. See [Topic Detection](https://www.assemblyai.com/docs/Models/iab_classification) for more information. ", + "inline": true, "properties": { "results": { "docs": "An array of results for the Topic Detection model.", @@ -2614,6 +2647,7 @@ The default value is 'en_us'. }, "TranscriptList": { "docs": undefined, + "inline": undefined, "properties": { "page_details": "PageDetails", "transcripts": "list", @@ -2624,6 +2658,7 @@ The default value is 'en_us'. }, "TranscriptListItem": { "docs": undefined, + "inline": undefined, "properties": { "audio_url": "string", "completed": "optional", @@ -2638,6 +2673,7 @@ The default value is 'en_us'. }, "TranscriptListParameters": { "docs": undefined, + "inline": undefined, "properties": { "after_id": { "docs": "Get transcripts that were created after this transcript ID", @@ -2677,6 +2713,7 @@ The default value is 'en_us'. }, "TranscriptParagraph": { "docs": undefined, + "inline": undefined, "properties": { "confidence": { "type": "double", @@ -2699,6 +2736,7 @@ The default value is 'en_us'. }, "TranscriptSentence": { "docs": undefined, + "inline": undefined, "properties": { "confidence": { "type": "double", @@ -2745,6 +2783,7 @@ The default value is 'en_us'. }, "TranscriptUtterance": { "docs": undefined, + "inline": undefined, "properties": { "channel": "string", "confidence": { @@ -2768,6 +2807,7 @@ The default value is 'en_us'. }, "TranscriptWord": { "docs": undefined, + "inline": undefined, "properties": { "confidence": { "type": "double", @@ -2790,6 +2830,7 @@ The default value is 'en_us'. }, "UploadedFile": { "docs": undefined, + "inline": undefined, "properties": { "upload_url": { "docs": "A URL that points to your audio file, accessible only by AssemblyAI's servers", @@ -2802,6 +2843,7 @@ The default value is 'en_us'. }, "WordSearchMatch": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total amount of times the word is in the transcript", @@ -2826,6 +2868,7 @@ The default value is 'en_us'. }, "WordSearchResponse": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the transcript", @@ -3952,6 +3995,7 @@ types: results: list source: openapi: ../openapi.yml + inline: true TranscriptIabCategoriesResult: docs: > An array of results for the Topic Detection model, if it was enabled @@ -3974,6 +4018,7 @@ types: docs: The overall relevance of topic to the entire audio file source: openapi: ../openapi.yml + inline: true Transcript: docs: A transcript object properties: @@ -4482,6 +4527,7 @@ types: denotes supertopic/subtopic relationship source: openapi: ../openapi.yml + inline: true TopicDetectionResult: docs: THe result of the topic detection model. properties: @@ -4807,6 +4853,7 @@ types: - map source: openapi: ../openapi.yml + inline: true LemurBaseParameters: properties: transcript_ids: @@ -4844,6 +4891,7 @@ types: - map source: openapi: ../openapi.yml + inline: true LemurQuestion: properties: question: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/availability.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/availability.json index c64a46f497d..e7f1fccca1e 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/availability.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/availability.json @@ -261,6 +261,7 @@ "DeprecatedParam": "string", "NotDeprecatedSettings": { "docs": undefined, + "inline": undefined, "properties": { "not_deprecated_setting": "optional", }, @@ -271,6 +272,7 @@ "WholeDeprecatedSettings": { "availability": "deprecated", "docs": undefined, + "inline": undefined, "properties": { "fine_setting": "optional", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/axle.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/axle.json index e30fe4b42d1..c894a317c7d 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/axle.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/axle.json @@ -8,6 +8,7 @@ "types": { "Address": { "docs": undefined, + "inline": undefined, "properties": { "addressLine1": { "type": "optional", @@ -34,6 +35,7 @@ }, "Carrier": { "docs": undefined, + "inline": undefined, "properties": { "address": { "type": "Address", @@ -53,6 +55,7 @@ }, "Coverage": { "docs": undefined, + "inline": undefined, "properties": { "code": "CoverageCode", "deductible": { @@ -90,6 +93,7 @@ }, "Error": { "docs": undefined, + "inline": undefined, "properties": { "message": { "docs": "Provides a reason for why the operation failed, if available.", @@ -105,6 +109,7 @@ }, "Insured": { "docs": undefined, + "inline": undefined, "properties": { "dateOfBirth": { "type": "optional", @@ -136,6 +141,7 @@ }, "Property": { "docs": undefined, + "inline": undefined, "properties": { "data": { "type": "Vehicle", @@ -153,6 +159,7 @@ }, "ThirdParty": { "docs": undefined, + "inline": undefined, "properties": { "address": { "type": "optional
", @@ -183,6 +190,7 @@ }, "User": { "docs": "User to attach to Ignition session. If user is set, unique `id` must be provided.", + "inline": undefined, "properties": { "email": { "docs": "User's email address.", @@ -211,6 +219,7 @@ }, "Vehicle": { "docs": undefined, + "inline": undefined, "properties": { "bodyStyle": { "type": "optional", @@ -451,6 +460,7 @@ "types": { "Account": { "docs": "An Account represents an account with an insurance carrier and includes high-level account information (e.g. name) and any Policy objects associated with the Account.", + "inline": undefined, "properties": { "carrier": "string", "createdAt": "string", @@ -473,6 +483,7 @@ }, "GetAccountResponse": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional", "success": "optional", @@ -483,6 +494,7 @@ }, "Policy": { "docs": "A Policy represents a specific policy associated with an Account and includes high-level policy information (e.g. policy number) and any children objects (e.g., coverages) associated with the policy.", + "inline": undefined, "properties": { "account": "string", "address": { @@ -758,6 +770,7 @@ service: "types": { "GetCarrierResponse": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional", "success": "optional", @@ -768,6 +781,7 @@ service: }, "GetCarriersResponse": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional>", "success": "optional", @@ -940,6 +954,7 @@ service: "types": { "StartIgnitionResponse": { "docs": "", + "inline": undefined, "properties": { "data": "StartIgnitionResponseData", "success": { @@ -952,6 +967,7 @@ service: }, "StartIgnitionResponseData": { "docs": undefined, + "inline": true, "properties": { "ignitionToken": { "docs": "The unique ID for the ignition session.", @@ -981,6 +997,7 @@ types: docs: The unique ID for the ignition session. source: openapi: ../openapi.yml + inline: true StartIgnitionResponse: docs: '' properties: @@ -1170,6 +1187,7 @@ service: "types": { "GetPolicyResponse": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional", "success": "optional", @@ -1355,6 +1373,7 @@ Auth codes are ephemeral and expire after 10 minutes, while accessTokens do not "types": { "ExchangeTokenResponse": { "docs": "", + "inline": undefined, "properties": { "data": "ExchangeTokenResponseData", "success": { @@ -1367,6 +1386,7 @@ Auth codes are ephemeral and expire after 10 minutes, while accessTokens do not }, "ExchangeTokenResponseData": { "docs": undefined, + "inline": true, "properties": { "accessToken": { "docs": "The token required for access to the requested Account and Policy objects.", @@ -1408,6 +1428,7 @@ types: type: list source: openapi: ../openapi.yml + inline: true ExchangeTokenResponse: docs: '' properties: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/belvo.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/belvo.json index e73e25ef8e9..9da54d6be79 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/belvo.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/belvo.json @@ -5158,6 +5158,7 @@ "types": { "AccessToResourceDenied": { "docs": "This error occurs when you try to access Belvo's resource without the correct permissions.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`access_to_resource_denied`) that allows you to classify and handle the error programmatically. @@ -5193,6 +5194,7 @@ For `access_to_resource_denied` errors, the description is: **Note**: For our recurring expenses resource, this account relates to the account that was analyzed to generate the recurring expenses report. ", + "inline": undefined, "properties": { "balance": "AccountsBalance", "balance_type": { @@ -5295,6 +5297,7 @@ For example: `0444/45722-0`. "AccountsBalance": { "docs": "Details regarding the current and available balances for the account. ", + "inline": undefined, "properties": { "available": { "docs": "The balance that the account owner can use. @@ -5332,6 +5335,7 @@ The amount remaining to pay on the users's loan (same as `loan_data.outstanding_ }, "AccountsCreditData": { "docs": "The credit options associated with this account.", + "inline": undefined, "properties": { "collected_at": { "docs": "The ISO-8601 timestamp when the data point was collected.", @@ -5391,6 +5395,7 @@ The amount remaining to pay on the users's loan (same as `loan_data.outstanding_ }, "AccountsFundsData": { "docs": undefined, + "inline": undefined, "properties": { "balance": { "docs": "The amount in the fund.", @@ -5423,6 +5428,7 @@ The amount remaining to pay on the users's loan (same as `loan_data.outstanding_ }, "AccountsFundsDataPublicIdentifications": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "The type of identification number for the fund.", @@ -5439,6 +5445,7 @@ The amount remaining to pay on the users's loan (same as `loan_data.outstanding_ }, "AccountsLoanData": { "docs": "The loan options associated with this account.", + "inline": undefined, "properties": { "collected_at": { "docs": "The ISO-8601 timestamp when the data point was collected.", @@ -5584,6 +5591,7 @@ The minimum amount required to pay to avoid generating interest. }, "AccountsLoanDataFees": { "docs": "Breakdown of the fees applied to the loan.", + "inline": undefined, "properties": { "type": "EnumLoanDataFeeType", "value": { @@ -5598,6 +5606,7 @@ The minimum amount required to pay to avoid generating interest. }, "AccountsLoanDataInterestRate": { "docs": "Breakdown of the interest applied to the loan.", + "inline": undefined, "properties": { "name": { "docs": "The name of the type of interest rate applied to the loan.", @@ -5615,6 +5624,7 @@ The minimum amount required to pay to avoid generating interest. }, "AccountsPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -5642,6 +5652,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "AccountsReceivablesData": { "docs": "Additional details regarding the receivables account, if applicable.", + "inline": undefined, "properties": { "anticipated": { "docs": "The amount that the owner of the account received earlier than contracted.", @@ -5666,6 +5677,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "AnnualCostsAndDeductionsStatementBusiness": { "docs": "Object containing the reported annual costs and applicable deductions.", + "inline": undefined, "properties": { "administration_expenses": { "docs": "Total costs of the company related to training, company offsites, or similar.", @@ -5694,6 +5706,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "AnnualIncomeStatementBusiness": { "docs": "Object containing the reported annual incomes, deductions, and final balances of the tax payer.", + "inline": undefined, "properties": { "dividends": { "docs": "Total income that the company generated from dividends.", @@ -5726,6 +5739,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "AnnualIncomeStatementIndividual": { "docs": "Object containing the reported annual incomes, deductions, and final balances of the tax payer.", + "inline": undefined, "properties": { "annual_totals": "AnnualTotalsIndividual", "gross_income": "GrossIncomeIndividual", @@ -5738,6 +5752,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "AnnualTotalsIndividual": { "docs": "Object containing the tax payers total exempt, deducted, and ordinary net incomes.", + "inline": undefined, "properties": { "total_applicable_deductions": { "docs": "Total deductions that the taxpayer can apply to their income, according to the institution.", @@ -5762,6 +5777,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "AsynchronousAccepted202": { "docs": undefined, + "inline": undefined, "properties": { "request_id": { "docs": "The unique ID for this request. We recommend you store this value to later identify which webhook event relates to an asynchronous request.", @@ -5774,6 +5790,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "BUSINESS": { "docs": "Details about the OFPI payment method.", + "inline": undefined, "properties": { "open_finance": "PaymentIntentPaymentMethodDetailsBodyBusinessOfpi", }, @@ -5785,6 +5802,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -5826,6 +5844,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "Balance": { "docs": undefined, + "inline": undefined, "properties": { "account": "optional", "balance": { @@ -5881,6 +5900,7 @@ The ISO-8601 timestamp when the data point was collected. }, "BalancesPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -5908,6 +5928,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "BankAccountBusinessPse": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "The ISO-8601 timestamp of when the data point was first created in Belvo's database.", @@ -5980,6 +6001,7 @@ For `BUSINESS` bank accounts that Belvo creates for organizations, this field is }, "BankAccountDetailsOfpi": { "docs": undefined, + "inline": undefined, "properties": { "account_type": "EnumBankAccountPixAccountTypeOfpi", "agency": { @@ -5998,6 +6020,7 @@ For `BUSINESS` bank accounts that Belvo creates for organizations, this field is }, "BankAccountDetailsOfpiPix": { "docs": undefined, + "inline": undefined, "properties": { "country": "EnumPaymentsCountry", "pix_key": { @@ -6011,6 +6034,7 @@ For `BUSINESS` bank accounts that Belvo creates for organizations, this field is }, "BankAccountDetailsOpenFinance": { "docs": undefined, + "inline": undefined, "properties": { "account_type": "EnumBankAccountPixAccountTypeOfpi", "agency": { @@ -6029,6 +6053,7 @@ For `BUSINESS` bank accounts that Belvo creates for organizations, this field is }, "BankAccountDetailsOpenFinancePix": { "docs": undefined, + "inline": undefined, "properties": { "country": "EnumPaymentsCountry", "pix_key": { @@ -6044,6 +6069,7 @@ For `BUSINESS` bank accounts that Belvo creates for organizations, this field is "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -6058,6 +6084,7 @@ For `BUSINESS` bank accounts that Belvo creates for organizations, this field is }, "BankAccountInformationContentPse": { "docs": "Information about the payer's institution", + "inline": undefined, "properties": { "payer_institution": { "docs": "Belvo's unique identifier for the payer’s institution.", @@ -6076,6 +6103,7 @@ For `BUSINESS` bank accounts that Belvo creates for organizations, this field is }, "BankAccountInformationPse": { "docs": "Information about the payer's bank account. Belvo returns this object when the payer's bank account information is not saved in the Belvo database.", + "inline": undefined, "properties": { "bank_account_information": { "type": "optional", @@ -6087,6 +6115,7 @@ For `BUSINESS` bank accounts that Belvo creates for organizations, this field is }, "BankAccountOfpiResponse": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database.", @@ -6147,6 +6176,7 @@ For `BUSINESS` bank accounts that Belvo creates for organizations, this field is "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -6161,6 +6191,7 @@ For `BUSINESS` bank accounts that Belvo creates for organizations, this field is }, "BankAccountPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -6190,6 +6221,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -6205,6 +6237,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "BeneficiaryBankAccountOfpi": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database.", @@ -6246,6 +6279,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -6260,6 +6294,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "BeneficiaryBankAccountPse": { "docs": undefined, + "inline": undefined, "properties": { "holder": { "type": "optional", @@ -6295,6 +6330,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "Business": { "docs": "Details regarding the business bank account holder.", + "inline": undefined, "properties": { "Information": { "type": "optional", @@ -6307,6 +6343,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "Categorization": { "docs": undefined, + "inline": undefined, "properties": { "transactions": { "docs": "An array of enriched transaction objects.", @@ -6319,6 +6356,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "CategorizationBody": { "docs": undefined, + "inline": undefined, "properties": { "account_category": "EnumCategorizationAccountCategory", "account_holder_id": { @@ -6380,6 +6418,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "CategorizationBodyRequest": { "docs": undefined, + "inline": undefined, "properties": { "account_category": "EnumCategorizationAccountCategory", "account_holder_id": { @@ -6436,6 +6475,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "CategorizationMerchantData": { "docs": "Additional data regarding the merchant involved in the transaction. ", + "inline": undefined, "properties": { "logo": { "docs": "The URL to the merchant's logo.", @@ -6456,6 +6496,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "Charge": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "The amount of the charge. @@ -6567,6 +6608,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -6581,6 +6623,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "ChargePaymentMethodDetailsOfpiContent": { "docs": "Information about the payer of a PSE payment.", + "inline": undefined, "properties": { "beneficiary_bank_account": { "docs": "Belvo's unique ID used to identify the beneficiary's bank account.", @@ -6609,6 +6652,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "ChargePaymentMethodDetailsPseContent": { "docs": "Information about the payer of a PSE payment.", + "inline": undefined, "properties": { "payer_bank_account": { "docs": "Belvo's unique ID used to identify the customer’s bank account.", @@ -6649,6 +6693,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "CreateBankAccountOfpi": { "docs": undefined, + "inline": undefined, "properties": { "details": { "docs": "Information regarding the bank account.", @@ -6677,6 +6722,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "discriminated": false, "docs": "Information regarding the bank account.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -6691,6 +6737,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "CreateBankAccountPse": { "docs": undefined, + "inline": undefined, "properties": { "holder": { "docs": "Information regarding the business bank account holder.", @@ -6718,6 +6765,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "CreateCustomerOfpi": { "docs": undefined, + "inline": undefined, "properties": { "address": { "docs": "The customer's physical address. @@ -6766,6 +6814,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "CreateCustomerPse": { "docs": undefined, + "inline": undefined, "properties": { "address": { "docs": "The customer's physical address. @@ -6814,6 +6863,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "CreatePaymentLinkOfpi": { "docs": undefined, + "inline": undefined, "properties": { "allowed_payment_method_types": { "docs": "A list of payment method types allowed in this payment intent. For OFPI, this value must be set to `open_finance`.", @@ -6872,6 +6922,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro **Note:** You can send through this value either as a string or an float. Regardless of the type you choose to send the `amount` as, Belvo returns a string with two decimal points, separated by a period ( `.`). For example, `1234.12`. ", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -6890,6 +6941,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "CreatePaymentLinkPse": { "docs": undefined, + "inline": undefined, "properties": { "allowed_payment_method_types": { "docs": "A list of payment method types allowed in this payment intent. For PSE, this value must be set to `pse`.", @@ -6948,6 +7000,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro **Note:** You can send this value either as a string or an integer. Regardless of the type you choose to send the `amount` as, Belvo returns a string with two decimal points, separated by a period ( `.`). For example, `350000.00`. ", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -6966,6 +7019,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "CustomerOfpi": { "docs": undefined, + "inline": undefined, "properties": { "address": { "docs": "The customers physical address. @@ -7038,6 +7092,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "CustomerPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -7067,6 +7122,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -7081,6 +7137,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "CustomerPse": { "docs": undefined, + "inline": undefined, "properties": { "address": { "docs": "The customers physical address. @@ -7159,6 +7216,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DisplayConfirmationRequiredContentPse": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "payer_institution": { "type": "optional", @@ -7170,6 +7228,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DisplayConfirmationRequiredOfpi": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "beneficiary_bank_account": { "type": "optional", @@ -7192,6 +7251,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DisplayCredentialsRequiredContentPse": { "docs": "Object containing form fields for the required credentials (for example, `username` or `password`) in this step.", + "inline": undefined, "properties": { "payer_institution": { "type": "optional", @@ -7203,6 +7263,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DisplayCustomerBankAccountsContentPse": { "docs": "Object detailing what payment method information you need to display.", + "inline": undefined, "properties": { "beneficiary_bank_account": { "type": "optional", @@ -7218,6 +7279,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DisplayPaymentFailed": { "docs": "Details regarding the payer institution.", + "inline": undefined, "properties": { "payer_institution": "optional", }, @@ -7227,6 +7289,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DisplayPaymentMethodInformationContentOfpi": { "docs": "Object detailing what payment method information you need to display.", + "inline": undefined, "properties": { "institutions": { "docs": "An array of institution objects.", @@ -7239,6 +7302,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DisplayPaymentMethodInformationContentPse": { "docs": "Object detailing what payment method information you need to display.", + "inline": undefined, "properties": { "customer_bank_accounts": { "docs": "Array of bank account objects. @@ -7257,6 +7321,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DisplayPaymentProcessing": { "docs": "Details regarding the payer institution.", + "inline": undefined, "properties": { "payer_institution": "optional", }, @@ -7266,6 +7331,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DisplayPaymentSucceeded": { "docs": "Details regarding the payer institution.", + "inline": undefined, "properties": { "payer_institution": "optional", }, @@ -7275,6 +7341,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DisplayTokenRequiredContentPse": { "docs": undefined, + "inline": undefined, "properties": { "payer_institution": "optional", }, @@ -7284,6 +7351,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DocumentIdBusiness": { "docs": "Object containing information about the ID document of the tax payer.", + "inline": undefined, "properties": { "document_number": { "docs": "The number of the ID document.", @@ -7300,6 +7368,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DocumentIdIndividual": { "docs": "Object containing information about the ID document of the tax payer.", + "inline": undefined, "properties": { "document_number": { "docs": "The number of the ID document.", @@ -7316,6 +7385,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DocumentInformationBusiness": { "docs": "Object containing detailed information about the fiscal document.", + "inline": undefined, "properties": { "form_number": { "docs": "The institution-provided identifier for the tax declaration.", @@ -7341,6 +7411,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DocumentInformationIndividual": { "docs": "Object containing detailed information about the fiscal document.", + "inline": undefined, "properties": { "form_number": { "docs": "Institution-provided identifier for the tax declaration.", @@ -7366,6 +7437,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "EmploymentRecord": { "docs": "Emploment record response payload", + "inline": undefined, "properties": { "collected_at": { "docs": "The ISO-8601 timestamp when the data point was collected.", @@ -7426,6 +7498,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "EmploymentRecordDetail": { "docs": "Details regarding the individual's employment history.", + "inline": undefined, "properties": { "collected_at": { "docs": "The ISO-8601 timestamp when the data point was collected.", @@ -7501,6 +7574,7 @@ For Mexico, this is the *daily* rate that the individual earned, including the p }, "EmploymentRecordDocumentId": { "docs": "Details regarding the individual's ID documents.", + "inline": undefined, "properties": { "document_number": { "docs": "The ID document's number (as a string). @@ -7515,6 +7589,7 @@ For Mexico, this is the *daily* rate that the individual earned, including the p }, "EmploymentRecordEmploymentStatusUpdates": { "docs": "Details regarding any employment changes of the individual.", + "inline": undefined, "properties": { "base_salary": { "docs": "The base salary of the individual, current as of the `update_date`. @@ -7540,6 +7615,7 @@ For Mexico, this is the *daily* rate that the individual earned, including the p }, "EmploymentRecordEntitlement": { "docs": "Details regarding the benefits the individual is entitled to.", + "inline": undefined, "properties": { "entitled_to_company_benefits": { "docs": "Indicates whether or not the individual is entitled to company benefits. @@ -7570,6 +7646,7 @@ For Mexico, this is the *daily* rate that the individual earned, including the p }, "EmploymentRecordFile": { "docs": "Additional PDF binary files relating to the individual's employment.", + "inline": undefined, "properties": { "type": { "docs": "The title of the document. @@ -7588,6 +7665,7 @@ For Mexico, this is the *daily* rate that the individual earned, including the p }, "EmploymentRecordPersonalData": { "docs": "Details regarding the personal information of the individual.", + "inline": undefined, "properties": { "birth_date": { "docs": "The date of the birth of the individual, in `YYYY-MM-DD` format. @@ -7632,6 +7710,7 @@ For Mexico, this is the *daily* rate that the individual earned, including the p }, "EmploymentRecordSocialSecuritySummary": { "docs": "Details regarding the individual's social security contributions.", + "inline": undefined, "properties": { "weeks_contributed": { "docs": "Number of weeks the individual has contributed to their social security, based on the number of weeks the individual has worked according to IMSS. @@ -7655,6 +7734,7 @@ For Mexico, this is the *daily* rate that the individual earned, including the p }, "EmploymentRecordsPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -8764,6 +8844,7 @@ We return one of the following enum values: }, "EquityStatementBusiness": { "docs": "Object containing the general fiscal situation of the taxpayer.", + "inline": undefined, "properties": { "accounts_documents_and_finance_leases_receivable": { "docs": "Total of all payments the company expects to receive (for example, from partial invoices that have not been paid yet).", @@ -8804,6 +8885,7 @@ We return one of the following enum values: }, "EquityStatementIndividual": { "docs": "Object containing the general fiscal situation of the taxpayer.", + "inline": undefined, "properties": { "total_debts": { "docs": "The total debts of the tax_payer", @@ -8824,6 +8906,7 @@ We return one of the following enum values: }, "EyodIncomeVerificationBodyRequest": { "docs": undefined, + "inline": undefined, "properties": { "account_category": "EnumIncomeVerificationAccountCategory", "account_holder_id": { @@ -8885,6 +8968,7 @@ We return one of the following enum values: }, "GrossIncomeIndividual": { "docs": "Object containing the declared gross income of the tax payer.", + "inline": undefined, "properties": { "capital_income": { "docs": "Income received from an investment (such as dividends or from renting a property).", @@ -8909,6 +8993,7 @@ We return one of the following enum values: }, "HolderBankAccountInformationPse": { "docs": "Object with additional information about the individual that holds the bank account.", + "inline": undefined, "properties": { "first_name": { "docs": "The account holder's first name.", @@ -8925,6 +9010,7 @@ We return one of the following enum values: }, "HolderBankAccountPse": { "docs": "Details regarding the bank account holder.", + "inline": undefined, "properties": { "information": "optional", "type": "optional", @@ -8937,6 +9023,7 @@ We return one of the following enum values: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -8951,6 +9038,7 @@ We return one of the following enum values: }, "INDIVIDUAL": { "docs": "Details about the OFPI payment method.", + "inline": undefined, "properties": { "open_finance": "PaymentIntentPaymentMethodDetailsBodyIndividualOfpi", }, @@ -8960,6 +9048,7 @@ We return one of the following enum values: }, "Income": { "docs": "Income insights", + "inline": undefined, "properties": { "created_at": { "docs": "The ISO-8601 timestamp of when the data point was created in Belvo's database.", @@ -9090,6 +9179,7 @@ For each income stream, we provide additional insights such as: - Key metrics about the transaction amounts. ℹ️ If no income sources are found, we return an empty array. ", + "inline": undefined, "properties": { "account_id": { "docs": "Unique ID for the bank account to be verified for income streams.", @@ -9189,6 +9279,7 @@ For each income stream, we provide additional insights such as: }, "IncomesPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -9216,6 +9307,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "Institution": { "docs": undefined, + "inline": undefined, "properties": { "country_codes": { "docs": "The country codes where the institution is available, for example: @@ -9296,6 +9388,7 @@ Please see our [Institutions](https://developers.belvo.com/docs/institution) Dev }, "InstitutionAccount": { "docs": "Details regarding the institution.", + "inline": undefined, "properties": { "name": { "docs": "The name of the institution, as designated by Belvo. @@ -9310,6 +9403,7 @@ Please see our [Institutions](https://developers.belvo.com/docs/institution) Dev }, "InstitutionDownError": { "docs": "This error occurs when the institution's website that you're trying to access is down due to maintenance or other issues, which means Belvo is unable to create new links or retrieve new data.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`institution_down`) that allows you to classify and handle the error programmatically. @@ -9342,6 +9436,7 @@ For `institution_down` errors, the description is: }, "InstitutionFormField": { "docs": undefined, + "inline": undefined, "properties": { "label": { "docs": "The label of the form field. For example: @@ -9390,6 +9485,7 @@ For `institution_down` errors, the description is: }, "InstitutionInactiveError": { "docs": "This error occurs when we (Belvo) have deactivated the institution in our API.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`institution_inactive`) that allows you to classify and handle the error programmatically. @@ -9422,6 +9518,7 @@ For `institution_inactive` errors, the description is: }, "InstitutionUnavailableError": { "docs": "This error occurs when the institution's website that you're trying to access is down due to maintenance or other issues, which means Belvo is unable to create new links or retrieve new data.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`institution_unavailable`) that allows you to classify and handle the error programmatically. @@ -9454,6 +9551,7 @@ For `institution_unavailable` errors, the description is: }, "InstitutionsFeature": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "The description of the feature.", @@ -9470,6 +9568,7 @@ For `institution_unavailable` errors, the description is: }, "InstitutionsFormField": { "docs": undefined, + "inline": undefined, "properties": { "label": { "docs": "The label of the form field. For example: @@ -9510,6 +9609,7 @@ For `institution_unavailable` errors, the description is: }, "InstitutionsFormFieldValues": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "The code of the document.", @@ -9542,6 +9642,7 @@ For `institution_unavailable` errors, the description is: }, "InstitutionsPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -9569,6 +9670,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "InvalidAccessMode": { "docs": "This error occurs when you try to update a link from single to recurrent, but there are no login credentials stored for the user.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`invalid_access_mode_switch`) that allows you to classify and handle the error programmatically. @@ -9601,6 +9703,7 @@ For `invalid_access_mode_switch` errors, the description is: }, "InvalidLinkError": { "docs": "This error occurs when you try to access an account but the user credentials are no longer valid, prompting an error from the institution.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`invalid_link`) that allows you to classify and handle the error programmatically. @@ -9633,6 +9736,7 @@ For `invalid_link` errors, the description is: }, "InvalidPeriodError": { "docs": "This error occurs when you request incomes for a link within a given date range, however, the period between `date_from` and `date_to` is less than 90 days.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`invalid_period`) that allows you to classify and handle the error programmatically. @@ -9665,6 +9769,7 @@ For `invalid_period` errors, the description is: }, "InvestmentsPortfolio": { "docs": undefined, + "inline": undefined, "properties": { "balance_gross": { "docs": "The current gross total value of the entire portfolio and all its underlying instruments, as given by the institution. @@ -9723,6 +9828,7 @@ Please note that other currencies other than in the list above may be returned. }, "InvestmentsPortfolioInstrument": { "docs": undefined, + "inline": undefined, "properties": { "average_acquisition_price": { "docs": "The average price of each share acquired in the instrument.", @@ -9816,6 +9922,7 @@ For example, the due date, the liquidity date, the previdencia type, and so on. }, "InvestmentsPortfolioInstrumentFees": { "docs": undefined, + "inline": undefined, "properties": { "type": { "docs": "The fee type incurred when making the purchase of the instrument.", @@ -9832,6 +9939,7 @@ For example, the due date, the liquidity date, the previdencia type, and so on. }, "InvestmentsPortfolioInstrumentInterestRate": { "docs": undefined, + "inline": undefined, "properties": { "index": { "docs": "If applicable, the index type that the `interest_rates.value` is calculated against.", @@ -9856,6 +9964,7 @@ For example, the due date, the liquidity date, the previdencia type, and so on. }, "InvestmentsPortfolioInstrumentPublicId": { "docs": "The public identifiers for the instrument.", + "inline": undefined, "properties": { "type": { "docs": "The type of public identifier for the instrument.", @@ -9872,6 +9981,7 @@ For example, the due date, the liquidity date, the previdencia type, and so on. }, "InvestmentsPortfolioInstrumentRedemptionConditions": { "docs": undefined, + "inline": undefined, "properties": { "type": { "docs": "The name of the redemption condition.", @@ -9888,6 +9998,7 @@ For example, the due date, the liquidity date, the previdencia type, and so on. }, "InvestmentsPortfoliosPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -9915,6 +10026,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "InvoiceDetailDian": { "docs": undefined, + "inline": undefined, "properties": { "collected_at": { "docs": "The ISO-8601 timestamp when the data point was collected.", @@ -9974,6 +10086,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "InvoiceDetailRetainedTaxSat": { "docs": undefined, + "inline": undefined, "properties": { "collected_at": { "docs": "The ISO-8601 timestamp when the data point was collected.", @@ -10003,6 +10116,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "InvoiceDetailSat": { "docs": undefined, + "inline": undefined, "properties": { "collected_at": { "docs": "The ISO-8601 timestamp when the data point was collected.", @@ -10070,6 +10184,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "InvoiceDian": { "docs": undefined, + "inline": undefined, "properties": { "cancelation_status": { "docs": "**Note**: This field is not applicable for DIAN Colombia and will return `null`.", @@ -10294,6 +10409,7 @@ For detailed information regarding DIAN's payment types, please see their [offic "InvoiceSenderDetailsDian": { "docs": "Details regarding the sender. ", + "inline": undefined, "properties": { "address": { "docs": "The sender's address. @@ -10349,6 +10465,7 @@ For detailed information regarding DIAN's tax schemes, please see their [officia "InvoiceWarningsDian": { "docs": "**Note**: This field is not applicable for DIAN Colombia and will return `null`. ", + "inline": undefined, "properties": { "code": { "docs": "**Note**: This field is not applicable for DIAN Colombia and will return `null`. @@ -10368,6 +10485,7 @@ For detailed information regarding DIAN's tax schemes, please see their [officia "InvoiceWarningsSat": { "docs": "Object containing information about any warnings related to this invoice. ", + "inline": undefined, "properties": { "code": { "docs": "The warning code. @@ -10386,6 +10504,7 @@ For detailed information regarding DIAN's tax schemes, please see their [officia }, "InvoiceWithIdSat": { "docs": undefined, + "inline": undefined, "properties": { "cancelation_status": { "docs": "If the invoice is cancelled, this field indicates the status of the cancellation.", @@ -10610,6 +10729,7 @@ Possible statuses are: }, "InvoicesPaymentsDian": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "**Note**: This field is not applicable for DIAN Colombia and will return `null`. @@ -10678,6 +10798,7 @@ Possible statuses are: }, "InvoicesPaymentsRelatedDocumentsDian": { "docs": "List of all the related deferred invoices affected by the payment.", + "inline": undefined, "properties": { "amount_paid": { "docs": "**Note**: This field is not applicable for DIAN Colombia and will return `null`. @@ -10721,6 +10842,7 @@ Possible statuses are: }, "InvoicesPaymentsRelatedDocumentsSat": { "docs": "List of all the related deferred invoices affected by the payment.", + "inline": undefined, "properties": { "amount_paid": { "docs": "The amount paid in this installment. @@ -10770,6 +10892,7 @@ Possible statuses are: }, "InvoicesPaymentsSat": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "The invoice amount, in the currency of the original invoice. @@ -10847,6 +10970,7 @@ Please note that other currencies other than in the list above may be returned. "InvoicesPayrollDian": { "docs": "**Note**: This field is not applicable for DIAN Colombia and will return `null`. ", + "inline": undefined, "properties": { "amount": { "docs": "**Note**: This field is not applicable for DIAN Colombia and will return `null`. @@ -10913,6 +11037,7 @@ Please note that other currencies other than in the list above may be returned. "InvoicesPayrollSat": { "docs": "Details regarding the payroll payment. Only applicable for payroll invoices. ", + "inline": undefined, "properties": { "amount": { "docs": "The total amount of the payroll payment. @@ -10981,6 +11106,7 @@ Please note that other currencies other than in the list above may be returned. "InvoicesReceiverDetailsDian": { "docs": "Details regarding the receiver. ", + "inline": undefined, "properties": { "address": { "docs": "The receiver's address. @@ -11035,6 +11161,7 @@ For detailed information regarding DIAN's tax schemes, please see their [officia }, "InvoicesResponsePaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -11064,6 +11191,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -11078,6 +11206,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "LastErrorInvalidCredentials": { "docs": "Information about the error you ran into in the previous step of the payment intent, if applicable. This error can occur when the credentials that your customer provides are incorrect.", + "inline": undefined, "properties": { "error_code": { "docs": "A unique error code (`invalid_credentials`) that allows you to classify and handle the error programmatically.", @@ -11094,6 +11223,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "LastErrorInvalidToken": { "docs": "Information about the error you ran into in the previous step of the payment intent, if applicable. This error can occur when the MFA token your customer provides is invalid.", + "inline": undefined, "properties": { "error_code": { "docs": "A unique error code (`invalid_token`) that allows you to classify and handle the error programmatically.", @@ -11110,6 +11240,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "LastErrorLoginError": { "docs": "Information about the error you ran into in the previous step of the payment intent, if applicable. This error can occur when something unexpected happened in the `pse_display_credentials_required` next step.", + "inline": undefined, "properties": { "error_code": { "docs": "A unique error code (`login_error`) that allows you to classify and handle the error programmatically.", @@ -11126,6 +11257,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "LastErrorPaymentError": { "docs": "Information about the error you ran into in the previous step of the payment intent, if applicable. This error can occur when something unexpected happened during the payment intent process.", + "inline": undefined, "properties": { "error_code": { "docs": "A unique error code (`payment_error`) that allows you to classify and handle the error programmatically.", @@ -11142,6 +11274,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "LastErrorSessionExpired": { "docs": "Information about the error you ran into in the previous step of the payment intent, if applicable. This error occurs when you try to send a PATCH request after the session has already expired (the session expires after 10 minutes).", + "inline": undefined, "properties": { "error_code": { "docs": "A unique error code (`session_expired`) that allows you to classify and handle the error programmatically.", @@ -11158,6 +11291,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "LastErrorTwoFactor": { "docs": "Information about the error you ran into in the previous step of the payment intent, if applicable. This error can occur when something unexpected happened in the `pse_display_token_required` next step.", + "inline": undefined, "properties": { "error_code": { "docs": "A unique error code (`login_two_factor_error`) that allows you to classify and handle the error programmatically.", @@ -11174,6 +11308,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "Link": { "docs": undefined, + "inline": undefined, "properties": { "access_mode": "optional", "created_at": { @@ -11247,6 +11382,7 @@ A unique 44-character string that can be used to identify a user at a given inst - the MFA token your user provides is not supported by Belvo. - there is an issue with the institution that prevents logins. - the user's account is either locked or the user does not have permission to access their internet banking.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`login_error`) that allows you to classify and handle the error programmatically. @@ -11285,6 +11421,7 @@ For `login_error` errors, the description can be one of the following: }, "NeedsRedirectContent": { "docs": "Details regarding the payer institution.", + "inline": undefined, "properties": { "payer_institution": "optional", }, @@ -11294,6 +11431,7 @@ For `login_error` errors, the description can be one of the following: }, "NeedsRedirectContentPse": { "docs": "Details regarding the payer institution.", + "inline": undefined, "properties": { "payer_institution": "optional", }, @@ -11303,6 +11441,7 @@ For `login_error` errors, the description can be one of the following: }, "NetIncomeIndividual": { "docs": "Object containing the declared net income of the tax payer. The values are calculated as the `gross_income` - `non_taxable_income`.", + "inline": undefined, "properties": { "capital_income": { "docs": "Income received from an investment (such as dividends or from renting a property).", @@ -11327,6 +11466,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepDisplayConfirmationRequiredOfpi": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "open_finance_display_confirmation_required": { "type": "optional", @@ -11345,6 +11485,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepDisplayConfirmationRequiredPse": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "pse_display_confirmation_required": { "type": "optional", @@ -11363,6 +11504,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepDisplayCredentialsRequiredPse": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "pse_display_credentials_required": { "type": "optional", @@ -11381,6 +11523,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepDisplayCustomerBankAccountsPse": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "pse_display_customer_bank_accounts": { "type": "optional", @@ -11399,6 +11542,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepDisplayNeedsRedirectPse": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "pse_display_needs_redirect": { "type": "optional", @@ -11417,6 +11561,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepDisplayPaymentFailed": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "open_finance_display_payment_failed": { "type": "optional", @@ -11435,6 +11580,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepDisplayPaymentMethodInformation": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "open_finance_display_payment_method_information": { "type": "optional", @@ -11453,6 +11599,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepDisplayPaymentMethodInformationPse": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type. You'll need to send a PATCH request with the institution selected by the customer or their bank accounts (if there are accounts already saved in the Belvo database).", + "inline": undefined, "properties": { "pse_display_payment_method_information": { "type": "optional", @@ -11471,6 +11618,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepDisplayPaymentProcessing": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "open_finance_display_payment_processing": { "type": "optional", @@ -11489,6 +11637,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepDisplayPaymentSucceeded": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "open_finance_display_payment_succeeded": { "type": "optional", @@ -11507,6 +11656,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepDisplayTokenRequiredPse": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "pse_display_token_required": { "type": "optional", @@ -11528,6 +11678,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepNeedsRedirect": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "open_finance_display_needs_redirect": { "type": "optional", @@ -11546,6 +11697,7 @@ For `login_error` errors, the description can be one of the following: }, "NonTaxableIncomeIndividual": { "docs": "Object containing the declared non-taxable income of the tax payer.", + "inline": undefined, "properties": { "capital_income": { "docs": "Income received from an investment (such as dividends or from renting a property).", @@ -11570,6 +11722,7 @@ For `login_error` errors, the description can be one of the following: }, "NotFoundErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`not_found`) that allows you to classify and handle the error programmatically. @@ -11602,6 +11755,7 @@ For `not_found` errors, the description is: }, "OFPB": { "docs": "Details about the organization's bank account that will receive the payment.", + "inline": undefined, "properties": { "beneficiary_bank_account": { "docs": "Belvo's unique ID used to identify the beneficiary's bank account.", @@ -11624,6 +11778,7 @@ For `not_found` errors, the description is: }, "OFPI": { "docs": "Details about the payment method.", + "inline": undefined, "properties": { "open_finance": { "type": "optional", @@ -11635,6 +11790,7 @@ For `not_found` errors, the description is: }, "Owner": { "docs": undefined, + "inline": undefined, "properties": { "address": { "docs": "The accounts owners registered address.", @@ -11728,6 +11884,7 @@ For `not_found` errors, the description is: }, "OwnerDocumentId": { "docs": "Information regarding the identification document the owner provided to the bank.", + "inline": undefined, "properties": { "document_number": { "docs": "The document's identification number.", @@ -11757,6 +11914,7 @@ For `not_found` errors, the description is: }, "OwnersPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -11784,6 +11942,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PSE": { "docs": "Object with payment method details to create a payment intent.", + "inline": undefined, "properties": { "pse": { "type": "PSE", @@ -11795,6 +11954,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaginatedResponseLink": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -11819,6 +11979,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PatchBody": { "docs": "A JSON object containing a session UUID and a MFA token", + "inline": undefined, "properties": { "link": { "docs": "The `link.id` you want to resume. Must be the same `link.id` as the one you receive in the 428 Token Required response that contains the `session` ID.", @@ -11857,6 +12018,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response }, "PatchBodyWithoutSaveData": { "docs": "A JSON object containing a session UUID and a MFA token", + "inline": undefined, "properties": { "link": { "docs": "The `link.id` you want to resume. Must be the same `link.id` as the one you receive in the 428 Token Required response that contains the `session` ID.", @@ -11889,6 +12051,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response }, "PatchPaymentIntentsBodyPse": { "docs": undefined, + "inline": undefined, "properties": { "pse": { "type": "optional", @@ -11900,6 +12063,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response }, "PatchPaymentMethodDetailsPse": { "docs": "Object with required fields to fill information in the payment intent object. The information you need to send through depends on the next step Belvo returns in the response.", + "inline": undefined, "properties": { "password": { "docs": "The password used to log in to the institution. @@ -11950,6 +12114,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response }, "PaymentInstitution": { "docs": undefined, + "inline": undefined, "properties": { "active": { "docs": "Indicates whether this institution is available for use or not.", @@ -12006,6 +12171,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response }, "PaymentIntentOfpi": { "docs": undefined, + "inline": undefined, "properties": { "allowed_payment_method_types": { "docs": "A list of payment method types allowed in this payment intent. For OFPI, the value will be `open_finance`.", @@ -12134,6 +12300,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -12148,6 +12315,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response }, "PaymentIntentPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -12175,6 +12343,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentIntentPaymentMethodDetailsBodyBusinessOfpi": { "docs": "Payment method type selected.", + "inline": undefined, "properties": { "beneficiary_bank_account": { "docs": "Belvo's unique ID used to identify the beneficiary's bank account.", @@ -12213,6 +12382,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentIntentPaymentMethodDetailsBodyIndividualOfpi": { "docs": "Payment method type selected.", + "inline": undefined, "properties": { "beneficiary_bank_account": { "docs": "Belvo's unique ID used to identify the beneficiary's bank account.", @@ -12251,6 +12421,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentIntentPaymentMethodDetailsBodyPse": { "docs": "Details about the payment method type selected.", + "inline": undefined, "properties": { "belvo_flow": { "default": true, @@ -12306,6 +12477,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentIntentPse": { "docs": undefined, + "inline": undefined, "properties": { "allowed_payment_method_types": { "docs": "A list of payment method types allowed in this payment intent. For PSE, the value will be `pse`.", @@ -12404,6 +12576,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -12460,6 +12633,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentLinkCallbackUrls": { "docs": undefined, + "inline": undefined, "properties": { "cancel": { "docs": "The URL that the user should be redirected to if they decide to cancel the payment process or if an error occurs. @@ -12482,6 +12656,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "docs": "The URLs that the user should be redirected to. **Note:** This field will return an empty object if your integration only generates payment links through the [Belvo Dashboard](https://dashboard.belvo.com/).", + "inline": undefined, "properties": { "cancel": { "docs": "The URL that the user should be redirected to if they decide to cancel the payment process or if an error occurs.", @@ -12498,6 +12673,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentLinkListOfpi": { "docs": undefined, + "inline": undefined, "properties": { "access_token": { "docs": "The Belvo-generated access token for the payment link. @@ -12574,6 +12750,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentLinkListPse": { "docs": undefined, + "inline": undefined, "properties": { "access_token": { "docs": "The Belvo-generated access token for the payment link. @@ -12650,6 +12827,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentLinkOfpi": { "docs": undefined, + "inline": undefined, "properties": { "access_token": { "docs": "The Belvo-generated access token for the payment link. @@ -12719,6 +12897,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentLinkPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -12748,6 +12927,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -12762,6 +12942,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentLinkPse": { "docs": undefined, + "inline": undefined, "properties": { "access_token": { "docs": "The Belvo-generated access token for the payment link. @@ -12831,6 +13012,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentMethodInfoCustomerBankAccountsPse": { "docs": undefined, + "inline": undefined, "properties": { "customer": { "docs": "Belvo's unique ID for the current customer.", @@ -12866,6 +13048,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentMethodInformationBodyOfpi": { "docs": "Payment method type selected.", + "inline": undefined, "properties": { "end_to_end_id": { "docs": "A unique ID for the transaction in the Brazil's PIX payment system.", @@ -12886,6 +13069,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentMethodInformationBodyPse": { "docs": "Payment method type selected.", + "inline": undefined, "properties": { "bank_payment_id": { "docs": "Unique payment ID provided the institution.", @@ -12910,6 +13094,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentMethodInformationDetailsPse": { "docs": undefined, + "inline": undefined, "properties": { "account_type": { "docs": "The type of bank account. For example, `Ahorros` or `Corriente`.", @@ -12923,6 +13108,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentTransaction": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "The transaction amount. @@ -13003,6 +13189,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -13017,6 +13204,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentWebhook": { "docs": undefined, + "inline": undefined, "properties": { "auth_header": { "docs": "The authentication header for the request. **Must** be set to `Authorization`.", @@ -13063,6 +13251,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentsInstitutionsPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -13090,6 +13279,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentsTransactionsPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -13117,6 +13307,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentsWay": { "docs": undefined, + "inline": undefined, "properties": { "form_id": { "docs": "Your unique Payments Way form ID. @@ -13137,6 +13328,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentsWebhooksPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -13164,6 +13356,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PensionIncomeStatementIndividual": { "docs": "Object containing the tax payer's total pension income.", + "inline": undefined, "properties": { "net_pension_income": { "docs": "The total net pension of the taxpayer.", @@ -13180,6 +13373,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "ReceivablesTransaction": { "docs": undefined, + "inline": undefined, "properties": { "account": "ReceivablesTransactionAccount", "collected_at": { @@ -13247,6 +13441,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "ReceivablesTransactionAccount": { "docs": "Basic information about the account associated with the transaction.", + "inline": undefined, "properties": { "id": { "docs": "Belvo's unique ID for the account associated with the transaction.", @@ -13266,6 +13461,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "ReceivablesTransactionNumberOfInstallments": { "docs": "Details regarding the number of installments for the transaction, if applicable.", + "inline": undefined, "properties": { "paid": { "docs": "The number of payments already made to pay the cost of the transaction.", @@ -13282,6 +13478,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "ReceivablesTransactionsPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -13309,6 +13506,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "RecevablesTransactionFees": { "docs": "Details regarding the fees applied to the transaction.", + "inline": undefined, "properties": { "type": "optional", "value": { @@ -13322,6 +13520,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "RecurringExpenseSourceTransaction": { "docs": "An array of minified transaction objects used to evaluate the recurring expense. If no transactions were found, we return an empty array.", + "inline": undefined, "properties": { "amount": { "docs": "The transaction amount.", @@ -13352,6 +13551,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro ℹ️ If no recurring expense insights are found, we return an empty array. ", + "inline": undefined, "properties": { "account": "optional", "average_transaction_amount": { @@ -13400,6 +13600,7 @@ Based on the frequency, you can infer how many days until the next charge will o }, "RecurringExpensesPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -13427,6 +13628,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "ReportingId": { "docs": "Object containing information about where the tax payer reports their income.", + "inline": undefined, "properties": { "reporting_type": { "docs": "The type of reporting ID. For DIAN, this is the sectional address code (*Codigo Dirrecion Seccional*)", @@ -13443,6 +13645,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "RequestTimeoutErrorBody": { "docs": "Belvo has a limit regarding the time it takes to log in, retrieve account data, and log out. A timeout occurs when there is a very high amount of data and everything could not be obtained within the allotted time.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`request_timeout`) that allows you to classify and handle the error programmatically. @@ -13475,6 +13678,7 @@ For `request_timeout` errors, the description is: }, "RetentionBreakdown": { "docs": "A breakdown of the retained taxes", + "inline": undefined, "properties": { "base_amount": { "docs": "The base amount that was used to calculate the tax retention. @@ -13499,6 +13703,7 @@ For `request_timeout` errors, the description is: }, "RiskInsights": { "docs": undefined, + "inline": undefined, "properties": { "accounts": { "docs": "An array of Belvo-generated account numbers (UUIDs) that were used during the risk insights analysis. If no accounts were found, we return an empty array.", @@ -13540,6 +13745,7 @@ For `request_timeout` errors, the description is: }, "RiskInsightsBalanceMetrics": { "docs": "Balance metrics calculated based on the user's balances from checking and savings accounts.", + "inline": undefined, "properties": { "balance_threshold_x": { "docs": "The threshold used to compute `days_balance_below_x_period`. Please note, this is value is country specific (both in terms of the amount and the currency). @@ -13621,6 +13827,7 @@ For `request_timeout` errors, the description is: However, internal transfers (transfers between accounts belonging to the same link) are not used in the calculation. ", + "inline": undefined, "properties": { "positive_to_negative_ratio_1m": { "docs": "The ratio between sum_positive / sum_negative in the last month (counted from the time of the request). @@ -13682,6 +13889,7 @@ However, internal transfers (transfers between accounts belonging to the same li }, "RiskInsightsCreditCardMetrics": { "docs": "Aggregated metrics calculated based on the link's credit card accounts.", + "inline": undefined, "properties": { "num_accounts": { "docs": "Number of credit cards accounts associated to the link. @@ -13712,6 +13920,7 @@ However, internal transfers (transfers between accounts belonging to the same li }, "RiskInsightsLoansMetrics": { "docs": "Aggregated metrics calculated based on the user's loan accounts.", + "inline": undefined, "properties": { "num_accounts": { "docs": "Number of loan accounts associated with the link. @@ -13740,6 +13949,7 @@ However, internal transfers (transfers between accounts belonging to the same li }, "RiskInsightsPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -13767,6 +13977,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "RiskInsightsTransactionMetrics": { "docs": "Aggregated metrics calculated band on the user's transactions from checking, savings, credit card, and loan accounts.", + "inline": undefined, "properties": { "max_incoming_amount_1m": { "docs": "The highest value inflow transaction in the last month. @@ -13943,6 +14154,7 @@ If the account has not been open long enough to have the transaction data for a }, "SecretKeys": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "The ISO-8601 timestamp of when the secret key was created. @@ -13975,6 +14187,7 @@ If the account has not been open long enough to have the transaction data for a }, "SecretKeysPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -14002,6 +14215,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "SessionExpiredError": { "docs": "This error occurs when you try to resume a request session that has already expired. This is usually because the user took too long to provide their authentication token.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`session_expired`) that allows you to classify and handle the error programmatically. @@ -14034,6 +14248,7 @@ For `session_expired` errors, the description is: }, "StandardRequest": { "docs": undefined, + "inline": undefined, "properties": { "link": { "docs": "The `link.id` that you want to get information for.", @@ -14062,6 +14277,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response }, "TaxAssessmentBusiness": { "docs": "Object containing the calculated tax assessment of the tax payer. This includes the total taxable income, the income tax applied, and taxes already withheld.", + "inline": undefined, "properties": { "fortuitous_profit_tax": { "docs": "The tax applied on your unexpected income (such as lottery wins or house sales).", @@ -14106,6 +14322,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response }, "TaxAssessmentIndividual": { "docs": "Object containing the calculated tax assessment of the tax payer. This includes the total taxable income, the income tax applied, and taxes already withheld.", + "inline": undefined, "properties": { "balance_payable": { "docs": "How much the tax payer is required to pay.", @@ -14154,6 +14371,7 @@ The amount the tax payer has as a "credit" fromt he previous year (this is equal }, "TaxComplianceStatus": { "docs": undefined, + "inline": undefined, "properties": { "collected_at": { "docs": "The ISO-8601 timestamp when the data point was collected.", @@ -14199,6 +14417,7 @@ The amount the tax payer has as a "credit" fromt he previous year (this is equal }, "TaxComplianceStatusPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -14226,6 +14445,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxDeclarationBusiness": { "docs": undefined, + "inline": undefined, "properties": { "annual_costs_and_deductions_statement": "AnnualCostsAndDeductionsStatementBusiness", "annual_income_statement": "AnnualIncomeStatementBusiness", @@ -14282,6 +14502,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxDeclarationBusinessPaginated": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -14309,6 +14530,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxDeclarationIndividual": { "docs": undefined, + "inline": undefined, "properties": { "annual_income_statement": "AnnualIncomeStatementIndividual", "collected_at": { @@ -14365,6 +14587,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxDeclarationIndividualPaginated": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -14392,6 +14615,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxPayerInformationBusiness": { "docs": "Object containing information about the tax payer.", + "inline": undefined, "properties": { "company_name": { "docs": "The name of the company, as registered at the institution.", @@ -14426,6 +14650,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxPayerInformationIndividual": { "docs": "Object containing information about the tax payer.", + "inline": undefined, "properties": { "document_id": "DocumentIdIndividual", "first_last_name": { @@ -14456,6 +14681,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxRetentions": { "docs": undefined, + "inline": undefined, "properties": { "cancelled_at": { "docs": "The ISO-8601 timestamp of when the tax retention was canceled (if applicable). @@ -14580,6 +14806,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxRetentionsPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -14608,6 +14835,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "TaxReturnBusiness": { "docs": undefined, "extra-properties": true, + "inline": undefined, "properties": { "cifras_cierre_ejercicio": { "docs": "Details regarding key numbers at the end of the fiscal exercise.", @@ -14695,6 +14923,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "TaxReturnBusinessMonthly": { "docs": undefined, "extra-properties": true, + "inline": undefined, "properties": { "collected_at": { "docs": "The ISO-8601 timestamp when the data point was collected.", @@ -14766,6 +14995,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "TaxReturnPersonal": { "docs": undefined, "extra-properties": true, + "inline": undefined, "properties": { "collected_at": { "docs": "The ISO-8601 timestamp when the data point was collected.", @@ -14855,6 +15085,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "TaxReturnPersonalMonthly": { "docs": undefined, "extra-properties": true, + "inline": undefined, "properties": { "collected_at": { "docs": "The ISO-8601 timestamp when the data point was collected.", @@ -14918,6 +15149,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "TaxReturnsBusinessMonthlyPaginated": { "docs": undefined, "extra-properties": true, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -14946,6 +15178,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "TaxReturnsBusinessPaginated": { "docs": undefined, "extra-properties": true, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -14973,6 +15206,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxReturnsMonthlyRequest": { "docs": "Request body for monthly tax returns", + "inline": undefined, "properties": { "attach_pdf": { "default": false, @@ -15021,6 +15255,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response "TaxReturnsPersonalMonthlyPaginated": { "docs": undefined, "extra-properties": true, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -15049,6 +15284,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "TaxReturnsPersonalPaginated": { "docs": undefined, "extra-properties": true, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -15076,6 +15312,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxReturnsYearlyRequest": { "docs": "Request body for yearly tax returns", + "inline": undefined, "properties": { "attach_pdf": { "default": false, @@ -15123,6 +15360,7 @@ By default, Belvo returns the yearly (annual) tax returns. }, "TaxStatusAddressBetweenStreetDian": { "docs": undefined, + "inline": undefined, "properties": { "street_one": { "docs": "**Note**: This field is not applicable for DIAN Colombia and will return `null`. @@ -15141,6 +15379,7 @@ By default, Belvo returns the yearly (annual) tax returns. }, "TaxStatusAddressBetweenStreetSat": { "docs": undefined, + "inline": undefined, "properties": { "street_one": { "docs": "The first street that `street` is located between.", @@ -15157,6 +15396,7 @@ By default, Belvo returns the yearly (annual) tax returns. }, "TaxStatusAddressDian": { "docs": "The tax payer's address details.", + "inline": undefined, "properties": { "between_street": { "docs": "**Note**: This field is not applicable for DIAN Colombia and will return `null`. @@ -15209,6 +15449,7 @@ By default, Belvo returns the yearly (annual) tax returns. }, "TaxStatusAddressSat": { "docs": "The tax payer's address details.", + "inline": undefined, "properties": { "between_street": { "docs": "Additional information about where the `street` is located. @@ -15261,6 +15502,7 @@ By default, Belvo returns the yearly (annual) tax returns. }, "TaxStatusDian": { "docs": undefined, + "inline": undefined, "properties": { "address": "optional", "collected_at": { @@ -15351,6 +15593,7 @@ Note: For individuals in Colombia, this field will return `null`. }, "TaxStatusEconomicActivityDian": { "docs": undefined, + "inline": undefined, "properties": { "economic_activity": { "docs": "The economic activity code, according to the fiscal institution. @@ -15396,6 +15639,7 @@ For detailed information regarding DIAN's economic activities, please see their }, "TaxStatusEconomicActivitySat": { "docs": undefined, + "inline": undefined, "properties": { "economic_activity": { "docs": "The description of the economic activity.", @@ -15441,6 +15685,7 @@ For detailed information regarding DIAN's economic activities, please see their ℹ️ For non-business accounts, this field will return empty. ", + "inline": undefined, "properties": { "end_date": { "docs": "**Note**: This field is not applicable for DIAN Colombia and will return `null`. @@ -15484,6 +15729,7 @@ For detailed information regarding DIAN's economic activities, please see their ℹ️ For non-business accounts, this field will return empty. ", + "inline": undefined, "properties": { "end_date": { "docs": "The date when obligation ended. @@ -15524,6 +15770,7 @@ For detailed information regarding DIAN's economic activities, please see their }, "TaxStatusPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -15553,6 +15800,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -15567,6 +15815,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxStatusRegimensDian": { "docs": undefined, + "inline": undefined, "properties": { "end_date": { "docs": "**Note**: This field is not applicable for DIAN Colombia and will return `null`. @@ -15601,6 +15850,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxStatusRegimensSat": { "docs": undefined, + "inline": undefined, "properties": { "end_date": { "docs": "The end date of the regimen. @@ -15635,6 +15885,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxStatusSat": { "docs": undefined, + "inline": undefined, "properties": { "address": "optional", "collected_at": { @@ -15722,6 +15973,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxStatusTaxPayerInformationDian": { "docs": "Details regarding the taxpayer.", + "inline": undefined, "properties": { "commercial_name": { "docs": "The name of the business designated for consumers and the general public. @@ -15798,6 +16050,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxStatusTaxPayerInformationSat": { "docs": "Details regarding the taxpayer.", + "inline": undefined, "properties": { "commercial_name": { "docs": "The name of the business designated for consumers and the general public. @@ -15874,6 +16127,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TokenRequiredResponse": { "docs": "MFA Token Required", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`token_required`) that allows you to classify and handle the error programmatically. @@ -15931,6 +16185,7 @@ For `token_required` errors, the description is: }, "TokenRequiredResponseTokenGenerationData": { "docs": "Details on how to generate the token.", + "inline": undefined, "properties": { "expects_user_input": { "default": true, @@ -15962,6 +16217,7 @@ You will still need to make a PATCH call to complete the request.", - a user is attempting to log in to their institution via Belvo while also already being logged in to their institution on a web browser or mobile app. - you make a request for information while Belvo is scraping data from the institution for that user.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`too_many_sessions`) that allows you to classify and handle the error programmatically. @@ -15994,6 +16250,7 @@ For `too_many_sessions` errors, the description is: }, "Transaction": { "docs": undefined, + "inline": undefined, "properties": { "account": "optional", "accounting_date": { @@ -16091,6 +16348,7 @@ For `too_many_sessions` errors, the description is: }, "TransactionBankAccountBodyPse": { "docs": "Information about the payer's bank account. Belvo returns the bank account ID when the account is already saved in the Belvo database.", + "inline": undefined, "properties": { "bank_account": { "docs": "Belvo's unique identifier for the payer’s bank account.", @@ -16115,6 +16373,7 @@ For `too_many_sessions` errors, the description is: "discriminated": false, "docs": "Object containing the payer's bank account information.", "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -16129,6 +16388,7 @@ For `too_many_sessions` errors, the description is: }, "TransactionCreditCardData": { "docs": "Additional data provided by the institution for credit card transactions.", + "inline": undefined, "properties": { "bill_amount": { "docs": "The aggregate bill amount, as of `collected_at`.", @@ -16163,6 +16423,7 @@ We only return merchant information for new transactions made from *checking* or > **Get merchant information** We retrieve the merchant information for a transaction as part of our [Transaction categorization](https://developers.belvo.com/docs/banking#categorizing-transactions) product, turning raw data into actionable insights. To enable this product, just [reach out](https://belvo.com/contact/?utm_source=documentation) to us, and we'll get right to it. ", + "inline": undefined, "properties": { "logo": { "docs": "The URL to the merchant's logo.", @@ -16183,6 +16444,7 @@ We only return merchant information for new transactions made from *checking* or }, "TransactionsPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -16210,6 +16472,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TransactionsRequest": { "docs": undefined, + "inline": undefined, "properties": { "account": { "docs": "If provided, we return transactions only from this account.", @@ -16272,6 +16535,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response }, "UnauthorizedErrorBody": { "docs": "This error occurs when you try to make an API call using incorrect Belvo API credentials (either your secret key or secret password, or both, are incorrect).", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`authentication_failed`) that allows you to classify and handle the error programmatically. @@ -16305,6 +16569,7 @@ For `authentication_failed` errors, the description is: "UnconfirmedLinkError": { "docs": "This error occurs when you try to access a link that was paused previously (and as such is not active now). A Link's status is set to `unconfirmed_link` when your user has not completed the Link creation process successfully (for example, they might not provide a valid MFA token).", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`unconfirmed_link`) that allows you to classify and handle the error programmatically. @@ -16337,6 +16602,7 @@ For `unconfirmed_link` errors, the description is: }, "UnexpectedError": { "docs": "This error occurs when we (Belvo) have encountered an internal system error (sorry about that) or due to an unsupported response from the institution.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`unexpected_error`) that allows you to classify and handle the error programmatically. @@ -16369,6 +16635,7 @@ For `unexpected_error` errors, the description is: }, "UnsupportedOperationError": { "docs": "This error occurs when you try to access some data operation that Belvo does not support for an institution. For example, trying to access the Balances resource for fiscal institutions.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`unsupported_operation`) that allows you to classify and handle the error programmatically. @@ -16401,6 +16668,7 @@ For `unsupported_operation` errors, the description is: }, "ValidationError": { "docs": "This error occurs when you try to resume a request session that has already expired. This is usually because the user took too long to provide their authentication token.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`null`, `does_not_exist`, `required`) that allows you to classify and handle the error programmatically. @@ -22422,6 +22690,7 @@ types: - type: InvoiceDian source: openapi: ../openapi.yml + inline: true InvoicesResponsePaginatedResponse: properties: count: @@ -23413,6 +23682,7 @@ types: - type: TaxStatusDian source: openapi: ../openapi.yml + inline: true TaxStatusPaginatedResponse: properties: count: @@ -26656,6 +26926,7 @@ types: - type: CustomerPse source: openapi: ../openapi.yml + inline: true CustomerPaginatedResponse: properties: count: @@ -26810,6 +27081,7 @@ types: - type: INDIVIDUAL source: openapi: ../openapi.yml + inline: true OFPI: docs: Details about the payment method. properties: @@ -26824,6 +27096,7 @@ types: - type: BankAccountDetailsOfpiPix source: openapi: ../openapi.yml + inline: true BankAccountOfpiResponse: properties: id: @@ -26948,6 +27221,7 @@ types: - BankAccountPseResponse source: openapi: ../openapi.yml + inline: true BankAccountPaginatedResponse: properties: count: @@ -26982,6 +27256,7 @@ types: - type: INDIVIDUAL source: openapi: ../openapi.yml + inline: true CreateBankAccountOfpiDetails: discriminated: false docs: Information regarding the bank account. @@ -26990,6 +27265,7 @@ types: - type: BankAccountDetailsOfpiPix source: openapi: ../openapi.yml + inline: true CreateBankAccountOfpi: properties: institution: @@ -27219,6 +27495,7 @@ types: - type: PaymentLinkListPse source: openapi: ../openapi.yml + inline: true PaymentLinkPaginatedResponse: properties: count: @@ -27327,6 +27604,7 @@ types: - float source: openapi: ../openapi.yml + inline: true CreatePaymentLinkOfpi: properties: amount: @@ -27393,6 +27671,7 @@ types: - long source: openapi: ../openapi.yml + inline: true CreatePaymentLinkPse: properties: amount: @@ -27529,6 +27808,7 @@ types: - type: BankAccountDetailsOpenFinancePix source: openapi: ../openapi.yml + inline: true BeneficiaryBankAccountOfpi: properties: id: @@ -27851,6 +28131,7 @@ types: - type: TransactionBankAccountPse source: openapi: ../openapi.yml + inline: true PaymentTransaction: properties: id: @@ -27917,6 +28198,7 @@ types: - type: OFPI source: openapi: ../openapi.yml + inline: true Charge: properties: id: @@ -28033,6 +28315,7 @@ types: - type: BUSINESS source: openapi: ../openapi.yml + inline: true PaymentIntentOfpi: properties: id: @@ -28561,6 +28844,7 @@ types: - type: LastErrorSessionExpired source: openapi: ../openapi.yml + inline: true PaymentIntentPse: properties: id: @@ -38226,6 +38510,7 @@ docs: >- "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -38242,6 +38527,7 @@ docs: >- "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -38256,6 +38542,7 @@ docs: >- "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -39381,6 +39668,7 @@ docs: >- "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -39397,6 +39685,7 @@ docs: >- "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -39413,6 +39702,7 @@ docs: >- "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -48824,6 +49114,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -48840,6 +49131,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -48856,6 +49148,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -57508,6 +57801,7 @@ During the payment intent flow, you need to fill in the payment intent with requ **Note:** You can send through this value either as a string or an integer. Regardless of the type you choose to send the `amount` as, Belvo returns a string with two decimal points, separated by a period ( `.`). For example, `350000.00`. ", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -58142,6 +58436,7 @@ types: - long source: openapi: ../openapi.yml + inline: true ", }, "paymentLinks.yml": { @@ -58551,6 +58846,7 @@ types: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -58567,6 +58863,7 @@ types: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -58583,6 +58880,7 @@ types: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -66977,6 +67275,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -66993,6 +67292,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -67009,6 +67309,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -73377,6 +73678,7 @@ client.connect() "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -73399,6 +73701,7 @@ client.connect() "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -73421,6 +73724,7 @@ client.connect() "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -73437,6 +73741,7 @@ client.connect() "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -78666,6 +78971,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -78682,6 +78988,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/buzzshot.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/buzzshot.json index 52ae34cb367..fd91f1ef799 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/buzzshot.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/buzzshot.json @@ -8,6 +8,7 @@ "types": { "Game": { "docs": undefined, + "inline": undefined, "properties": { "added_at": "optional", "complete": "GameComplete", @@ -44,6 +45,7 @@ }, "GameComplete": { "docs": undefined, + "inline": true, "properties": { "completed_at": "datetime", "completion_time": "optional", @@ -57,6 +59,7 @@ }, "GameExtraFieldsItem": { "docs": undefined, + "inline": true, "properties": { "key": "string", "label": "optional", @@ -69,6 +72,7 @@ }, "GamePhotosItem": { "docs": undefined, + "inline": true, "properties": { "added_at": "optional", "photo": "string", @@ -89,6 +93,7 @@ }, "Group": { "docs": undefined, + "inline": undefined, "properties": { "added_at": "optional", "date": { @@ -124,6 +129,7 @@ }, "GroupGamesItem": { "docs": undefined, + "inline": true, "properties": { "added_at": "optional", "complete": "GroupGamesItemComplete", @@ -158,6 +164,7 @@ }, "GroupGamesItemComplete": { "docs": undefined, + "inline": true, "properties": { "completed_at": "datetime", "completion_time": "optional", @@ -171,6 +178,7 @@ }, "GroupGamesItemExtraFieldsItem": { "docs": undefined, + "inline": true, "properties": { "key": "string", "label": "optional", @@ -183,6 +191,7 @@ }, "GroupPhotosItem": { "docs": undefined, + "inline": true, "properties": { "added_at": "optional", "game": "optional", @@ -204,6 +213,7 @@ }, "GroupPlayersItem": { "docs": undefined, + "inline": true, "properties": { "added_at": "optional", "email": { @@ -245,6 +255,7 @@ }, "GroupPlayersItemExtraFieldsItem": { "docs": undefined, + "inline": true, "properties": { "key": "string", "label": "optional", @@ -257,6 +268,7 @@ }, "Photo": { "docs": undefined, + "inline": undefined, "properties": { "added_at": "optional", "id": "optional", @@ -277,6 +289,7 @@ }, "PhotoProcessedItem": { "docs": undefined, + "inline": true, "properties": { "added_at": "optional", "game": "optional", @@ -299,6 +312,7 @@ }, "Player": { "docs": undefined, + "inline": undefined, "properties": { "added_at": "optional", "email": { @@ -340,6 +354,7 @@ }, "PlayerExtraFieldsItem": { "docs": undefined, + "inline": true, "properties": { "key": "string", "label": "optional", @@ -352,6 +367,7 @@ }, "Room": { "docs": undefined, + "inline": undefined, "properties": { "hidden": "optional", "id": "optional", @@ -393,6 +409,7 @@ ready: optional source: openapi: ../openapi.yml + inline: true GameExtraFieldsItem: properties: key: string @@ -401,6 +418,7 @@ present: boolean source: openapi: ../openapi.yml + inline: true GameComplete: properties: completed_at: datetime @@ -410,6 +428,7 @@ completion_time: optional source: openapi: ../openapi.yml + inline: true Game: properties: id: optional @@ -440,6 +459,7 @@ present: boolean source: openapi: ../openapi.yml + inline: true GroupGamesItemComplete: properties: completed_at: datetime @@ -449,6 +469,7 @@ completion_time: optional source: openapi: ../openapi.yml + inline: true GroupGamesItem: properties: id: optional @@ -469,6 +490,7 @@ complete: GroupGamesItemComplete source: openapi: ../openapi.yml + inline: true GroupPlayersItemExtraFieldsItem: properties: key: string @@ -477,6 +499,7 @@ present: boolean source: openapi: ../openapi.yml + inline: true GroupPlayersItem: properties: added_at: optional @@ -499,6 +522,7 @@ signature: optional source: openapi: ../openapi.yml + inline: true GroupPhotosItem: properties: added_at: optional @@ -511,6 +535,7 @@ ready: optional source: openapi: ../openapi.yml + inline: true Group: properties: id: optional @@ -540,6 +565,7 @@ present: boolean source: openapi: ../openapi.yml + inline: true Player: properties: id: optional @@ -575,6 +601,7 @@ ready: optional source: openapi: ../openapi.yml + inline: true Photo: properties: id: optional @@ -1293,6 +1320,7 @@ "types": { "ListAccountsResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "next": { @@ -1321,6 +1349,7 @@ }, "ListGamesResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "next": { @@ -1349,6 +1378,7 @@ }, "ListGroupsResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "next": { @@ -1377,6 +1407,7 @@ }, "ListLocationsResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "next": { @@ -1405,6 +1436,7 @@ }, "ListPhotosResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "next": { @@ -1433,6 +1465,7 @@ }, "ListPlayersResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "next": { diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/deel.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/deel.json index 29c25191d2f..e9696a2567f 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/deel.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/deel.json @@ -6519,6 +6519,7 @@ "types": { "Agreement": { "docs": undefined, + "inline": undefined, "properties": { "agreement_title": "string", "agreement_type": "string", @@ -6533,6 +6534,7 @@ }, "AgreementClientLegalEntity": { "docs": undefined, + "inline": true, "properties": { "id": "double", "name": "string", @@ -6544,6 +6546,7 @@ "AgreementList": "list", "AgreementListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "AgreementList", "page": "optional", @@ -6554,6 +6557,7 @@ }, "AgreementMsa": { "docs": undefined, + "inline": true, "properties": { "id": "string", "title": "string", @@ -6564,6 +6568,7 @@ }, "AgreementProviderLegalEntity": { "docs": undefined, + "inline": true, "properties": { "id": "double", "name": "string", @@ -6582,6 +6587,7 @@ }, "AgreementsSearchForm": { "docs": "Convenient model to encapsulate query parameters to get a list of agreements.", + "inline": undefined, "properties": { "contract_id": "optional", "limit": "optional", @@ -6593,6 +6599,7 @@ }, "AlternateEmailItem": { "docs": undefined, + "inline": undefined, "properties": { "email": "optional", "isVerified": "boolean", @@ -6607,6 +6614,7 @@ }, "ApiError": { "docs": undefined, + "inline": undefined, "properties": { "message": { "docs": "A description of the returned error", @@ -6623,6 +6631,7 @@ }, "ApiErrorContainer": { "docs": undefined, + "inline": undefined, "properties": { "errors": "optional>", "request": "optional", @@ -6633,6 +6642,7 @@ }, "ApiErrorRequest": { "docs": undefined, + "inline": undefined, "properties": { "api_req_id": { "docs": "The request ID of the failed request", @@ -6669,6 +6679,7 @@ }, "BasicContract": { "docs": undefined, + "inline": undefined, "properties": { "client": "ClientOfBasicContract", "created_at": "optional", @@ -6711,6 +6722,7 @@ }, "BasicInvoiceAdjustment": { "docs": undefined, + "inline": undefined, "properties": { "attachment": "optional", "contract": "BasicInvoiceAdjustmentContract", @@ -6737,6 +6749,7 @@ }, "BasicInvoiceAdjustmentContract": { "docs": undefined, + "inline": true, "properties": { "id": "string", "title": "string", @@ -6748,6 +6761,7 @@ }, "BasicInvoiceAdjustmentPaymentCycle": { "docs": undefined, + "inline": true, "properties": { "end_date": "optional", "start_date": "optional", @@ -6758,6 +6772,7 @@ }, "BasicInvoiceAdjustmentReportedBy": { "docs": undefined, + "inline": true, "properties": { "full_name": "string", "id": "double", @@ -6768,6 +6783,7 @@ }, "BasicInvoiceAdjustmentReviewedBy": { "docs": undefined, + "inline": true, "properties": { "full_name": "string", "id": "double", @@ -6780,6 +6796,7 @@ }, "BasicInvoiceAdjustmentWorksheet": { "docs": undefined, + "inline": true, "properties": { "days": { "type": "double", @@ -6828,6 +6845,7 @@ }, "BasicLegalEntity": { "docs": undefined, + "inline": undefined, "properties": { "entity_subtype": "LegalEntitySubType", "entity_type": "LegalEntityType", @@ -6840,6 +6858,7 @@ }, "BasicOrganization": { "docs": undefined, + "inline": undefined, "properties": { "id": "double", "name": { @@ -6858,6 +6877,7 @@ }, "BasicTeam": { "docs": undefined, + "inline": undefined, "properties": { "id": "double", "name": { @@ -6876,6 +6896,7 @@ }, "BasicTimesheet": { "docs": undefined, + "inline": undefined, "properties": { "attachment": "optional", "contract": "BasicTimesheetContract", @@ -6908,6 +6929,7 @@ }, "BasicTimesheetContract": { "docs": undefined, + "inline": true, "properties": { "id": "string", "title": "string", @@ -6919,6 +6941,7 @@ }, "BasicTimesheetPaymentCycle": { "docs": undefined, + "inline": true, "properties": { "end_date": "optional", "start_date": "optional", @@ -6929,6 +6952,7 @@ }, "BasicTimesheetReportedBy": { "docs": undefined, + "inline": true, "properties": { "full_name": "string", "id": "double", @@ -6939,6 +6963,7 @@ }, "BasicTimesheetReviewedBy": { "docs": undefined, + "inline": true, "properties": { "full_name": "string", "id": "double", @@ -6951,6 +6976,7 @@ }, "BasicTimesheetWorksheet": { "docs": undefined, + "inline": true, "properties": { "days": { "type": "double", @@ -6999,6 +7025,7 @@ }, "ClientLegalEntity": { "docs": undefined, + "inline": undefined, "properties": { "email": "optional", "id": "long", @@ -7014,6 +7041,7 @@ }, "ClientOfBasicContract": { "docs": undefined, + "inline": undefined, "properties": { "team": "optional", }, @@ -7023,6 +7051,7 @@ }, "ClientOfContract": { "docs": undefined, + "inline": undefined, "properties": { "email": "optional", "full_name": "string", @@ -7036,6 +7065,7 @@ }, "CompensationDetailsOfContract": { "docs": undefined, + "inline": undefined, "properties": { "amount": "string", "currency_code": "CurrencyCodeRequired", @@ -7053,6 +7083,7 @@ }, "CompensationDetailsOfContractToCreateOngoingTimeBased": { "docs": undefined, + "inline": undefined, "properties": { "amount": "double", "scale": "WorkStatementScaleEnum", @@ -7063,6 +7094,7 @@ }, "CompensationDetailsOfContractToCreatePayAsYouGoTimeBased": { "docs": undefined, + "inline": undefined, "properties": { "amount": "double", "scale": "WorkStatementScaleEnum", @@ -7073,6 +7105,7 @@ }, "CompensationDetailsOfContractToCreateShared": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.", @@ -7128,6 +7161,7 @@ }, "Contract": { "docs": undefined, + "inline": undefined, "properties": { "client": "optional", "compensation_details": "CompensationDetailsOfContract", @@ -7177,6 +7211,7 @@ }, "ContractContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "Contract", }, @@ -7186,6 +7221,7 @@ }, "ContractContainerOngoingTimeBased": { "docs": undefined, + "inline": undefined, "properties": { "data": "Contract", }, @@ -7195,6 +7231,7 @@ }, "ContractContainerPayAsYouGoTimeBased": { "docs": undefined, + "inline": undefined, "properties": { "data": "Contract", }, @@ -7204,6 +7241,7 @@ }, "ContractContainerPaygMilestones": { "docs": undefined, + "inline": undefined, "properties": { "data": "Contract", }, @@ -7213,6 +7251,7 @@ }, "ContractContainerPaygTasks": { "docs": undefined, + "inline": undefined, "properties": { "data": "Contract", }, @@ -7222,6 +7261,7 @@ }, "ContractCustomField": { "docs": "Customized attributes on contracts (Employee ID, Project code, etc).", + "inline": undefined, "properties": { "name": { "docs": "Custom field property name.", @@ -7238,6 +7278,7 @@ }, "ContractDetailsToAmend": { "docs": "You can specify any combination of data points that need changing.", + "inline": undefined, "properties": { "amount": { "type": "optional", @@ -7317,6 +7358,7 @@ }, "ContractDocumentContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional", }, @@ -7326,6 +7368,7 @@ }, "ContractExternalIdPatchedContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "ContractExternalIdToPatch", }, @@ -7336,6 +7379,7 @@ "ContractExternalIdPatchedResponseContainer": "ContractExternalIdToPatch", "ContractExternalIdToPatch": { "docs": undefined, + "inline": undefined, "properties": { "external_id": { "docs": "A unique identifier for the object provided by an external system.", @@ -7358,6 +7402,7 @@ }, "ContractInvitationToCreate": { "docs": undefined, + "inline": undefined, "properties": { "email": "EmailTypeRequired", "message": { @@ -7378,6 +7423,7 @@ "ContractList": "list", "ContractListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "ContractList", "page": "PageInfo", @@ -7391,6 +7437,7 @@ "discriminated": false, "docs": "Search form should include parameters varied based on usage of cursor for pagination. NOTE: that all query parameters are based on strings", "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -7401,6 +7448,7 @@ }, "ContractSearchFormWithCursor": { "docs": "This is a model to make it easier to understand and restrict search parameters", + "inline": undefined, "properties": { "after_cursor": { "docs": "Return next page of results after given cursor.", @@ -7424,6 +7472,7 @@ }, "ContractSearchFormWithoutCursor": { "docs": "This is a model to make it easier to understand and restrict search parameters", + "inline": undefined, "properties": { "countries": "optional", "currencies": "optional", @@ -7475,6 +7524,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -7487,6 +7537,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -7499,6 +7550,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -7511,6 +7563,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -7521,6 +7574,7 @@ }, "ContractSignatureToCreate": { "docs": undefined, + "inline": undefined, "properties": { "client_signature": { "docs": "Signature of client.", @@ -7571,6 +7625,7 @@ "ContractTemplateList": "list", "ContractTemplateListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional", }, @@ -7580,6 +7635,7 @@ }, "ContractTemplateSummary": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "Unique identifier of a contract template", @@ -7596,6 +7652,7 @@ }, "ContractTerminationResult": { "docs": undefined, + "inline": undefined, "properties": { "completion_date": { "docs": "Date the contract is marked for completion", @@ -7612,6 +7669,7 @@ }, "ContractTerminationResultContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "ContractTerminationResult", }, @@ -7623,6 +7681,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -7638,6 +7697,7 @@ "extends": [ "ContractToCreateShared", ], + "inline": undefined, "properties": { "compensation_details": "ContractToCreateOngoingTimeBasedCompensationDetails", "type": "literal<"ongoing_time_based">", @@ -7648,6 +7708,7 @@ }, "ContractToCreateOngoingTimeBasedCompensationDetails": { "docs": undefined, + "inline": true, "properties": { "amount": { "docs": "Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.", @@ -7707,6 +7768,7 @@ "extends": [ "ContractToCreateShared", ], + "inline": undefined, "properties": { "compensation_details": "ContractToCreatePayAsYouGoTimeBasedCompensationDetails", "type": "literal<"pay_as_you_go_time_based">", @@ -7717,6 +7779,7 @@ }, "ContractToCreatePayAsYouGoTimeBasedCompensationDetails": { "docs": undefined, + "inline": true, "properties": { "amount": { "docs": "Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.", @@ -7776,6 +7839,7 @@ "extends": [ "ContractToCreateShared", ], + "inline": undefined, "properties": { "compensation_details": "CompensationDetailsOfContractToCreateShared", "type": "literal<"payg_milestones">", @@ -7789,6 +7853,7 @@ "extends": [ "ContractToCreateShared", ], + "inline": undefined, "properties": { "compensation_details": "CompensationDetailsOfContractToCreateShared", "type": "literal<"payg_tasks">", @@ -7799,6 +7864,7 @@ }, "ContractToCreateShared": { "docs": "Details of contract to create", + "inline": undefined, "properties": { "client": "ContractToCreateSharedClient", "country_code": "optional", @@ -7846,6 +7912,7 @@ }, "ContractToCreateSharedClient": { "docs": undefined, + "inline": true, "properties": { "legal_entity": { "docs": "Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization.", @@ -7862,6 +7929,7 @@ }, "ContractToCreateSharedClientLegalEntity": { "docs": "Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization.", + "inline": true, "properties": { "id": "double", }, @@ -7871,6 +7939,7 @@ }, "ContractToCreateSharedClientTeam": { "docs": "Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization.", + "inline": true, "properties": { "id": "double", }, @@ -7880,6 +7949,7 @@ }, "ContractToCreateSharedJobTitle": { "docs": "Worker's job title. You can enter a custom job title or use a pre-defiled job title using the Id retrieved in job-titles endpoint.", + "inline": true, "properties": { "id": { "docs": "Id of an predefined job title.", @@ -7902,6 +7972,7 @@ }, "ContractToCreateSharedSeniority": { "docs": "Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.", + "inline": true, "properties": { "id": "optional", }, @@ -7911,6 +7982,7 @@ }, "ContractToCreateSharedWorker": { "docs": "Worker properties", + "inline": true, "properties": { "expected_email": "optional", "first_name": { @@ -7940,6 +8012,7 @@ }, "ContractToTerminate": { "docs": undefined, + "inline": undefined, "properties": { "completion_date": "optional", "message": { @@ -8001,6 +8074,7 @@ }, "Contractor": { "docs": undefined, + "inline": undefined, "properties": { "name": { "default": "", @@ -8025,6 +8099,7 @@ }, "Country": { "docs": undefined, + "inline": undefined, "properties": { "code": "CountryCode", "eor_support": { @@ -8079,6 +8154,7 @@ "CountryList": "list", "CountryListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "CountryList", }, @@ -8088,6 +8164,7 @@ }, "CreateTimeoff": { "docs": undefined, + "inline": undefined, "properties": { "end_date": { "docs": "End date of employee's time off.", @@ -8128,6 +8205,7 @@ }, "CreateTimeoffContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "CreateTimeoff", }, @@ -8148,6 +8226,7 @@ }, "Currency": { "docs": undefined, + "inline": undefined, "properties": { "code": "CurrencyCodeRequired", "name": { @@ -8187,6 +8266,7 @@ "CurrencyList": "list", "CurrencyListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "CurrencyList", }, @@ -8254,6 +8334,7 @@ }, "EmployeeList": { "docs": undefined, + "inline": undefined, "properties": { "birth_date": "optional", "client_legal_entity": "optional", @@ -8285,6 +8366,7 @@ }, "EmployeeListClientLegalEntity": { "docs": undefined, + "inline": true, "properties": { "id": "optional", "name": "optional", @@ -8295,6 +8377,7 @@ }, "EmployeeListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "list", }, @@ -8304,6 +8387,7 @@ }, "EmployeeListMonthlyPayment": { "docs": undefined, + "inline": true, "properties": { "count": "optional", }, @@ -8313,6 +8397,7 @@ }, "EmployeeListPaymentsItem": { "docs": undefined, + "inline": true, "properties": { "contract_name": "optional", "currency": "optional", @@ -8325,6 +8410,7 @@ }, "Employment": { "docs": undefined, + "inline": undefined, "properties": { "client_legal_entity": { "docs": "The client legal entity associated with the employment.", @@ -8417,6 +8503,7 @@ }, "EmploymentDetailsOfContract": { "docs": undefined, + "inline": undefined, "properties": { "country": "optional", "days_per_week": "double", @@ -8435,6 +8522,7 @@ }, "EorClientTimeoffRequests": { "docs": undefined, + "inline": undefined, "properties": { "current_approved": { "docs": "Days off approved.", @@ -8468,6 +8556,7 @@ }, "EorClientTimeoffs": { "docs": undefined, + "inline": undefined, "properties": { "employees": { "docs": "List of employee time offs.", @@ -8481,6 +8570,7 @@ }, "EorClientTimeoffsContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "EorClientTimeoffs", }, @@ -8490,6 +8580,7 @@ }, "EorContractCreated": { "docs": undefined, + "inline": undefined, "properties": { "client": "optional", "compensation_details": "optional", @@ -8515,6 +8606,7 @@ }, "EorContractCreatedClient": { "docs": undefined, + "inline": true, "properties": { "legal_entity": "optional", }, @@ -8524,6 +8616,7 @@ }, "EorContractCreatedClientLegalEntity": { "docs": undefined, + "inline": true, "properties": { "name": { "docs": "Legal entity name.", @@ -8536,6 +8629,7 @@ }, "EorContractCreatedCompensationDetails": { "docs": undefined, + "inline": true, "properties": { "currency": { "docs": "Currency of gross annual salary.", @@ -8560,6 +8654,7 @@ }, "EorContractCreatedContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "EorContractCreated", }, @@ -8569,6 +8664,7 @@ }, "EorContractCreatedEmployee": { "docs": undefined, + "inline": true, "properties": { "email": { "docs": "Employee's email.", @@ -8593,6 +8689,7 @@ }, "EorContractCreatedEmployment": { "docs": undefined, + "inline": true, "properties": { "calculated_holidays": { "docs": "Number of calculate holidays for this contract.", @@ -8631,6 +8728,7 @@ }, "EorContractCreatedHealthPlan": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "Health plan ID", @@ -8647,6 +8745,7 @@ }, "EorContractToCreate": { "docs": undefined, + "inline": undefined, "properties": { "client": "EorContractToCreateClient", "compensation_details": "EorContractToCreateCompensationDetails", @@ -8672,6 +8771,7 @@ }, "EorContractToCreateClient": { "docs": undefined, + "inline": true, "properties": { "legal_entity": "optional", "team": "optional", @@ -8682,6 +8782,7 @@ }, "EorContractToCreateClientLegalEntity": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "Enter the Id of legal entity under which you want to hire this person. Use /legal-entities endpoint to retrieve a list of legal entities in your organization.", @@ -8694,6 +8795,7 @@ }, "EorContractToCreateClientTeam": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "Enter the Id of team this person will be hired in. Use /teams endpoint to retrieve a list of teams in your organization.", @@ -8706,6 +8808,7 @@ }, "EorContractToCreateCompensationDetails": { "docs": undefined, + "inline": true, "properties": { "currency": { "docs": "Salary currency.", @@ -8730,6 +8833,7 @@ }, "EorContractToCreateEmployee": { "docs": undefined, + "inline": true, "properties": { "address": "optional", "email": { @@ -8755,6 +8859,7 @@ }, "EorContractToCreateEmployeeAddress": { "docs": undefined, + "inline": true, "properties": { "city": { "docs": "City name.", @@ -8780,6 +8885,7 @@ }, "EorContractToCreateEmployment": { "docs": undefined, + "inline": true, "properties": { "country": "optional", "end_date": "optional", @@ -8846,6 +8952,7 @@ }, "EorContractToCreateQuoteAdditionalFields": { "docs": "Some countries require additional employee information for employment contracts.", + "inline": true, "properties": { "dob": { "docs": "Employee's date of birth.", @@ -8876,6 +8983,7 @@ }, "EorContractToCreateSeniority": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "Enter the Id retrieved from the seniority lookup endpoint. Enter 34 for "Not Applicable".", @@ -8888,6 +8996,7 @@ }, "EorCountryValidations": { "docs": undefined, + "inline": undefined, "properties": { "adjustments_information_box": { "docs": "Country specific notes and information.", @@ -8946,6 +9055,7 @@ }, "EorCountryValidationsContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "EorCountryValidations", }, @@ -8955,6 +9065,7 @@ }, "EorCountryValidationsDefiniteContract": { "docs": "Conditions to make definitive contract.", + "inline": true, "properties": { "maximum_limitation": "optional", "type": "optional", @@ -8975,6 +9086,7 @@ }, "EorCountryValidationsHealthInsurance": { "docs": undefined, + "inline": true, "properties": { "providers": "optional>", "status": "optional", @@ -8985,6 +9097,7 @@ }, "EorCountryValidationsHoliday": { "docs": "Range of the number of holidays.", + "inline": true, "properties": { "min": { "docs": "Minimum number of holidays required for a legally compliant contract.", @@ -8997,6 +9110,7 @@ }, "EorCountryValidationsPartTimeHoliday": { "docs": "Holiday type and range for part-time contracts.", + "inline": true, "properties": { "min": { "docs": "Minimum number of holidays required for a legally compliant contract.", @@ -9020,6 +9134,7 @@ }, "EorCountryValidationsPartTimeProbation": { "docs": "Probation period range for part-time contracts.", + "inline": true, "properties": { "max": { "docs": "Maximum probation days allowed for a legally compliant contract.", @@ -9036,6 +9151,7 @@ }, "EorCountryValidationsProbation": { "docs": "Probation period range.", + "inline": true, "properties": { "max": { "docs": "Maximum probation days allowed for a legally compliant contract.", @@ -9052,6 +9168,7 @@ }, "EorCountryValidationsSalary": { "docs": "Salary range.", + "inline": true, "properties": { "max": { "docs": "Maximum wage allowed for a legally compliant contract.", @@ -9068,6 +9185,7 @@ }, "EorCountryValidationsSickDays": { "docs": undefined, + "inline": true, "properties": { "max": { "docs": "Maximum number of sick days allowed for a legally compliant contract.", @@ -9084,6 +9202,7 @@ }, "EorCountryValidationsWorkSchedule": { "docs": "Employee's Work schedule in days and hours.", + "inline": true, "properties": { "days": "optional", "hours": "optional", @@ -9094,6 +9213,7 @@ }, "EorCountryValidationsWorkScheduleDays": { "docs": undefined, + "inline": true, "properties": { "max": "optional", }, @@ -9103,6 +9223,7 @@ }, "EorCountryValidationsWorkScheduleHours": { "docs": undefined, + "inline": true, "properties": { "max": "optional", }, @@ -9112,6 +9233,7 @@ }, "EorEntitlementListItem": { "docs": "Entitlement Item for a given year.", + "inline": undefined, "properties": { "max_rollover_yearly": "optional", "other_leave_approved": { @@ -9179,6 +9301,7 @@ }, "EorEntitlements": { "docs": "Time-off Entitlements for EOR contracts.", + "inline": undefined, "properties": { "entitlements": { "docs": "List of entitlements.", @@ -9191,6 +9314,7 @@ }, "EorEntitlementsContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "EorEntitlements", }, @@ -9216,6 +9340,7 @@ }, "EorTimeoffsBaseItem": { "docs": undefined, + "inline": undefined, "properties": { "attachments": "optional", "date_is_half_day": { @@ -9290,6 +9415,7 @@ }, "EorTimeoffsContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "EorTimeoffs", }, @@ -9299,6 +9425,7 @@ }, "EorTimeoffsEmployeeItem": { "docs": undefined, + "inline": undefined, "properties": { "contract_id": "string", "eor_contract_id": "double", @@ -9327,6 +9454,7 @@ "extends": [ "EorTimeoffsBaseItem", ], + "inline": undefined, "properties": { "applied_changes": { "docs": "List of changes applied to the time off.", @@ -9357,6 +9485,7 @@ }, "EorTimeoffsItemContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "EorTimeoffsItem", }, @@ -9366,6 +9495,7 @@ }, "EstimateFirstPayment": { "docs": "Details of pro rata payment to create.", + "inline": undefined, "properties": { "compensation_details": "EstimateFirstPaymentCompensationDetails", "country_code": "CountryCode", @@ -9378,6 +9508,7 @@ }, "EstimateFirstPaymentCompensationDetails": { "docs": undefined, + "inline": true, "properties": { "amount": { "docs": "Amount to be paid. Must be a positive number.", @@ -9440,6 +9571,7 @@ }, "ExchangeRates": { "docs": undefined, + "inline": undefined, "properties": { "rates": "optional>", "risk": "optional", @@ -9450,6 +9582,7 @@ }, "FileAttachmentInfo": { "docs": "This object is used for linking file attachments to your records.", + "inline": undefined, "properties": { "filename": { "docs": "Original filename you used to upload using attachments end-point.", @@ -9466,6 +9599,7 @@ }, "FileObject": { "docs": "This is the file you will upload in a multi-part form.", + "inline": undefined, "properties": { "file": { "docs": "Upload the file you want to attach to this entry.", @@ -9512,6 +9646,7 @@ }, "FinalPaymentCalculated": { "docs": undefined, + "inline": undefined, "properties": { "calculation_type": { "docs": "Either works days or calendar days", @@ -9562,6 +9697,7 @@ }, "FinalPaymentCalculatedContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "FinalPaymentCalculated", }, @@ -9571,6 +9707,7 @@ }, "FinalPaymentCalculatedLastCycle": { "docs": "The last payment cycle.", + "inline": true, "properties": { "completion_date": "optional", "end": "optional", @@ -9582,6 +9719,7 @@ }, "FirstPaymentDate": { "docs": "First payment date", + "inline": undefined, "properties": { "due": "optional", }, @@ -9591,6 +9729,7 @@ }, "GenericReportReviewCreated": { "docs": undefined, + "inline": undefined, "properties": { "id": "UniqueObjectIdentifier", "public_id": "optional", @@ -9602,6 +9741,7 @@ }, "GenericReportReviewCreatedContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "GenericReportReviewCreatedList", }, @@ -9612,6 +9752,7 @@ "GenericReportReviewCreatedList": "list", "GenericResultCreated": { "docs": undefined, + "inline": undefined, "properties": { "data": "GenericResultCreatedData", }, @@ -9621,6 +9762,7 @@ }, "GenericResultCreatedData": { "docs": undefined, + "inline": true, "properties": { "created": "boolean", }, @@ -9630,6 +9772,7 @@ }, "GenericResultDeleted": { "docs": undefined, + "inline": undefined, "properties": { "data": "GenericResultDeletedData", }, @@ -9639,6 +9782,7 @@ }, "GenericResultDeletedData": { "docs": undefined, + "inline": true, "properties": { "deleted": { "docs": "Confirms the deletion.", @@ -9651,6 +9795,7 @@ }, "GenericResultUpdated": { "docs": undefined, + "inline": undefined, "properties": { "data": "GenericResultUpdatedData", }, @@ -9660,6 +9805,7 @@ }, "GenericResultUpdatedData": { "docs": undefined, + "inline": true, "properties": { "updated": "boolean", }, @@ -9669,6 +9815,7 @@ }, "HealthInsuranceProvider": { "docs": "Health insurance provider.", + "inline": undefined, "properties": { "attachments": { "docs": "File attachments.", @@ -9720,6 +9867,7 @@ }, "HealthInsuranceProviderAttachmentsItem": { "docs": undefined, + "inline": true, "properties": { "id": "optional", "label": "optional", @@ -9730,6 +9878,7 @@ }, "HealthInsuranceProviderPlansItem": { "docs": undefined, + "inline": true, "properties": { "currency": { "docs": "Insurance payment currency.", @@ -9766,6 +9915,7 @@ }, "HrisCompensation": { "docs": undefined, + "inline": undefined, "properties": { "currency": { "type": "string", @@ -9784,6 +9934,7 @@ }, "HrisContractBase": { "docs": undefined, + "inline": undefined, "properties": { "contract_oid": { "docs": "The Hris Direct employee contract ID", @@ -9802,6 +9953,7 @@ "extends": [ "HrisContractBase", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -9812,6 +9964,7 @@ "extends": [ "HrisContractBase", ], + "inline": undefined, "properties": { "part_time_percentage": { "docs": "required if employmentType is "PART_TIME"", @@ -9831,6 +9984,7 @@ }, "HrisDirectEmployee": { "docs": undefined, + "inline": undefined, "properties": { "compensation": "HrisCompensation", "contract": "HrisDirectEmployeeContract", @@ -9845,6 +9999,7 @@ }, "HrisDirectEmployeeContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "HrisDirectEmployeeResponse", }, @@ -9868,6 +10023,7 @@ }, "HrisDirectEmployeeDetails": { "docs": undefined, + "inline": undefined, "properties": { "country": { "type": "string", @@ -9941,6 +10097,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -9954,6 +10111,7 @@ "extends": [ "HrisDirectEmployee", ], + "inline": undefined, "properties": { "id": { "docs": "The Hris Direct employee ID", @@ -9966,6 +10124,7 @@ }, "HrisDirectEmployeeVacationInfo": { "docs": undefined, + "inline": true, "properties": { "vacation_accrual_start_date": { "type": "string", @@ -9993,6 +10152,7 @@ }, "HrisJobInformationBase": { "docs": undefined, + "inline": undefined, "properties": { "seniority_id": "double", }, @@ -10005,6 +10165,7 @@ "extends": [ "HrisJobInformationBase", ], + "inline": undefined, "properties": { "job_title_id": "double", }, @@ -10017,6 +10178,7 @@ "extends": [ "HrisJobInformationBase", ], + "inline": undefined, "properties": { "job_title_name": "string", }, @@ -10026,6 +10188,7 @@ }, "HrisTeamInformation": { "docs": undefined, + "inline": undefined, "properties": { "legal_entity_id": "double", "team_id": "double", @@ -10036,6 +10199,7 @@ }, "InputToDeletePgoTask": { "docs": undefined, + "inline": undefined, "properties": { "data": "PgoTaskToDelete", }, @@ -10045,6 +10209,7 @@ }, "InputToShieldContract": { "docs": undefined, + "inline": undefined, "properties": { "data": "InputToShieldContractData", }, @@ -10054,6 +10219,7 @@ }, "InputToShieldContractData": { "docs": undefined, + "inline": true, "properties": { "agreement_id": { "docs": "MSA contract id (agreement).", @@ -10066,6 +10232,7 @@ }, "InvitationsOfBasicContract": { "docs": undefined, + "inline": undefined, "properties": { "client_email": "optional", "worker_email": "optional", @@ -10076,6 +10243,7 @@ }, "Invoice": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "Billed amount.", @@ -10138,6 +10306,7 @@ "BasicInvoiceAdjustment", "InvoiceAdjustmentApproversContainer", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -10145,6 +10314,7 @@ }, "InvoiceAdjustmentApprover": { "docs": undefined, + "inline": undefined, "properties": { "approved": "boolean", "email": "string", @@ -10157,6 +10327,7 @@ "InvoiceAdjustmentApproverList": "list", "InvoiceAdjustmentApproversContainer": { "docs": undefined, + "inline": undefined, "properties": { "approvers": "InvoiceAdjustmentApproverList", }, @@ -10166,6 +10337,7 @@ }, "InvoiceAdjustmentContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "InvoiceAdjustment", }, @@ -10175,6 +10347,7 @@ }, "InvoiceAdjustmentCreated": { "docs": "Details of invoice adjustment created.", + "inline": undefined, "properties": { "created": "boolean", "created_at": "optional", @@ -10188,6 +10361,7 @@ }, "InvoiceAdjustmentCreatedContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "InvoiceAdjustmentCreated", }, @@ -10198,6 +10372,7 @@ "InvoiceAdjustmentList": "list", "InvoiceAdjustmentListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "InvoiceAdjustmentList", "page": "PageInfoWithoutCursorNew", @@ -10208,6 +10383,7 @@ }, "InvoiceAdjustmentReviewToCreate": { "docs": undefined, + "inline": undefined, "properties": { "reason": "optional", "status": "InvoiceAdjustmentReviewToCreateStatus", @@ -10227,6 +10403,7 @@ }, "InvoiceAdjustmentReviewsToCreate": { "docs": undefined, + "inline": undefined, "properties": { "ids": "TimesheetIdItems", "reason": "optional", @@ -10247,6 +10424,7 @@ }, "InvoiceAdjustmentSearchContainer": { "docs": "This is a model to make it easier to understand and restrict search parameters", + "inline": undefined, "properties": { "contract_id": "optional", "contract_types": "optional", @@ -10303,6 +10481,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -10315,6 +10494,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -10327,6 +10507,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -10342,6 +10523,7 @@ "InvoiceAdjustmentStatusEnumList": "list>", "InvoiceAdjustmentToCreate": { "docs": "Details of invoice adjustment to create.", + "inline": undefined, "properties": { "amount": { "docs": "Amount to be paid. Must be a positive number.", @@ -10379,6 +10561,7 @@ "InvoiceAdjustmentToCreate", "FileObject", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -10386,6 +10569,7 @@ }, "InvoiceAdjustmentToUpdate": { "docs": "Details of invoice adjustment to update.", + "inline": undefined, "properties": { "amount": { "type": "optional", @@ -10462,6 +10646,7 @@ }, "InvoiceContract": { "docs": undefined, + "inline": undefined, "properties": { "contract_type": { "docs": "Type of Deel contract.", @@ -10497,6 +10682,7 @@ }, "InvoiceDownloadContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "InvoiceDownloadObject", }, @@ -10506,6 +10692,7 @@ }, "InvoiceDownloadObject": { "docs": undefined, + "inline": undefined, "properties": { "expires_at": { "docs": "Expiration date time of download URL.", @@ -10527,6 +10714,7 @@ "InvoiceList": "list", "InvoiceListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "InvoiceObject", }, @@ -10536,6 +10724,7 @@ }, "InvoiceObject": { "docs": undefined, + "inline": undefined, "properties": { "rows": "optional", "total": "optional", @@ -10585,6 +10774,7 @@ }, "JobTitle": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "Unique identifier for the job title in Deel platform.", @@ -10602,6 +10792,7 @@ "JobTitleList": "list", "JobTitleListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "JobTitleList", "page": "JobTitleListContainerPage", @@ -10612,6 +10803,7 @@ }, "JobTitleListContainerPage": { "docs": undefined, + "inline": true, "properties": { "cursor": { "docs": "Use for pagination to get next set of records after the given cursor.", @@ -10626,6 +10818,7 @@ "LegalEntityList": "list", "LegalEntityListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional", }, @@ -10645,6 +10838,7 @@ }, "MetaDataOfContractToCreate": { "docs": "Additional custom info about a contract", + "inline": undefined, "properties": { "documents_required": { "docs": "Require the contractor to upload necessary compliance documents as per their country’s labor laws.", @@ -10658,6 +10852,7 @@ }, "Milestone": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "Amount to be paid for the milestone.", @@ -10699,6 +10894,7 @@ }, "MilestoneContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "Milestone", }, @@ -10709,6 +10905,7 @@ "MilestoneList": "list", "MilestoneListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "MilestoneList", }, @@ -10718,6 +10915,7 @@ }, "MilestoneProperties": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "Amount to be paid for the milestone.", @@ -10738,6 +10936,7 @@ }, "MilestoneReportedBy": { "docs": "Milestone creator.", + "inline": true, "properties": { "full_name": { "docs": "Reporter's full name.", @@ -10754,6 +10953,7 @@ }, "MilestoneReviewToCreate": { "docs": undefined, + "inline": undefined, "properties": { "reason": "optional", "status": "MilestoneReviewToCreateStatus", @@ -10773,6 +10973,7 @@ }, "MilestoneReviewedBy": { "docs": "Reviewer's information.", + "inline": true, "properties": { "full_name": { "docs": "Reviewer's full name.", @@ -10789,6 +10990,7 @@ }, "MilestoneReviewsToCreate": { "docs": undefined, + "inline": undefined, "properties": { "ids": "list", "reason": "optional", @@ -10814,6 +11016,7 @@ "MilestoneProperties", "FileObject", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -10821,6 +11024,7 @@ }, "MonthlyPayment": { "docs": "Monthly payment details for the user", + "inline": undefined, "properties": { "count": { "docs": "The number of monthly payments", @@ -10926,6 +11130,7 @@ }, "OffCyclePayment": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "Amount of off-cycle payment.", @@ -10950,6 +11155,7 @@ }, "OffCyclePaymentContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "OffCyclePayment", }, @@ -10960,6 +11166,7 @@ "OffCyclePaymentList": "list", "OffCyclePaymentListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "OffCyclePaymentList", }, @@ -10969,6 +11176,7 @@ }, "OffCyclePaymentReportedBy": { "docs": undefined, + "inline": true, "properties": { "full_name": { "docs": "Full name of the creator.", @@ -10985,6 +11193,7 @@ }, "OffCyclePaymentReviewedBy": { "docs": undefined, + "inline": true, "properties": { "full_name": { "docs": "Full name of the reviewer.", @@ -11009,6 +11218,7 @@ }, "OffCyclePaymentToCreate": { "docs": "Details of invoice adjustment to create.", + "inline": undefined, "properties": { "amount": { "docs": "Amount to be paid. Must be a positive number.", @@ -11038,6 +11248,7 @@ "OrganizationList": "list", "OrganizationListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "OrganizationList", }, @@ -11047,6 +11258,7 @@ }, "OutputToCreateFileRef": { "docs": undefined, + "inline": undefined, "properties": { "key": "string", "url": "string", @@ -11057,6 +11269,7 @@ }, "OutputToCreateFileRefContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "OutputToCreateFileRef", }, @@ -11066,6 +11279,7 @@ }, "PageInfo": { "docs": undefined, + "inline": undefined, "properties": { "cursor": "string", "total_rows": "double", @@ -11076,6 +11290,7 @@ }, "PageInfoWithoutCursor": { "docs": undefined, + "inline": undefined, "properties": { "total_rows": "double", }, @@ -11085,6 +11300,7 @@ }, "PageInfoWithoutCursorNew": { "docs": undefined, + "inline": undefined, "properties": { "items_per_page": { "type": "double", @@ -11114,6 +11330,7 @@ }, "Payment": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Timestamp when the record was created.", @@ -11143,6 +11360,7 @@ }, "PaymentBreakDown": { "docs": undefined, + "inline": undefined, "properties": { "adjustment": "optional", "approve_date": "optional", @@ -11209,6 +11427,7 @@ }, "PaymentBreakDownContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "list", }, @@ -11219,6 +11438,7 @@ "PaymentList": "list", "PaymentListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "PaymentObject", }, @@ -11228,6 +11448,7 @@ }, "PaymentMethod": { "docs": undefined, + "inline": undefined, "properties": { "type": "PaymentMethodEnum", }, @@ -11263,6 +11484,7 @@ }, "PaymentObject": { "docs": undefined, + "inline": undefined, "properties": { "rows": "optional", "total": "optional", @@ -11273,6 +11495,7 @@ }, "PaymentStatementInitiatedWebhook": { "docs": undefined, + "inline": undefined, "properties": { "billing_invoices": "list", "invoices": "list", @@ -11294,6 +11517,7 @@ "PaymentStatusEnumList": "list", "PaymentWorker": { "docs": undefined, + "inline": undefined, "properties": { "contract_id": { "docs": "The worker's Deel contract Id.", @@ -11316,6 +11540,7 @@ "PaymentWorkerList": "list", "People": { "docs": "People object representing a Deel", + "inline": undefined, "properties": { "birth_date": { "docs": "Date of birth of the user in ISO format (yyyy-mm-dd)", @@ -11456,6 +11681,7 @@ }, "PeopleClientLegalEntity": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The unique identifier for the client legal entity.", @@ -11472,6 +11698,7 @@ }, "PeopleContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "list", }, @@ -11481,6 +11708,7 @@ }, "PeopleMe": { "docs": "People object representing a Deel", + "inline": undefined, "properties": { "avatar_url": { "docs": "URL of the user's avatar", @@ -11545,6 +11773,7 @@ "PeopleMeContainer": "PeopleMe", "PeoplePayment": { "docs": undefined, + "inline": undefined, "properties": { "contract_name": { "docs": "The name of the contract associated with the payment", @@ -11569,6 +11798,7 @@ }, "PgoTask": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "Fixed rate for this task.", @@ -11592,6 +11822,7 @@ }, "PgoTaskReviewsByIdToCreate": { "docs": undefined, + "inline": undefined, "properties": { "reason": { "docs": "Review comments.", @@ -11618,6 +11849,7 @@ }, "PgoTaskReviewsToCreate": { "docs": undefined, + "inline": undefined, "properties": { "ids": "list", "reason": { @@ -11645,6 +11877,7 @@ }, "PgoTaskToCreate": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "Fixed rate for this task.", @@ -11669,6 +11902,7 @@ }, "PgoTaskToDelete": { "docs": undefined, + "inline": undefined, "properties": { "delete_recurring_report": { "docs": "Request to delete recurring report.", @@ -11685,6 +11919,7 @@ }, "PremiumResultAdded": { "docs": undefined, + "inline": undefined, "properties": { "calculated_premium": { "docs": "Cost for Deel Premium.", @@ -11704,6 +11939,7 @@ }, "PremiumResultAddedContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "PremiumResultAdded", }, @@ -11713,6 +11949,7 @@ }, "PremiumResultAddedMisclassificationGuarantee": { "docs": undefined, + "inline": true, "properties": { "description": { "docs": "Cover your legal defense costs.", @@ -11729,6 +11966,7 @@ }, "PremiumResultAddedPenalties": { "docs": undefined, + "inline": true, "properties": { "description": { "docs": "Get indemnity against tax authority penalties, liabilities and fines.", @@ -11745,6 +11983,7 @@ }, "PremiumResultAddedThirdPartyLiabilities": { "docs": undefined, + "inline": true, "properties": { "description": { "docs": "Get indemnity against third parties up to $10k depending on the court's decision.", @@ -11761,6 +12000,7 @@ }, "PremiumToAdd": { "docs": undefined, + "inline": undefined, "properties": { "agreement_reflects_relation": { "docs": "Is the Contractor Agreement selected on the Deel Platform perfectly reflecting your organizations relation and actual working practices with the contractor?", @@ -11777,6 +12017,7 @@ }, "ProRata": { "docs": "Details of the pro rata for the first payment", + "inline": undefined, "properties": { "calculation_type": { "docs": "Either works days or calendar days", @@ -11866,6 +12107,7 @@ }, "ResponseEstimateFirstPayment": { "docs": undefined, + "inline": undefined, "properties": { "first_payment_dates": "optional>", "pro_rata": "optional", @@ -11876,6 +12118,7 @@ }, "ResponseEstimateFirstPaymentContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "ResponseEstimateFirstPayment", }, @@ -11885,6 +12128,7 @@ }, "Seniority": { "docs": "Seniority describes level of expertise at a job e.g. junior", + "inline": undefined, "properties": { "id": { "docs": "Unique identifier for seniority record", @@ -11912,6 +12156,7 @@ "SeniorityList": "list", "SeniorityListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "SeniorityList", }, @@ -11921,6 +12166,7 @@ }, "SeniorityRequired": { "docs": "Seniority describes level of expertise at a job e.g. junior", + "inline": undefined, "properties": { "id": { "docs": "Unique identifier for seniority record.", @@ -11947,6 +12193,7 @@ }, "SignaturesOfBasicContract": { "docs": undefined, + "inline": undefined, "properties": { "client_signed_at": "optional", "worker_signature": { @@ -11961,6 +12208,7 @@ }, "SignaturesOfContract": { "docs": undefined, + "inline": undefined, "properties": { "client_signature": { "docs": "normally name of client is used as signature", @@ -11989,6 +12237,7 @@ }, "StateOfCountry": { "docs": "It may be called states, provinces, prefectures or regions, or none at all", + "inline": undefined, "properties": { "code": { "docs": "Territory code.", @@ -12018,6 +12267,7 @@ "TaskList": "list", "TaskListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "TaskList", }, @@ -12027,6 +12277,7 @@ }, "Team": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The unique identifier for the team.", @@ -12044,6 +12295,7 @@ "TeamList": "list", "TeamListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "TeamList", }, @@ -12053,6 +12305,7 @@ }, "TeamOfBasicContract": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "Unique reference of a team", @@ -12069,6 +12322,7 @@ }, "TeamOfContract": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "Unique reference of a team", @@ -12085,6 +12339,7 @@ }, "TimeoffReview": { "docs": undefined, + "inline": undefined, "properties": { "denial_reason": { "docs": "Denial reason for the time off requested.", @@ -12102,6 +12357,7 @@ "TimeoffTypeList": "list", "TimeoffTypeListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "TimeoffTypeList", }, @@ -12115,6 +12371,7 @@ }, "TimeoffsAttachmentsItem": { "docs": "A item in attachments array. 2022-09-08 FE only allows for "SICK LEAVE"", + "inline": undefined, "properties": { "file_extension": { "docs": "The file name extension", @@ -12132,6 +12389,7 @@ }, "TimeoffsProfile": { "docs": undefined, + "inline": undefined, "properties": { "id": "double", "is_employee": { @@ -12175,6 +12433,7 @@ "BasicTimesheet", "TimesheetApproversContainer", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -12183,6 +12442,7 @@ "TimesheetAccountingRefs": "optional>", "TimesheetAccountingRefsItem": { "docs": undefined, + "inline": undefined, "properties": { "integration": "string", "mapping_category": "optional", @@ -12193,6 +12453,7 @@ }, "TimesheetAccountingRefsItemMappingCategory": { "docs": undefined, + "inline": true, "properties": { "id": "string", "name": "string", @@ -12203,6 +12464,7 @@ }, "TimesheetApprover": { "docs": undefined, + "inline": undefined, "properties": { "approved": "boolean", "email": "string", @@ -12215,6 +12477,7 @@ "TimesheetApproverList": "list", "TimesheetApproversContainer": { "docs": undefined, + "inline": undefined, "properties": { "approvers": "TimesheetApproverList", }, @@ -12224,6 +12487,7 @@ }, "TimesheetContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "Timesheet", }, @@ -12236,6 +12500,7 @@ "discriminated": false, "docs": "ID of an existing timesheet record", "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -12247,6 +12512,7 @@ "TimesheetList": "list", "TimesheetListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "TimesheetList", "page": "PageInfoWithoutCursor", @@ -12257,6 +12523,7 @@ }, "TimesheetReviewToCreate": { "docs": undefined, + "inline": undefined, "properties": { "reason": "optional", "status": "TimesheetReviewToCreateStatus", @@ -12276,6 +12543,7 @@ }, "TimesheetReviewsToCreate": { "docs": undefined, + "inline": undefined, "properties": { "ids": "TimesheetIdItems", "reason": "optional", @@ -12296,6 +12564,7 @@ }, "TimesheetSearchContainer": { "docs": "This is a model to make it easier to understand and restrict search parameters", + "inline": undefined, "properties": { "contract_id": "optional", "contract_types": "optional", @@ -12352,6 +12621,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -12364,6 +12634,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -12376,6 +12647,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -12386,6 +12658,7 @@ }, "TimesheetSharedProperties": { "docs": "Details of timesheet to create; a client, contractor or EOR may create a timesheet", + "inline": undefined, "properties": { "contract_id": { "docs": "Id of a Deel contract.", @@ -12418,6 +12691,7 @@ "TimesheetSharedProperties", "FileObject", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -12425,6 +12699,7 @@ }, "TimesheetToUpdate": { "docs": "Details of timesheet to create; a client, contractor or EOR may update a timesheet", + "inline": undefined, "properties": { "description": "string", "quantity": "double", @@ -12442,6 +12717,7 @@ "discriminated": false, "docs": "Unique identifier of this resource.", "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -12470,6 +12746,7 @@ }, "WebhookItem": { "docs": undefined, + "inline": undefined, "properties": { "api_version": { "default": "v1", @@ -12523,6 +12800,7 @@ }, "WebhookItemResponse": { "docs": undefined, + "inline": undefined, "properties": { "data": "WebhookItem", }, @@ -12542,6 +12820,7 @@ }, "WebhookListResponse": { "docs": undefined, + "inline": undefined, "properties": { "data": "list", }, @@ -12644,6 +12923,7 @@ }, "WorkerLegalEntity": { "docs": undefined, + "inline": undefined, "properties": { "personal_name": "string", "registration_number": "string", @@ -12655,6 +12935,7 @@ }, "WorkerOfBasicContract": { "docs": undefined, + "inline": undefined, "properties": { "alternate_email": "optional", "email": "optional", @@ -12676,6 +12957,7 @@ }, "WorkerOfContract": { "docs": undefined, + "inline": undefined, "properties": { "alternate_email": "optional", "date_of_birth": "optional", @@ -12868,6 +13150,7 @@ - ContractTypeEnumList source: openapi: ../openapi.yml + inline: true ContractSearchFormWithoutCursorStatuses: discriminated: false union: @@ -12875,6 +13158,7 @@ - ContractStatusEnum source: openapi: ../openapi.yml + inline: true ContractSearchFormWithoutCursorCountries: discriminated: false union: @@ -12882,6 +13166,7 @@ - CountryCode source: openapi: ../openapi.yml + inline: true ContractSearchFormWithoutCursorCurrencies: discriminated: false union: @@ -12889,6 +13174,7 @@ - CurrencyCodeRequired source: openapi: ../openapi.yml + inline: true ContractSearchFormWithoutCursor: docs: >- This is a model to make it easier to understand and restrict search @@ -13295,6 +13581,7 @@ scale: WorkStatementScaleEnum source: openapi: ../openapi.yml + inline: true ContractToCreatePayAsYouGoTimeBased: properties: type: literal<"pay_as_you_go_time_based"> @@ -13355,6 +13642,7 @@ scale: WorkStatementScaleEnum source: openapi: ../openapi.yml + inline: true ContractToCreateOngoingTimeBased: properties: type: literal<"ongoing_time_based"> @@ -13371,6 +13659,7 @@ id: double source: openapi: ../openapi.yml + inline: true ContractToCreateSharedClientTeam: docs: >- Choose the Deel team for this contract. Use teams endpoint to retrieve a @@ -13379,6 +13668,7 @@ id: double source: openapi: ../openapi.yml + inline: true ContractToCreateSharedClient: properties: legal_entity: @@ -13393,6 +13683,7 @@ a list of teams in your organization. source: openapi: ../openapi.yml + inline: true ContractToCreateSharedJobTitle: docs: >- Worker's job title. You can enter a custom job title or use a pre-defiled @@ -13408,6 +13699,7 @@ maxLength: 255 source: openapi: ../openapi.yml + inline: true ContractToCreateSharedSeniority: docs: >- Job seniority level. Please use the seniority levels endpoint to retrieve @@ -13416,6 +13708,7 @@ id: optional source: openapi: ../openapi.yml + inline: true ContractToCreateSharedWorker: docs: Worker properties properties: @@ -13432,6 +13725,7 @@ maxLength: 255 source: openapi: ../openapi.yml + inline: true ContractToCreateShared: docs: Details of contract to create properties: @@ -13699,6 +13993,7 @@ min: 0 source: openapi: ../openapi.yml + inline: true BasicTimesheetReviewedBy: properties: id: double @@ -13707,6 +14002,7 @@ remarks: string source: openapi: ../openapi.yml + inline: true BasicTimesheetContract: properties: id: string @@ -13714,18 +14010,21 @@ type: ContractTypeEnum source: openapi: ../openapi.yml + inline: true BasicTimesheetPaymentCycle: properties: start_date: optional end_date: optional source: openapi: ../openapi.yml + inline: true BasicTimesheetReportedBy: properties: id: double full_name: string source: openapi: ../openapi.yml + inline: true BasicTimesheet: properties: id: UniqueObjectIdentifier @@ -13896,6 +14195,7 @@ - ContractTypeEnum source: openapi: ../openapi.yml + inline: true TimesheetSearchContainerTypes: discriminated: false union: @@ -13903,6 +14203,7 @@ - TimesheetTypeEnum source: openapi: ../openapi.yml + inline: true TimesheetSearchContainerStatuses: discriminated: false union: @@ -13910,6 +14211,7 @@ - optional source: openapi: ../openapi.yml + inline: true TimesheetSearchContainer: docs: >- This is a model to make it easier to understand and restrict search @@ -13953,6 +14255,7 @@ name: string source: openapi: ../openapi.yml + inline: true TimesheetAccountingRefsItem: properties: integration: string @@ -13967,6 +14270,7 @@ - ContractTypeEnum source: openapi: ../openapi.yml + inline: true InvoiceAdjustmentSearchContainerTypes: discriminated: false union: @@ -13974,6 +14278,7 @@ - InvoiceAdjustmentTypeEnum source: openapi: ../openapi.yml + inline: true InvoiceAdjustmentSearchContainerStatuses: discriminated: false union: @@ -13981,6 +14286,7 @@ - optional source: openapi: ../openapi.yml + inline: true InvoiceAdjustmentSearchContainer: docs: >- This is a model to make it easier to understand and restrict search @@ -14045,6 +14351,7 @@ min: 0 source: openapi: ../openapi.yml + inline: true BasicInvoiceAdjustmentReviewedBy: properties: id: double @@ -14053,6 +14360,7 @@ remarks: string source: openapi: ../openapi.yml + inline: true BasicInvoiceAdjustmentContract: properties: id: string @@ -14060,18 +14368,21 @@ type: ContractTypeEnum source: openapi: ../openapi.yml + inline: true BasicInvoiceAdjustmentPaymentCycle: properties: start_date: optional end_date: optional source: openapi: ../openapi.yml + inline: true BasicInvoiceAdjustmentReportedBy: properties: id: double full_name: string source: openapi: ../openapi.yml + inline: true BasicInvoiceAdjustment: properties: id: UniqueObjectIdentifier @@ -14211,6 +14522,7 @@ created: boolean source: openapi: ../openapi.yml + inline: true GenericResultCreated: properties: data: GenericResultCreatedData @@ -14227,6 +14539,7 @@ updated: boolean source: openapi: ../openapi.yml + inline: true GenericResultUpdated: properties: data: GenericResultUpdatedData @@ -14239,6 +14552,7 @@ docs: Confirms the deletion. source: openapi: ../openapi.yml + inline: true GenericResultDeleted: properties: data: GenericResultDeletedData @@ -14503,6 +14817,7 @@ docs: Use for pagination to get next set of records after the given cursor. source: openapi: ../openapi.yml + inline: true JobTitleListContainer: properties: data: JobTitleList @@ -14727,6 +15042,7 @@ docs: Reviewer's full name. source: openapi: ../openapi.yml + inline: true MilestoneReportedBy: docs: Milestone creator. properties: @@ -14738,6 +15054,7 @@ docs: Reporter's full name. source: openapi: ../openapi.yml + inline: true Milestone: properties: id: @@ -14851,6 +15168,7 @@ work_week_end: optional source: openapi: ../openapi.yml + inline: true EstimateFirstPayment: docs: Details of pro rata payment to create. properties: @@ -14929,6 +15247,7 @@ docs: Remarks made during review process. source: openapi: ../openapi.yml + inline: true OffCyclePaymentReportedBy: properties: id: @@ -14939,6 +15258,7 @@ docs: Full name of the creator. source: openapi: ../openapi.yml + inline: true OffCyclePayment: properties: id: UniqueObjectIdentifier @@ -15097,18 +15417,21 @@ title: string source: openapi: ../openapi.yml + inline: true AgreementClientLegalEntity: properties: id: double name: string source: openapi: ../openapi.yml + inline: true AgreementProviderLegalEntity: properties: id: double name: string source: openapi: ../openapi.yml + inline: true Agreement: properties: id: double @@ -15126,6 +15449,7 @@ docs: MSA contract id (agreement). source: openapi: ../openapi.yml + inline: true InputToShieldContract: properties: data: InputToShieldContractData @@ -15188,6 +15512,7 @@ completion_date: optional source: openapi: ../openapi.yml + inline: true FinalPaymentCalculatedCalculationType: enum: - CUSTOM_AMOUNT @@ -15234,6 +15559,7 @@ docs: Cover your legal defense costs. source: openapi: ../openapi.yml + inline: true PremiumResultAddedPenalties: properties: name: @@ -15244,6 +15570,7 @@ docs: Get indemnity against tax authority penalties, liabilities and fines. source: openapi: ../openapi.yml + inline: true PremiumResultAddedThirdPartyLiabilities: properties: name: @@ -15256,6 +15583,7 @@ court's decision. source: openapi: ../openapi.yml + inline: true PremiumResultAdded: properties: id: @@ -15421,6 +15749,7 @@ country: optional source: openapi: ../openapi.yml + inline: true EorContractToCreateEmployee: properties: first_name: @@ -15438,6 +15767,7 @@ address: optional source: openapi: ../openapi.yml + inline: true EorContractToCreateEmploymentType: enum: - value: Full-time @@ -15493,6 +15823,7 @@ chooseing "STANDARD" time_off_type. source: openapi: ../openapi.yml + inline: true EorContractToCreateSeniority: properties: id: @@ -15502,6 +15833,7 @@ for "Not Applicable". source: openapi: ../openapi.yml + inline: true EorContractToCreateClientLegalEntity: properties: id: @@ -15512,6 +15844,7 @@ your organization. source: openapi: ../openapi.yml + inline: true EorContractToCreateClientTeam: properties: id: @@ -15521,12 +15854,14 @@ to retrieve a list of teams in your organization. source: openapi: ../openapi.yml + inline: true EorContractToCreateClient: properties: legal_entity: optional team: optional source: openapi: ../openapi.yml + inline: true EorContractToCreateCompensationDetails: properties: salary: @@ -15547,6 +15882,7 @@ PERCENTAGE or FIXED. source: openapi: ../openapi.yml + inline: true EorContractToCreateQuoteAdditionalFieldsWorkerType: enum: - Skilled @@ -15570,6 +15906,7 @@ docs: Employee's date of birth. source: openapi: ../openapi.yml + inline: true EorContractToCreate: properties: employee: optional @@ -15624,6 +15961,7 @@ docs: Number of calculate holidays for this contract. source: openapi: ../openapi.yml + inline: true EorContractCreatedClientLegalEntity: properties: name: @@ -15631,11 +15969,13 @@ docs: Legal entity name. source: openapi: ../openapi.yml + inline: true EorContractCreatedClient: properties: legal_entity: optional source: openapi: ../openapi.yml + inline: true EorContractCreatedCompensationDetails: properties: salary: @@ -15652,6 +15992,7 @@ docs: Type fo variable compensation. source: openapi: ../openapi.yml + inline: true EorContractCreatedEmployee: properties: legal_name: @@ -15668,6 +16009,7 @@ docs: Employee's email. source: openapi: ../openapi.yml + inline: true EorContractCreatedHealthPlan: properties: id: @@ -15678,6 +16020,7 @@ docs: Health plan name source: openapi: ../openapi.yml + inline: true EorContractCreated: properties: id: @@ -15705,6 +16048,7 @@ docs: Minimum number of holidays required for a legally compliant contract. source: openapi: ../openapi.yml + inline: true EorCountryValidationsPartTimeHolidayType: enum: - PRORATED @@ -15721,6 +16065,7 @@ docs: Minimum number of holidays required for a legally compliant contract. source: openapi: ../openapi.yml + inline: true EorCountryValidationsSickDays: properties: min: @@ -15731,6 +16076,7 @@ docs: Maximum number of sick days allowed for a legally compliant contract. source: openapi: ../openapi.yml + inline: true EorCountryValidationsSalary: docs: Salary range. properties: @@ -15742,6 +16088,7 @@ docs: Maximum wage allowed for a legally compliant contract. source: openapi: ../openapi.yml + inline: true EorCountryValidationsProbation: docs: Probation period range. properties: @@ -15753,6 +16100,7 @@ docs: Maximum probation days allowed for a legally compliant contract. source: openapi: ../openapi.yml + inline: true EorCountryValidationsPartTimeProbation: docs: Probation period range for part-time contracts. properties: @@ -15764,16 +16112,19 @@ docs: Maximum probation days allowed for a legally compliant contract. source: openapi: ../openapi.yml + inline: true EorCountryValidationsWorkScheduleDays: properties: max: optional source: openapi: ../openapi.yml + inline: true EorCountryValidationsWorkScheduleHours: properties: max: optional source: openapi: ../openapi.yml + inline: true EorCountryValidationsWorkSchedule: docs: Employee's Work schedule in days and hours. properties: @@ -15781,6 +16132,7 @@ hours: optional source: openapi: ../openapi.yml + inline: true EorCountryValidationsDefiniteContractType: enum: - ALLOWED_WITHOUT_LIMITATION @@ -15795,12 +16147,14 @@ maximum_limitation: optional source: openapi: ../openapi.yml + inline: true EorCountryValidationsHealthInsurance: properties: status: optional providers: optional> source: openapi: ../openapi.yml + inline: true EorCountryValidations: properties: holiday: @@ -15852,6 +16206,7 @@ label: optional source: openapi: ../openapi.yml + inline: true HealthInsuranceProviderPlansItem: properties: id: @@ -15869,6 +16224,7 @@ is_enabled: optional source: openapi: ../openapi.yml + inline: true HealthInsuranceProvider: docs: Health insurance provider. properties: @@ -16186,17 +16542,20 @@ contract_name: optional source: openapi: ../openapi.yml + inline: true EmployeeListClientLegalEntity: properties: id: optional name: optional source: openapi: ../openapi.yml + inline: true EmployeeListMonthlyPayment: properties: count: optional source: openapi: ../openapi.yml + inline: true EmployeeList: properties: id: optional @@ -16598,6 +16957,7 @@ - HrisJobInformationTitleName source: openapi: ../openapi.yml + inline: true HrisDirectEmployeeContract: discriminant: employment_type base-properties: {} @@ -16619,6 +16979,7 @@ max: 365 source: openapi: ../openapi.yml + inline: true HrisDirectEmployee: properties: employee_details: HrisDirectEmployeeDetails @@ -20854,6 +21215,7 @@ docs: End-points to retrieve paid invoices and reciepts. "types": { "InputToCreateFileRefData": { "docs": undefined, + "inline": true, "properties": { "content_type": "root.FileRefTypeEnum", }, @@ -20871,6 +21233,7 @@ types: content_type: root.FileRefTypeEnum source: openapi: ../openapi.yml + inline: true service: auth: false base-path: '' diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/default-content.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/default-content.json index 1954cba0fbe..4368af83af9 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/default-content.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/default-content.json @@ -8,6 +8,7 @@ "types": { "GenerateContentResponse": { "docs": undefined, + "inline": undefined, "properties": { "bar": "optional", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/devrev.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/devrev.json index a6f53eb9b5e..76ca63cecdd 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/devrev.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/devrev.json @@ -3661,6 +3661,7 @@ }, "ArtifactsLocateResponse": { "docs": "The response to getting an artifact's download URL.", + "inline": undefined, "properties": { "expires_at": { "docs": "The expiration timestamp of the URL.", @@ -3677,6 +3678,7 @@ }, "ArtifactsPrepareResponse": { "docs": "The response to preparing a URL to upload a file.", + "inline": undefined, "properties": { "form_data": { "docs": "The POST policy form data.", @@ -3697,6 +3699,7 @@ }, "ArtifactsPrepareResponseFormData": { "docs": undefined, + "inline": undefined, "properties": { "key": { "docs": "Key of the form field.", @@ -3713,6 +3716,7 @@ }, "AtomBase": { "docs": undefined, + "inline": undefined, "properties": { "created_by": { "type": "optional", @@ -3743,6 +3747,7 @@ }, "AtomBaseSummary": { "docs": undefined, + "inline": undefined, "properties": { "display_id": { "docs": "Human-readable object ID unique to the Dev organization.", @@ -3810,6 +3815,7 @@ authentication connection that is set up for a Dev organization. "docs": "Object encapsulating the configuration parameters for an Azure AD authentication connection. ", + "inline": undefined, "properties": { "client_id": { "docs": "Client ID for the Azure authentication connection.", @@ -3832,6 +3838,7 @@ authentication connection. "docs": "Object encapsulating the configuration parameters for a Google Apps authentication connection. ", + "inline": undefined, "properties": { "client_id": { "docs": "Client ID for the Google Apps authentication connection.", @@ -3856,6 +3863,7 @@ authentication connection. "docs": "Object encapsulating the configuration parameters for an OIDC authentication connection. ", + "inline": undefined, "properties": { "client_id": { "docs": "Client ID for the OIDC authentication connection.", @@ -3878,6 +3886,7 @@ authentication connection. "docs": "Object encapsulating the configuration parameters for a SAML authentication connection. ", + "inline": undefined, "properties": { "sign_in_endpoint": { "docs": "Sign In endpoint for the SAML authentication connection.", @@ -3925,6 +3934,7 @@ for each authentication connection will depend on the type value. "extends": [ "AtomBase", ], + "inline": undefined, "properties": { "client_id": { "docs": "An identifier that represents the application that requested the @@ -4075,6 +4085,7 @@ token. Only applicable for application access tokens. "docs": "Response for the request to create a new token corresponding to the requested token type. ", + "inline": undefined, "properties": { "access_token": { "docs": "The issued JSON Web Token (JWT) corresponding to the requested @@ -4113,6 +4124,7 @@ of values in which the order of values does not matter. }, "AuthTokensGetResponse": { "docs": "The response to get the token metadata.", + "inline": undefined, "properties": { "token": { "type": "AuthToken", @@ -4124,6 +4136,7 @@ of values in which the order of values does not matter. }, "AuthTokensListResponse": { "docs": "The response to list the token metadata.", + "inline": undefined, "properties": { "tokens": { "docs": "The list of token metadata.", @@ -4136,6 +4149,7 @@ of values in which the order of values does not matter. }, "AuthTokensOrgTraits": { "docs": "Carries Rev org info.", + "inline": undefined, "properties": { "display_name": { "docs": "The display name of the Rev org.", @@ -4154,6 +4168,7 @@ of values in which the order of values does not matter. "docs": "Carries info corresponding to the Rev user to be provisioned and/or issue a Rev session token. ", + "inline": undefined, "properties": { "org_ref": { "docs": "An identifier which uniquely identifies a Rev org.", @@ -4180,6 +4195,7 @@ issue a Rev session token. }, "AuthTokensUpdateResponse": { "docs": "Response for the request to update the token metadata.", + "inline": undefined, "properties": { "token": { "type": "AuthToken", @@ -4191,6 +4207,7 @@ issue a Rev session token. }, "AuthTokensUserTraits": { "docs": "Carries Rev user info.", + "inline": undefined, "properties": { "display_name": { "docs": "The display name of the Rev user.", @@ -4267,6 +4284,7 @@ authentication connections have different configuration parameters. "docs": "Response for the request to create a new enterprise authentication connection. ", + "inline": undefined, "properties": { "auth_connection": { "type": "AuthConnection", @@ -4280,6 +4298,7 @@ connection. "docs": "Response object encapsulating the configuration details of an authentication connection. ", + "inline": undefined, "properties": { "auth_connection": { "type": "AuthConnection", @@ -4293,6 +4312,7 @@ authentication connection. "docs": "Response object for the request to list all the social and enterprise authentication connections configured for a Dev organization. ", + "inline": undefined, "properties": { "auth_connections": { "docs": "List of all the authentication connections currently configured for @@ -4368,6 +4388,7 @@ that can be updated. "docs": "Response for the request to update an enterprise authentication connection. ", + "inline": undefined, "properties": { "auth_connection": { "type": "AuthConnection", @@ -4382,6 +4403,7 @@ connection. "extends": [ "UserBase", ], + "inline": undefined, "properties": { "external_identities": { "docs": "IDs of the Dev User outside the DevRev SOR.", @@ -4397,6 +4419,7 @@ connection. }, "DevUsersListResponse": { "docs": "The response to listing the Dev users.", + "inline": undefined, "properties": { "dev_users": { "docs": "The list of Dev users.", @@ -4422,6 +4445,7 @@ sort order. If not set, then no prior elements exist. "DevUsersSelfResponse": { "docs": "The response to getting the information for the authenticated user. ", + "inline": undefined, "properties": { "dev_user": { "type": "DevUser", @@ -4439,6 +4463,7 @@ sort order. If not set, then no prior elements exist. "extends": [ "ErrorBase", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4449,6 +4474,7 @@ sort order. If not set, then no prior elements exist. }, "ErrorBadRequestInvalidEnumValue": { "docs": undefined, + "inline": undefined, "properties": { "allowed_values": { "docs": "The allowed values for the field.", @@ -4469,6 +4495,7 @@ sort order. If not set, then no prior elements exist. }, "ErrorBadRequestMissingRequiredField": { "docs": undefined, + "inline": undefined, "properties": { "field_name": { "docs": "The missing field's name.", @@ -4496,6 +4523,7 @@ sort order. If not set, then no prior elements exist. }, "ErrorBadRequestValueNotPermitted": { "docs": undefined, + "inline": undefined, "properties": { "field_name": { "docs": "The field whose value is not permitted.", @@ -4512,6 +4540,7 @@ sort order. If not set, then no prior elements exist. }, "ErrorBase": { "docs": undefined, + "inline": undefined, "properties": { "message": { "docs": "The message associated with the error.", @@ -4527,6 +4556,7 @@ sort order. If not set, then no prior elements exist. "extends": [ "ErrorBase", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4541,6 +4571,7 @@ sort order. If not set, then no prior elements exist. "extends": [ "ErrorBase", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4555,6 +4586,7 @@ sort order. If not set, then no prior elements exist. "extends": [ "ErrorBase", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4569,6 +4601,7 @@ sort order. If not set, then no prior elements exist. "extends": [ "ErrorBase", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4583,6 +4616,7 @@ sort order. If not set, then no prior elements exist. "extends": [ "ErrorBase", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4597,6 +4631,7 @@ sort order. If not set, then no prior elements exist. "extends": [ "ErrorBase", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4608,6 +4643,7 @@ sort order. If not set, then no prior elements exist. }, "EventPartCreated": { "docs": undefined, + "inline": undefined, "properties": { "part": { "type": "part", @@ -4619,6 +4655,7 @@ sort order. If not set, then no prior elements exist. }, "EventPartDeleted": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the part that was deleted.", @@ -4631,6 +4668,7 @@ sort order. If not set, then no prior elements exist. }, "EventPartUpdated": { "docs": undefined, + "inline": undefined, "properties": { "part": { "type": "part", @@ -4642,6 +4680,7 @@ sort order. If not set, then no prior elements exist. }, "EventRevOrgCreated": { "docs": undefined, + "inline": undefined, "properties": { "rev_org": { "type": "RevOrg", @@ -4653,6 +4692,7 @@ sort order. If not set, then no prior elements exist. }, "EventRevOrgDeleted": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the Rev organization that was deleted.", @@ -4665,6 +4705,7 @@ sort order. If not set, then no prior elements exist. }, "EventRevOrgUpdated": { "docs": undefined, + "inline": undefined, "properties": { "rev_org": { "type": "RevOrg", @@ -4676,6 +4717,7 @@ sort order. If not set, then no prior elements exist. }, "EventTagCreated": { "docs": undefined, + "inline": undefined, "properties": { "tag": { "type": "tag", @@ -4687,6 +4729,7 @@ sort order. If not set, then no prior elements exist. }, "EventTagDeleted": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the tag that was deleted.", @@ -4699,6 +4742,7 @@ sort order. If not set, then no prior elements exist. }, "EventTagUpdated": { "docs": undefined, + "inline": undefined, "properties": { "tag": { "type": "tag", @@ -4710,6 +4754,7 @@ sort order. If not set, then no prior elements exist. }, "EventTimelineEntryCreated": { "docs": undefined, + "inline": undefined, "properties": { "entry": { "type": "TimelineEntry", @@ -4721,6 +4766,7 @@ sort order. If not set, then no prior elements exist. }, "EventTimelineEntryDeleted": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the timeline entry that was deleted.", @@ -4733,6 +4779,7 @@ sort order. If not set, then no prior elements exist. }, "EventTimelineEntryUpdated": { "docs": undefined, + "inline": undefined, "properties": { "entry": { "type": "TimelineEntry", @@ -4744,6 +4791,7 @@ sort order. If not set, then no prior elements exist. }, "EventWebhookCreated": { "docs": undefined, + "inline": undefined, "properties": { "webhook": { "type": "webhook", @@ -4755,6 +4803,7 @@ sort order. If not set, then no prior elements exist. }, "EventWebhookDeleted": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the webhook that was deleted.", @@ -4767,6 +4816,7 @@ sort order. If not set, then no prior elements exist. }, "EventWebhookUpdated": { "docs": undefined, + "inline": undefined, "properties": { "webhook": { "type": "webhook", @@ -4778,6 +4828,7 @@ sort order. If not set, then no prior elements exist. }, "EventWorkCreated": { "docs": undefined, + "inline": undefined, "properties": { "work": { "type": "work", @@ -4789,6 +4840,7 @@ sort order. If not set, then no prior elements exist. }, "EventWorkDeleted": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the work that was deleted.", @@ -4801,6 +4853,7 @@ sort order. If not set, then no prior elements exist. }, "EventWorkUpdated": { "docs": undefined, + "inline": undefined, "properties": { "work": { "type": "work", @@ -4855,6 +4908,7 @@ always be returned in the specified sort-by order. "extends": [ "AtomBase", ], + "inline": undefined, "properties": { "display_name": { "docs": "Name of the Organization.", @@ -4870,6 +4924,7 @@ always be returned in the specified sort-by order. "extends": [ "AtomBaseSummary", ], + "inline": undefined, "properties": { "display_name": { "docs": "Name of the Organization.", @@ -4911,6 +4966,7 @@ always be returned in the specified sort-by order. "extends": [ "AtomBase", ], + "inline": undefined, "properties": { "artifacts": { "docs": "The attached artifacts.", @@ -4942,6 +4998,7 @@ always be returned in the specified sort-by order. "extends": [ "AtomBaseSummary", ], + "inline": undefined, "properties": { "name": { "docs": "Name of the part.", @@ -5018,6 +5075,7 @@ always be returned in the specified sort-by order. }, "PartsCreateRequestCapability": { "docs": undefined, + "inline": undefined, "properties": { "parent_part": { "docs": "ID of the parent product for the capability.", @@ -5030,6 +5088,7 @@ always be returned in the specified sort-by order. }, "PartsCreateRequestEnhancement": { "docs": undefined, + "inline": undefined, "properties": { "parent_part": { "docs": "ID of the parent part on which the enhancement is to be created. @@ -5048,6 +5107,7 @@ always be returned in the specified sort-by order. }, "PartsCreateRequestFeature": { "docs": undefined, + "inline": undefined, "properties": { "parent_part": { "docs": "ID of the parent capability/feature for the feature.", @@ -5063,6 +5123,7 @@ always be returned in the specified sort-by order. }, "PartsCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "part": { "type": "part", @@ -5077,6 +5138,7 @@ always be returned in the specified sort-by order. }, "PartsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "part": { "type": "part", @@ -5088,6 +5150,7 @@ always be returned in the specified sort-by order. }, "PartsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "next_cursor": { "docs": "The cursor used to iterate subsequent results in accordance to the @@ -5156,6 +5219,7 @@ sort order. If not set, then no prior elements exist. }, "PartsUpdateRequestEnhancement": { "docs": undefined, + "inline": undefined, "properties": { "target_close_date": { "docs": "Updates the target close date of the enhancement.", @@ -5171,6 +5235,7 @@ sort order. If not set, then no prior elements exist. }, "PartsUpdateRequestOwnedBy": { "docs": undefined, + "inline": undefined, "properties": { "set": { "docs": "Sets the owner IDs to the provided user IDs. This must not be @@ -5188,6 +5253,7 @@ empty. }, "PartsUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "part": { "type": "part", @@ -5208,6 +5274,7 @@ empty. "extends": [ "OrgBase", ], + "inline": undefined, "properties": { "description": { "docs": "Description of the Rev organization.", @@ -5236,6 +5303,7 @@ organization. "RevOrgsCreateResponse": { "docs": "Response object for request to create a new Rev organization. ", + "inline": undefined, "properties": { "rev_org": { "type": "RevOrg", @@ -5251,6 +5319,7 @@ organization. }, "RevOrgsGetResponse": { "docs": "The response to getting a Rev organization's information.", + "inline": undefined, "properties": { "rev_org": { "type": "RevOrg", @@ -5263,6 +5332,7 @@ organization. "RevOrgsListResponse": { "docs": "The response to getting a list of Rev organizations' information. ", + "inline": undefined, "properties": { "next_cursor": { "docs": "The cursor used to iterate subsequent results in accordance to the @@ -5287,6 +5357,7 @@ sort order. If not set, then no prior elements exist. }, "RevOrgsUpdateResponse": { "docs": "Response object to updating Rev organization's information.", + "inline": undefined, "properties": { "rev_org": { "type": "RevOrg", @@ -5301,6 +5372,7 @@ sort order. If not set, then no prior elements exist. "extends": [ "UserBaseSummary", ], + "inline": undefined, "properties": { "external_ref": { "docs": "External ref is a mutable unique identifier for a user within the @@ -5319,6 +5391,7 @@ system-generated identifier will be assigned to the user. }, "SetTagWithValue": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the tag.", @@ -5337,6 +5410,7 @@ the value must be one that's specified in the tag's allowed values. }, "StageInit": { "docs": "Sets an object's initial stage.", + "inline": undefined, "properties": { "name": { "docs": "The name of the stage.", @@ -5349,6 +5423,7 @@ the value must be one that's specified in the tag's allowed values. }, "StageUpdate": { "docs": "Updates an object's stage.", + "inline": undefined, "properties": { "name": { "docs": "The updated name of the stage, otherwise unchanged if not set. @@ -5368,6 +5443,7 @@ the value must be one that's specified in the tag's allowed values. "extends": [ "AtomBaseSummary", ], + "inline": undefined, "properties": { "name": { "docs": "The name of the tag, which denotes the logical concept by which all @@ -5383,6 +5459,7 @@ unique. }, "TagWithValue": { "docs": undefined, + "inline": undefined, "properties": { "tag": { "type": "TagSummary", @@ -5398,6 +5475,7 @@ unique. }, "TagsCreateResponse": { "docs": "The response to creating a new tag.", + "inline": undefined, "properties": { "tag": { "type": "tag", @@ -5413,6 +5491,7 @@ unique. }, "TagsGetResponse": { "docs": "The response to getting a tag's information.", + "inline": undefined, "properties": { "tag": { "type": "tag", @@ -5424,6 +5503,7 @@ unique. }, "TagsListResponse": { "docs": "The response to listing the tags.", + "inline": undefined, "properties": { "next_cursor": { "docs": "The cursor used to iterate subsequent results in accordance to the @@ -5448,6 +5528,7 @@ sort order. If not set, then no prior elements exist. }, "TagsUpdateAllowedValues": { "docs": "Specifies an update to a tag's allowed values.", + "inline": undefined, "properties": { "set": { "docs": "Sets the allowed values for the tag.", @@ -5460,6 +5541,7 @@ sort order. If not set, then no prior elements exist. }, "TagsUpdateResponse": { "docs": "The response for updating a tag.", + "inline": undefined, "properties": { "tag": { "type": "tag", @@ -5486,6 +5568,7 @@ sort order. If not set, then no prior elements exist. "extends": [ "TimelineEntryBase", ], + "inline": undefined, "properties": { "artifacts": { "docs": "The artifacts for the comment.", @@ -5540,6 +5623,7 @@ will appear in the response. }, "TimelineEntriesCreateRequestTimelineComment": { "docs": undefined, + "inline": undefined, "properties": { "artifacts": { "docs": "The IDs of the artifacts attached to the comment.", @@ -5564,6 +5648,7 @@ will appear in the response. "TimelineEntriesCreateRequestType": "literal<"timeline_comment">", "TimelineEntriesCreateResponse": { "docs": "The response to creating a timeline entry for an object.", + "inline": undefined, "properties": { "timeline_entry": { "type": "TimelineEntry", @@ -5575,6 +5660,7 @@ will appear in the response. }, "TimelineEntriesGetResponse": { "docs": "The request to getting a timeline entry.", + "inline": undefined, "properties": { "timeline_entry": { "type": "TimelineEntry", @@ -5586,6 +5672,7 @@ will appear in the response. }, "TimelineEntriesListResponse": { "docs": "The response to listing timeline entries for an object.", + "inline": undefined, "properties": { "next_cursor": { "docs": "The cursor used to iterate subsequent results in accordance to the @@ -5630,6 +5717,7 @@ sort order. If not set, then no prior elements exist. }, "TimelineEntriesUpdateRequestTimelineComment": { "docs": undefined, + "inline": undefined, "properties": { "artifacts": { "type": "optional", @@ -5652,6 +5740,7 @@ sort order. If not set, then no prior elements exist. }, "TimelineEntriesUpdateRequestTimelineCommentArtifacts": { "docs": undefined, + "inline": undefined, "properties": { "add": { "docs": "Adds the provided artifacts to the comment. An artifact cannot be @@ -5678,6 +5767,7 @@ not present, then it's ignored. Mututally exclusive with `set`. "TimelineEntriesUpdateRequestType": "literal<"timeline_comment">", "TimelineEntriesUpdateResponse": { "docs": "The response to updating a timeline entry.", + "inline": undefined, "properties": { "timeline_entry": { "type": "TimelineEntry", @@ -5718,6 +5808,7 @@ default visibility. "extends": [ "AtomBase", ], + "inline": undefined, "properties": { "display_name": { "docs": "The user's display name. The name is non-unique and mutable. @@ -5748,6 +5839,7 @@ default visibility. "extends": [ "AtomBaseSummary", ], + "inline": undefined, "properties": { "display_name": { "docs": "The user's display name. The name is non-unique and mutable. @@ -5811,6 +5903,7 @@ default visibility. }, "WebhookEventRequest": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The event's ID.", @@ -5895,6 +5988,7 @@ seconds. }, "WebhookEventResponse": { "docs": undefined, + "inline": undefined, "properties": { "challenge": { "docs": "The challenge from the "verify" request, otherwise this should not @@ -5942,6 +6036,7 @@ be set for other request types. }, "WebhookEventVerify": { "docs": undefined, + "inline": undefined, "properties": { "challenge": { "docs": "The challenge that must be echoed in the response.", @@ -5971,6 +6066,7 @@ be set for other request types. }, "WebhooksCreateResponse": { "docs": "The response to creating a new webhook.", + "inline": undefined, "properties": { "webhook": { "type": "webhook", @@ -5986,6 +6082,7 @@ be set for other request types. }, "WebhooksGetResponse": { "docs": "The response to getting the information for the webhook.", + "inline": undefined, "properties": { "webhook": { "type": "webhook", @@ -5997,6 +6094,7 @@ be set for other request types. }, "WebhooksListResponse": { "docs": "The response to listing the webhooks.", + "inline": undefined, "properties": { "webhooks": { "docs": "The list of webhooks.", @@ -6019,6 +6117,7 @@ be set for other request types. }, "WebhooksUpdateRequestEventTypes": { "docs": undefined, + "inline": undefined, "properties": { "add": { "docs": "The event types to add. If a provided event type is already set for @@ -6048,6 +6147,7 @@ event types. Note this is mutually exclusive with 'add' and }, "WebhooksUpdateResponse": { "docs": "The response to updating the webhook.", + "inline": undefined, "properties": { "webhook": { "type": "webhook", @@ -6062,6 +6162,7 @@ event types. Note this is mutually exclusive with 'add' and "extends": [ "AtomBase", ], + "inline": undefined, "properties": { "applies_to_part": "optional", "artifacts": { @@ -6165,6 +6266,7 @@ issues. }, "WorksCreateRequestIssue": { "docs": undefined, + "inline": undefined, "properties": { "priority": { "type": "optional", @@ -6180,6 +6282,7 @@ issues. }, "WorksCreateRequestTicket": { "docs": undefined, + "inline": undefined, "properties": { "group": { "docs": "The group that the ticket is associated with.", @@ -6199,6 +6302,7 @@ issues. }, "WorksCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "work": { "type": "work", @@ -6213,6 +6317,7 @@ issues. }, "WorksExportResponse": { "docs": undefined, + "inline": undefined, "properties": { "works": { "docs": "The resulting collection of work items.", @@ -6225,6 +6330,7 @@ issues. }, "WorksGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "work": { "type": "work", @@ -6236,6 +6342,7 @@ issues. }, "WorksListResponse": { "docs": undefined, + "inline": undefined, "properties": { "next_cursor": { "docs": "The cursor used to iterate subsequent results in accordance to the @@ -6310,6 +6417,7 @@ sort order. If not set, then no prior elements exist. }, "WorksUpdateRequestArtifactIds": { "docs": undefined, + "inline": undefined, "properties": { "set": { "docs": "Sets the IDs to the provided artifact IDs.", @@ -6322,6 +6430,7 @@ sort order. If not set, then no prior elements exist. }, "WorksUpdateRequestIssue": { "docs": undefined, + "inline": undefined, "properties": { "priority": { "type": "optional", @@ -6337,6 +6446,7 @@ sort order. If not set, then no prior elements exist. }, "WorksUpdateRequestOwnedBy": { "docs": undefined, + "inline": undefined, "properties": { "set": { "docs": "Sets the owner IDs to the provided user IDs. This must not be @@ -6351,6 +6461,7 @@ empty. }, "WorksUpdateRequestReportedBy": { "docs": undefined, + "inline": undefined, "properties": { "set": { "docs": "Sets the users that reported the work to the provided user IDs. @@ -6364,6 +6475,7 @@ empty. }, "WorksUpdateRequestTags": { "docs": undefined, + "inline": undefined, "properties": { "set": { "docs": "Sets the provided tags on the work item.", @@ -6376,6 +6488,7 @@ empty. }, "WorksUpdateRequestTicket": { "docs": undefined, + "inline": undefined, "properties": { "group": { "docs": "The group that the ticket is associated with.", @@ -6396,6 +6509,7 @@ empty. }, "WorksUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "work": { "type": "work", @@ -6413,6 +6527,7 @@ empty. "extends": [ "PartBase", ], + "inline": undefined, "properties": { "target_close_date": { "docs": "Timestamp when the enhancement is expected to be closed.", @@ -6428,6 +6543,7 @@ empty. "extends": [ "WorkBase", ], + "inline": undefined, "properties": { "priority": "optional", }, @@ -6455,6 +6571,7 @@ empty. }, "stage": { "docs": "Describes the current stage of a work item.", + "inline": undefined, "properties": { "name": { "docs": "Current stage name of the work item.", @@ -6470,6 +6587,7 @@ empty. "extends": [ "AtomBase", ], + "inline": undefined, "properties": { "allowed_values": { "docs": "The allowed values for the tag, where a value is provided when a @@ -6501,6 +6619,7 @@ unique. "extends": [ "WorkBase", ], + "inline": undefined, "properties": { "group": "optional", "rev_org": "optional", @@ -6515,6 +6634,7 @@ unique. "extends": [ "AtomBase", ], + "inline": undefined, "properties": { "event_types": { "docs": "The event types that the webhook will receive.", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/discriminated-union-value-title.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/discriminated-union-value-title.json index 5303ec20f77..bf6d9105202 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/discriminated-union-value-title.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/discriminated-union-value-title.json @@ -58,6 +58,7 @@ "Response": { "docs": "A generic response type used throughout the API. ", + "inline": undefined, "properties": { "value": { "docs": "An optional numerical value. diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/enum-casing.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/enum-casing.json index c41e060c95c..f672a171260 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/enum-casing.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/enum-casing.json @@ -45,6 +45,7 @@ "types": { "ExampleResponse": { "docs": undefined, + "inline": undefined, "properties": { "custom_fields": "optional>", "message": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/flagright.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/flagright.json index f6177b841cc..a680b8cbeb5 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/flagright.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/flagright.json @@ -2095,6 +2095,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "types": { "ACHDetails": { "docs": "Model for ACH payment method", + "inline": undefined, "properties": { "accountNumber": { "docs": "Bank account number of the individual", @@ -2162,6 +2163,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "Address": { "docs": "Model for standardized address", + "inline": undefined, "properties": { "addressLines": { "docs": "Address lines of the user's residence address", @@ -2218,6 +2220,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "AlertClosedDetails": { "docs": undefined, + "inline": undefined, "properties": { "alertId": { "type": "optional", @@ -2259,6 +2262,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "Amount": { "docs": "Model for amount", + "inline": undefined, "properties": { "amountCurrency": { "type": "CurrencyCode", @@ -2278,6 +2282,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "BusinessBase", "BusinessOptional", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -2285,6 +2290,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "BusinessBase": { "docs": "Model for a business user base fields", + "inline": undefined, "properties": { "createdTimestamp": { "docs": "Timestamp when the user was created", @@ -2314,6 +2320,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "BusinessEntityLink": { "docs": undefined, + "inline": undefined, "properties": { "childUserIds": { "type": "optional>", @@ -2328,6 +2335,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "BusinessOptional": { "docs": "Model for a business user - optional fields", + "inline": undefined, "properties": { "acquisitionChannel": { "type": "optional", @@ -2417,6 +2425,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "BusinessUsersResponse": { "docs": "Model for business user risk score response", + "inline": undefined, "properties": { "userId": { "docs": "user ID the risk score pertains to", @@ -2438,6 +2447,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "extends": [ "Business", ], + "inline": undefined, "properties": { "executedRules": "optional>", "hitRules": "optional>", @@ -2448,6 +2458,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "CardDetails": { "docs": "Model for credit or debit card details", + "inline": undefined, "properties": { "3dsDone": { "docs": "Whether 3ds was successfully enforced for the transaction", @@ -2556,6 +2567,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "CardExpiry": { "docs": undefined, + "inline": undefined, "properties": { "month": { "type": "optional", @@ -2570,6 +2582,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "CardMerchantDetails": { "docs": undefined, + "inline": undefined, "properties": { "MCC": { "type": "optional", @@ -2610,6 +2623,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "CaseClosedDetails": { "docs": undefined, + "inline": undefined, "properties": { "caseId": { "type": "optional", @@ -2639,6 +2653,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "CaseManagementEvent": { "docs": "Model for case management events", + "inline": undefined, "properties": { "caseStatus": { "docs": "Status of a case. E.g. Open, Closed etc.", @@ -2710,6 +2725,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "CheckDetails": { "docs": undefined, + "inline": undefined, "properties": { "checkIdentifier": { "type": "optional", @@ -2760,6 +2776,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "CompanyFinancialDetails": { "docs": "Model for business user company financial details", + "inline": undefined, "properties": { "expectedTransactionAmountPerMonth": { "type": "optional", @@ -2778,6 +2795,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "CompanyGeneralDetails": { "docs": "Model for business user company general details", + "inline": undefined, "properties": { "businessIndustry": { "docs": "The industry the business operates in for a business customer", @@ -2829,6 +2847,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "CompanyRegistrationDetails": { "docs": "Model for business user company registration details", + "inline": undefined, "properties": { "dateOfRegistration": { "type": "optional", @@ -2871,6 +2890,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "ConsumerName": { "docs": "Model for a generic consumer name", + "inline": undefined, "properties": { "firstName": { "docs": "First name of the user", @@ -2909,6 +2929,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "ConsumerUsersResponse": { "docs": "Model for consumer user risk score response", + "inline": undefined, "properties": { "userId": { "docs": "user ID the risk score pertains to", @@ -2927,6 +2948,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "ContactDetails": { "docs": "Model for business user contact information details", + "inline": undefined, "properties": { "addresses": { "docs": "Address(es) of the company", @@ -3495,6 +3517,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "Date": { "docs": "Model for date", + "inline": undefined, "properties": { "day": { "docs": "Day of date", @@ -3515,6 +3538,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "DeviceData": { "docs": "Model for device data", + "inline": undefined, "properties": { "appVersion": { "docs": "The version of the app your user is using on their device at a given timestamp for an event or transaction", @@ -3609,6 +3633,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "ExecutedRulesResult": { "docs": "Model for list of executed rules", + "inline": undefined, "properties": { "labels": { "type": "optional>", @@ -3661,6 +3686,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "FailedRulesResult": { "docs": "Model for list of rules failed execution. It means rules could not be run", + "inline": undefined, "properties": { "failureException": { "type": "RuleFailureException", @@ -3702,6 +3728,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "FalsePositiveDetails": { "docs": undefined, + "inline": undefined, "properties": { "confidenceScore": "double", "isFalsePositive": "boolean", @@ -3716,6 +3743,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "GenericBankAccountDetails": { "docs": "Model for any generic bank account", + "inline": undefined, "properties": { "accountNumber": { "docs": "Bank account number", @@ -3766,6 +3794,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "HitRulesDetails": { "docs": "Model for list of hit rules", + "inline": undefined, "properties": { "labels": { "type": "optional>", @@ -3817,6 +3846,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "IBANDetails": { "docs": "Standardized model for Bank Details", + "inline": undefined, "properties": { "BIC": { "docs": "Identifier for the bank. Can be routing number, BIK number, SWIFT code, BIC number etc.", @@ -3886,6 +3916,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "KYCStatusDetails": { "docs": undefined, + "inline": undefined, "properties": { "reason": { "type": "optional", @@ -3900,6 +3931,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "LegalDocument": { "docs": "LegalDocument model generalizes User's identity document type (ex: Passport)", + "inline": undefined, "properties": { "documentExpirationDate": { "docs": "User's identity document expiration date (UNIX timestamp in milliseconds)", @@ -3946,6 +3978,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "LegalEntity": { "docs": "Model for business user legal entity details", + "inline": undefined, "properties": { "companyFinancialDetails": { "type": "optional", @@ -3970,6 +4003,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "ListData": { "docs": "Payload of a list, new or existed", + "inline": undefined, "properties": { "items": { "docs": "List items", @@ -3985,6 +4019,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "ListExisted": { "docs": "List with ID and header", + "inline": undefined, "properties": { "header": { "type": "ListHeader", @@ -4001,6 +4036,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "ListHeader": { "docs": undefined, + "inline": undefined, "properties": { "createdTimestamp": "double", "listId": "string", @@ -4017,6 +4053,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "ListItem": { "docs": undefined, + "inline": undefined, "properties": { "key": "string", "metadata": { @@ -4033,6 +4070,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "ListMetadata": { "docs": undefined, "extra-properties": true, + "inline": undefined, "properties": { "checksum": { "type": "optional", @@ -4083,6 +4121,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "MCCDetails": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Merchant code", @@ -4099,6 +4138,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "MpesaDetails": { "docs": "Model for Mpesa payment method", + "inline": undefined, "properties": { "businessShortCode": { "docs": "Business code", @@ -4142,6 +4182,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "PEPStatus": { "docs": undefined, + "inline": undefined, "properties": { "isPepHit": "boolean", "pepCountry": { @@ -4176,6 +4217,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "Person": { "docs": "Model for a generic individual - different from User model by not having userId field", + "inline": undefined, "properties": { "contactDetails": { "type": "optional", @@ -4204,6 +4246,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "extends": [ "RulesResults", ], + "inline": undefined, "properties": { "message": "optional", "userId": { @@ -4226,6 +4269,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "extends": [ "TransactionMonitoringResult", ], + "inline": undefined, "properties": { "message": "optional", }, @@ -4238,6 +4282,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "extends": [ "RulesResults", ], + "inline": undefined, "properties": { "message": "optional", "userId": { @@ -4269,6 +4314,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "RiskScoringResult": { "docs": "Model for results from Risk Scoring", + "inline": undefined, "properties": { "customerRiskAssessment": { "docs": "Quantified dynamic risk score", @@ -4301,6 +4347,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "RuleFailureException": { "docs": undefined, + "inline": undefined, "properties": { "exceptionDescription": { "docs": "Name of the rule", @@ -4338,6 +4385,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "RuleHitMeta": { "docs": "Details of rule execution, for internal purposes only", + "inline": undefined, "properties": { "falsePositiveDetails": "optional", "hitDirections": "optional>", @@ -4379,6 +4427,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "RulesResults": { "docs": undefined, + "inline": undefined, "properties": { "executedRules": { "docs": "Unique transaction identifier", @@ -4395,6 +4444,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "SWIFTDetails": { "docs": "Model for SWIFT payment method", + "inline": undefined, "properties": { "accountNumber": { "docs": "Account number", @@ -4452,6 +4502,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "SanctionsDetails": { "docs": undefined, + "inline": undefined, "properties": { "entityType": { "type": "optional", @@ -4480,6 +4531,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "Tag": { "docs": "Generic key-value pair model to append a custom variable being sent to Flagright API", + "inline": undefined, "properties": { "key": { "docs": "Key value when you are creating a custom variable", @@ -4508,6 +4560,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "Thing": { "docs": undefined, + "inline": undefined, "properties": { "publishedAt": "optional", }, @@ -4521,6 +4574,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "TransactionBase", "TransactionUpdatable", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4528,6 +4582,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "TransactionAmountDetails": { "docs": "Model for transaction amount details", + "inline": undefined, "properties": { "country": { "type": "optional", @@ -4546,6 +4601,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "TransactionAmountLimit": { "docs": undefined, + "inline": undefined, "properties": { "day": { "type": "optional", @@ -4566,6 +4622,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "TransactionBase": { "docs": "Model for transaction base Payload", + "inline": undefined, "properties": { "destinationUserId": { "docs": "UserId for transaction's destination. In other words, where the value is being transferred to.", @@ -4606,6 +4663,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "TransactionCountLimit": { "docs": undefined, + "inline": undefined, "properties": { "day": { "type": "optional", @@ -4629,6 +4687,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "extends": [ "RulesResults", ], + "inline": undefined, "properties": { "eventId": "string", "transaction": "Transaction", @@ -4639,6 +4698,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "TransactionLimit": { "docs": undefined, + "inline": undefined, "properties": { "averageTransactionAmountLimit": { "type": "optional", @@ -4656,6 +4716,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "TransactionLimits": { "docs": "Model for transaction limits for a given user", + "inline": undefined, "properties": { "maximumDailyTransactionLimit": { "type": "optional", @@ -4685,6 +4746,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "TransactionLimitsPaymentMethodLimits": { "docs": undefined, + "inline": true, "properties": { "ACH": "optional", "CARD": "optional", @@ -4705,6 +4767,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "extends": [ "RulesResults", ], + "inline": undefined, "properties": { "transactionId": { "docs": "Transaction ID that the results pertain to", @@ -4746,6 +4809,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "TransactionUpdatable": { "docs": "Model for transaction additional payload", + "inline": undefined, "properties": { "destinationAmountDetails": { "type": "optional", @@ -4881,6 +4945,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "extends": [ "Transaction", ], + "inline": undefined, "properties": { "executedRules": "list", "hitRules": "list", @@ -4891,6 +4956,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "UPIDetails": { "docs": "Model for UPI payment method", + "inline": undefined, "properties": { "bankProvider": { "docs": "Bank provider name", @@ -4941,6 +5007,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "UserBase", "UserOptional", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4948,6 +5015,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "UserBase": { "docs": "Model for User details", + "inline": undefined, "properties": { "createdTimestamp": { "docs": "Timestamp when userId is created", @@ -4980,6 +5048,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "UserDetails": { "docs": "Model for consumer user personal details", + "inline": undefined, "properties": { "countryOfNationality": { "type": "optional", @@ -5025,6 +5094,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "extends": [ "RulesResults", ], + "inline": undefined, "properties": { "userId": { "docs": "User ID that the results pertain to", @@ -5037,6 +5107,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "UserOptional": { "docs": "Model for User details", + "inline": undefined, "properties": { "acquisitionChannel": { "type": "optional", @@ -5115,6 +5186,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "UserStateDetails": { "docs": undefined, + "inline": undefined, "properties": { "reason": { "type": "optional", @@ -5135,6 +5207,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "extends": [ "User", ], + "inline": undefined, "properties": { "executedRules": "optional>", "hitRules": "optional>", @@ -5145,6 +5218,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "WalletDetails": { "docs": "Standardized model for a Generic wallet transaction", + "inline": undefined, "properties": { "name": { "docs": "Name of the account holder for a specific wallet", @@ -5186,6 +5260,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "WebhookEvent": { "docs": undefined, + "inline": undefined, "properties": { "createdTimestamp": { "type": "double", @@ -6346,6 +6421,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu CHECK: optional source: openapi: ../openapi.yml + inline: true TransactionLimits: docs: Model for transaction limits for a given user properties: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/flexport.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/flexport.json index cd360552ce7..1ccfb5ee3b1 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/flexport.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/flexport.json @@ -938,6 +938,7 @@ "types": { "AdditionalDates": { "docs": undefined, + "inline": undefined, "properties": { "cargo_ready_date": { "docs": "Represents the date when the cargo on the leg is ready for pickup.", @@ -980,6 +981,7 @@ }, "Address": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -1002,6 +1004,7 @@ }, "AddressForRequestBody": { "docs": undefined, + "inline": undefined, "properties": { "city": "optional", "country_code": "optional", @@ -1017,6 +1020,7 @@ }, "AirBookingDetail": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -1054,6 +1058,7 @@ }, "AirShipmentDetail": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -1070,6 +1075,7 @@ }, "AirShipmentLeg": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "flight_number": "optional", @@ -1082,6 +1088,7 @@ }, "Airport": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -1098,6 +1105,7 @@ }, "Booking": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -1161,6 +1169,7 @@ }, "BookingAmendment": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -1243,6 +1252,7 @@ }, "BookingAmendmentCreateRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -1256,6 +1266,7 @@ }, "BookingAmendmentHsCode": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "String representing the object’s type. Always `/booking_amendment_product_description` for this object.", @@ -1277,6 +1288,7 @@ }, "BookingCreateRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -1290,6 +1302,7 @@ }, "BookingHsCode": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "String representing the object’s type. Always `/product_descriptions` for this object.", @@ -1315,6 +1328,7 @@ }, "BookingLineItem": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -1337,6 +1351,7 @@ }, "BookingLineItemCollectionRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -1357,6 +1372,7 @@ }, "BookingLineItemCreateRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -1370,6 +1386,7 @@ }, "BookingLineItemIndexRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -1383,6 +1400,7 @@ }, "BookingLineItemShowRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -1413,6 +1431,7 @@ }, "BookingRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "id": "optional", @@ -1425,6 +1444,7 @@ }, "BookingShowRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -1450,6 +1470,7 @@ }, "BookingsIndexRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -1463,6 +1484,7 @@ }, "CarbonCalculation": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -1476,6 +1498,7 @@ }, "CarbonCalculationCreateRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -1489,6 +1512,7 @@ }, "Cargo": { "docs": "With cargo you have two options, detailed or simple. These are both expressed directly on the cargo object. For detailed cargo, `shipping_units` is required, and `weight` and `volume` is required in the `cargo` object or the `shipping_units` object. For simple cargo, `shipping_units` is required, but only one should be specified, and `weight` and `volume` are required in the `cargo` object.", + "inline": undefined, "properties": { "_object": { "docs": "String representing the object’s type. Always `/cargo` for this object.", @@ -1543,6 +1567,7 @@ }, "CommercialInvoice": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object. Always /commercial_invoice for this object.", @@ -1592,6 +1617,7 @@ }, "CommercialInvoiceCollectionRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "link": "optional", @@ -1614,6 +1640,7 @@ }, "CommercialInvoiceLineItem": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object. Always /commercial_invoice_line_item for this object.", @@ -1656,6 +1683,7 @@ }, "CommercialInvoiceLineItemContainerNumber": { "docs": undefined, + "inline": undefined, "properties": { "commercial_invoice_line_item_id": "optional", "container_number": "optional", @@ -1670,6 +1698,7 @@ }, "CommercialInvoicesCreateRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -1683,6 +1712,7 @@ }, "CommercialInvoicesShowRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -1696,6 +1726,7 @@ }, "CommercialInvoicesUpdateRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -1709,6 +1740,7 @@ }, "Company": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object. Always /network/company for this object.", @@ -1732,6 +1764,7 @@ }, "CompanyEntity": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -1749,6 +1782,7 @@ }, "CompanyEntityIndexRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -1762,6 +1796,7 @@ }, "CompanyEntityRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "id": "optional", @@ -1774,6 +1809,7 @@ }, "Contact": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object. Always /network/contact for this object.", @@ -1798,6 +1834,7 @@ }, "ContactCompany": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": true, "properties": { "_object": "optional", "id": "optional", @@ -1810,6 +1847,7 @@ }, "ContainerCollectionRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -1830,6 +1868,7 @@ }, "ContainerCounts": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "String representing the object’s type. Always `/container_counts` for this object.", @@ -1858,6 +1897,7 @@ }, "ContainerLegCollectionRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -1878,6 +1918,7 @@ }, "ContainerListRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -1891,6 +1932,7 @@ }, "ContainerRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "id": "optional", @@ -1903,6 +1945,7 @@ }, "ContainerShowRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -1916,6 +1959,7 @@ }, "CoordinatesCreate": { "docs": undefined, + "inline": undefined, "properties": { "latitude": "optional", "longitude": "optional", @@ -1926,6 +1970,7 @@ }, "CreateAirBooking": { "docs": "If a non-null value is passed in for 'air_booking', then the new booking will be assumed to be an air booking, even if the 'ocean_booking' or 'trucking_booking' fields are set.", + "inline": undefined, "properties": { "destination_port_iata_code": { "docs": "Optional, provide one of `destination_port_us_cbp_port_code`, `destination_port_loc_code`, `destination_port_iata_code`, or `destination_port_icao_code`. Unique airport reference code used by IATA.", @@ -1995,6 +2040,7 @@ }, "CreateBookingAmendmentHsCode": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "Always required. English description of product in booking.", @@ -2015,6 +2061,7 @@ }, "CreateBookingHsCode": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "Always required. English description of product in booking.", @@ -2039,6 +2086,7 @@ }, "CreateCargo": { "docs": "With cargo you have two options, detailed or simple. These are both expressed directly on the cargo object. For detailed cargo, `shipping_units` is required, and `weight` and `volume` is required in the `cargo` object or the `shipping_units` object. For simple cargo, `shipping_units` is required, but only one should be specified, and `weight` and `volume` are required in the `cargo` object.", + "inline": undefined, "properties": { "contains_hazmat": { "docs": "Required. Whether the cargo contains hazardous materials.", @@ -2089,6 +2137,7 @@ }, "CreateCommercialInvoiceLineItem": { "docs": undefined, + "inline": undefined, "properties": { "container_number": "optional", "country_of_origin": "optional", @@ -2128,6 +2177,7 @@ }, "CreateContainerCounts": { "docs": undefined, + "inline": undefined, "properties": { "forty_five_ft_hc": { "docs": "Quantity of 45 ft HC containers requested.", @@ -2152,6 +2202,7 @@ }, "CreateDocument": { "docs": undefined, + "inline": undefined, "properties": { "document": { "docs": "Document represented in a strict Base64-encoded string.", @@ -2188,6 +2239,7 @@ }, "CreateInvolvedParty": { "docs": undefined, + "inline": undefined, "properties": { "company_entity_ref": { "docs": "Your custom string used to refer to the company entity. Can be used to look up or reference the company entity later on.", @@ -2201,6 +2253,7 @@ }, "CreateLineItem": { "docs": undefined, + "inline": undefined, "properties": { "assigned_party_ref": { "docs": "The party that this line item is assigned to. Useful if assigning line items to different factories under a vendor, for example.", @@ -2297,6 +2350,7 @@ }, "CreateLineItemDestinationLocation": { "docs": undefined, + "inline": undefined, "properties": { "location_ref": { "docs": "Location ref", @@ -2344,6 +2398,7 @@ }, "CreateLineItemMeasurement": { "docs": undefined, + "inline": undefined, "properties": { "measure_type": { "docs": "The type of measure", @@ -2535,6 +2590,7 @@ }, "CreateOceanBooking": { "docs": undefined, + "inline": undefined, "properties": { "container_counts": "CreateContainerCounts", "destination_port_loc_code": { @@ -2597,6 +2653,7 @@ }, "CreateOrUpdatePurchaseOrder": { "docs": undefined, + "inline": undefined, "properties": { "cargo_ready_date": { "docs": "Required if there is no cargo_ready_date in each line item. Date when cargo is ready for pickup at the origin location.", @@ -2781,6 +2838,7 @@ }, "CreateParty": { "docs": "A party is a company entity that is tied to a purchase order and has a specific role.", + "inline": undefined, "properties": { "contacts": { "docs": "A list of contact data for who should be contacted should there be questions about this order. For example, if your supplier needs to contact someone, who should they contact?", @@ -2805,6 +2863,7 @@ }, "CreatePartyContactsItem": { "docs": undefined, + "inline": true, "properties": { "department": "optional", "email": "optional", @@ -2838,6 +2897,7 @@ }, "CreatePurchaseOrderHsCode": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "The indentifying code on the hs code", @@ -2854,6 +2914,7 @@ }, "CreatePurchaseOrderPort": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "A unique identifier for this port", @@ -2882,6 +2943,7 @@ }, "CreatePurchaseOrderProduct": { "docs": undefined, + "inline": undefined, "properties": { "color": { "docs": "The color of the product", @@ -2938,6 +3000,7 @@ }, "CreateQuantity": { "docs": undefined, + "inline": undefined, "properties": { "unit": { "docs": "Required. Unit of measurement.", @@ -2969,6 +3032,7 @@ }, "CreateTruckingBooking": { "docs": undefined, + "inline": undefined, "properties": { "description_of_products": { "docs": "General description of the products in the shipment.", @@ -2999,6 +3063,7 @@ }, "CreditMemo": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "The type of the object", @@ -3029,6 +3094,7 @@ }, "CustomsEntriesShowRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -3042,6 +3108,7 @@ }, "CustomsEntry": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object. Always /customs_entry for this object.", @@ -3074,6 +3141,7 @@ }, "CustomsEntryCollectionRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "link": "optional", @@ -3085,6 +3153,7 @@ }, "CustomsEntryIndexRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -3109,6 +3178,7 @@ }, "CustomsInvolvedParty": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -3131,6 +3201,7 @@ }, "DistanceCreate": { "docs": undefined, + "inline": undefined, "properties": { "unit": { "docs": "Required. Unit of measurement. "km" for kilometers. "mi" for miles.", @@ -3157,6 +3228,7 @@ }, "Document": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object. Always /document for this object.", @@ -3198,6 +3270,7 @@ }, "DocumentCollectionRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "link": "optional", @@ -3209,6 +3282,7 @@ }, "DocumentsCreateRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -3222,6 +3296,7 @@ }, "DocumentsDownloadRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -3235,6 +3310,7 @@ }, "DocumentsIndexRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -3248,6 +3324,7 @@ }, "DocumentsShowRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -3261,6 +3338,7 @@ }, "Error": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "String representing the object’s type. Always /api/error for this object.", @@ -3285,6 +3363,7 @@ }, "EventsIndexRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -3298,6 +3377,7 @@ }, "EventsShowRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -3311,6 +3391,7 @@ }, "Exception": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "message": { @@ -3355,6 +3436,7 @@ }, "FileMetadata": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object. Always /file_metadata for this object.", @@ -3386,6 +3468,7 @@ }, "GenericCollectionRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "link": "optional", @@ -3397,6 +3480,7 @@ }, "GenericObjectRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "id": "optional", @@ -3411,6 +3495,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3421,6 +3506,7 @@ }, "HsCode": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "String representing the object’s type. Always `/hs_code` for this object.", @@ -3442,6 +3528,7 @@ }, "Invoice": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object. Always '/invoice' for this object.", @@ -3515,6 +3602,7 @@ }, "InvoiceIndexRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -3528,6 +3616,7 @@ }, "InvoiceItem": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object.", @@ -3573,6 +3662,7 @@ }, "InvoiceQuantity": { "docs": "Describes the number of units used to calculate the price of a line item", + "inline": undefined, "properties": { "_object": { "docs": "The type of the object", @@ -3593,6 +3683,7 @@ }, "InvoiceRate": { "docs": "Describes the rate per unit used to calculate the price of a line item", + "inline": undefined, "properties": { "_object": { "docs": "The type of the object", @@ -3636,6 +3727,7 @@ }, "InvoicesShowRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -3649,6 +3741,7 @@ }, "LegCollectionRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -3669,6 +3762,7 @@ }, "LegRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "id": "optional", @@ -3681,6 +3775,7 @@ }, "Length": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "String representing the object’s type. Always `/quantity/length` for this object.", @@ -3701,6 +3796,7 @@ }, "LengthCreate": { "docs": undefined, + "inline": undefined, "properties": { "unit": { "docs": "Required. Unit of measurement. "cm" for centimeters. "in" for inches.", @@ -3737,6 +3833,7 @@ }, "LineItemMeasurement": { "docs": undefined, + "inline": undefined, "properties": { "measure_type": { "docs": "The type of measure", @@ -3773,6 +3870,7 @@ }, "Location": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object. Always /network/location for this object.", @@ -3796,6 +3894,7 @@ }, "LocationIndexRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -3809,6 +3908,7 @@ }, "LocationUpdateRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -3822,6 +3922,7 @@ }, "Manufacturer": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -3842,6 +3943,7 @@ "discriminated": false, "docs": "Metadata has two allowed formats. Either array format or object format. Refer to the metadata section in this documentation for more information.", "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -3858,6 +3960,7 @@ }, "MetadataCreateExampleKey": { "docs": "Object format.", + "inline": true, "properties": { "example_key": "optional>", }, @@ -3867,6 +3970,7 @@ }, "MetadataCreateItem": { "docs": undefined, + "inline": true, "properties": { "name": "optional", "value": "optional>", @@ -3880,6 +3984,7 @@ "extends": [ "MoneyCreate", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -3887,6 +3992,7 @@ }, "MoneyCreate": { "docs": undefined, + "inline": undefined, "properties": { "amount": "optional", "currency_code": "optional", @@ -3897,6 +4003,7 @@ }, "NetworkCompanyCreateRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -3910,6 +4017,7 @@ }, "NetworkCompanyEntityCreateRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -3923,6 +4031,7 @@ }, "NetworkCompanyEntityShowRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -3936,6 +4045,7 @@ }, "NetworkCompanyEntityUpdateRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -3949,6 +4059,7 @@ }, "NetworkCompanyIndexRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -3962,6 +4073,7 @@ }, "NetworkCompanyMeRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -3975,6 +4087,7 @@ }, "NetworkCompanyUpdateRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -3988,6 +4101,7 @@ }, "NetworkContactCreateRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -4001,6 +4115,7 @@ }, "NetworkContactIndexRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -4014,6 +4129,7 @@ }, "NetworkContactShowRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -4027,6 +4143,7 @@ }, "NetworkContactUpdateRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -4040,6 +4157,7 @@ }, "NetworkLocationCreateRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -4053,6 +4171,7 @@ }, "NetworkLocationShowRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -4066,6 +4185,7 @@ }, "OceanBookingDetail": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -4105,6 +4225,7 @@ }, "OceanContainerLegsIndexRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -4118,6 +4239,7 @@ }, "OceanContainerLegsShowRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -4131,6 +4253,7 @@ }, "OceanShipmentContainerLeg": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -4146,6 +4269,7 @@ }, "OceanShipmentDetail": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -4167,6 +4291,7 @@ }, "OceanShipmentLeg": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "container_legs": "optional", @@ -4181,6 +4306,7 @@ }, "Parties": { "docs": "A party is a company entity that is tied to a purchase order that has a specific role.", + "inline": undefined, "properties": { "company_entity": "optional", "contacts": { @@ -4202,6 +4328,7 @@ }, "PartiesContactsItem": { "docs": undefined, + "inline": true, "properties": { "department": "optional", "email": "optional", @@ -4235,6 +4362,7 @@ }, "Place": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -4255,6 +4383,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -4266,6 +4395,7 @@ }, "Placeport": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -4299,6 +4429,7 @@ }, "PortsIndexRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -4312,6 +4443,7 @@ }, "Product": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -4367,6 +4499,7 @@ }, "ProductClassification": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -4387,6 +4520,7 @@ }, "ProductCreateRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -4400,6 +4534,7 @@ }, "ProductIndexRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -4413,6 +4548,7 @@ }, "ProductProperty": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -4433,6 +4569,7 @@ }, "ProductRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "id": "optional", @@ -4445,6 +4582,7 @@ }, "ProductShowRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -4458,6 +4596,7 @@ }, "ProductUpdateRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -4471,6 +4610,7 @@ }, "PurchaseOrder": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -4550,6 +4690,7 @@ }, "PurchaseOrderCreateRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -4591,6 +4732,7 @@ }, "PurchaseOrderIndexRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -4604,6 +4746,7 @@ }, "PurchaseOrderLineItem": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -4664,6 +4807,7 @@ }, "PurchaseOrderLineItemCollectionRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -4684,6 +4828,7 @@ }, "PurchaseOrderLineItemDestinationAddress": { "docs": undefined, + "inline": undefined, "properties": { "location_ref": { "docs": "Location ref", @@ -4719,6 +4864,7 @@ }, "PurchaseOrderLineItemIndexRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -4743,6 +4889,7 @@ }, "PurchaseOrderLineItemRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "id": "optional", @@ -4755,6 +4902,7 @@ }, "PurchaseOrderLineItemShowRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -4842,6 +4990,7 @@ }, "PurchaseOrderProduct": { "docs": undefined, + "inline": undefined, "properties": { "color": { "docs": "The color of the product", @@ -4898,6 +5047,7 @@ }, "PurchaseOrderRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "id": "optional", @@ -4910,6 +5060,7 @@ }, "PurchaseOrderShowRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -4935,6 +5086,7 @@ }, "PurchaseOrderUpdateRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -4948,6 +5100,7 @@ }, "RailShipmentLeg": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "container_legs": "optional", @@ -4958,6 +5111,7 @@ }, "Shipment": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -5136,6 +5290,7 @@ }, "ShipmentContainer": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -5218,6 +5373,7 @@ }, "ShipmentDangerousGoods": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of this object", @@ -5248,6 +5404,7 @@ }, "ShipmentEventData": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -5273,6 +5430,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -5303,6 +5461,7 @@ }, "ShipmentIndexRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -5316,6 +5475,7 @@ }, "ShipmentItem": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -5334,6 +5494,7 @@ }, "ShipmentLeg": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -5375,6 +5536,7 @@ }, "ShipmentLegIndexRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -5388,6 +5550,7 @@ }, "ShipmentLegShowRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -5401,6 +5564,7 @@ }, "ShipmentNode": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -5426,6 +5590,7 @@ }, "ShipmentRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": { "docs": "Type of Object Returned. In this case, /api/refs/object.", @@ -5450,6 +5615,7 @@ }, "ShipmentShowRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -5483,6 +5649,7 @@ }, "ShipmentUpdateRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -5496,6 +5663,7 @@ }, "ShipmentsShareableRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -5509,6 +5677,7 @@ }, "ShippingUnit": { "docs": "For detailed cargo, `shipping_units` is required. For simple cargo, `shipping_units` is required, but only one should be specified.", + "inline": undefined, "properties": { "_object": { "docs": "String representing the object’s type. Always `/shipping_unit` for this object.", @@ -5542,6 +5711,7 @@ }, "ShippingUnitCreate": { "docs": "For detailed cargo, `shipping_units` is required. For simple cargo, `shipping_units` is required, but only one should be specified.", + "inline": undefined, "properties": { "atomic_count": { "docs": "Required if `unit_type` = `pallet`. The number of atomic units, i.e. units that will not be unpacked and broken up during shipping, contained in each shipping unit.", @@ -5571,6 +5741,7 @@ }, "Terminal": { "docs": "Name and address of a specific terminal within a port or airport. Possibly null", + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -5607,6 +5778,7 @@ }, "TruckingBookingDetail": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -5631,6 +5803,7 @@ }, "TruckingShipmentLeg": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "container_legs": "optional", @@ -5656,6 +5829,7 @@ }, "VatNumber": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -5676,6 +5850,7 @@ "extends": [ "VolumeCreate", ], + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -5688,6 +5863,7 @@ }, "VolumeCreate": { "docs": undefined, + "inline": undefined, "properties": { "unit": { "docs": "unit of measurement. "cbm" for cubic meters. "cbft" for cubic feet.", @@ -5714,6 +5890,7 @@ }, "WebhookEvent": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -5735,6 +5912,7 @@ "extends": [ "WeightCreate", ], + "inline": undefined, "properties": { "_object": { "docs": "String representing the object’s type. Always `/quantity/weight` for this object.", @@ -5747,6 +5925,7 @@ }, "WeightCreate": { "docs": undefined, + "inline": undefined, "properties": { "unit": { "docs": "Required. Unit of measurement. "kg" for kilograms, "lbs" for pounds", @@ -5773,6 +5952,7 @@ }, "WriteProductClassification": { "docs": undefined, + "inline": undefined, "properties": { "codes": { "docs": "Always required. An array of HS codes for this product in the provided region", @@ -5789,6 +5969,7 @@ }, "WriteProductProperty": { "docs": undefined, + "inline": undefined, "properties": { "type": { "docs": "Always required. User defined type of this property", @@ -5805,6 +5986,7 @@ }, "WriteProductSupplier": { "docs": undefined, + "inline": undefined, "properties": { "country_of_origin": { "docs": "Always required. ISO Alpha-2 country in which the product is manufactured", @@ -5825,6 +6007,7 @@ }, "WriteVatNumber": { "docs": undefined, + "inline": undefined, "properties": { "country_code": { "docs": "ISO 3166 two-letter country code", @@ -6536,12 +6719,14 @@ example_key: optional> source: openapi: ../openapi.yml + inline: true MetadataCreateItem: properties: name: optional value: optional> source: openapi: ../openapi.yml + inline: true MetadataCreate: discriminated: false docs: >- @@ -6977,6 +7162,7 @@ - Manufacturer source: openapi: ../openapi.yml + inline: true Place: properties: _object: @@ -7737,6 +7923,7 @@ - integer source: openapi: ../openapi.yml + inline: true GenericObjectRef: docs: '[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)' properties: @@ -8427,6 +8614,7 @@ - OceanShipmentContainerLeg source: openapi: ../openapi.yml + inline: true ShipmentEventData: properties: _object: @@ -8656,6 +8844,7 @@ id: optional source: openapi: ../openapi.yml + inline: true Contact: properties: _object: @@ -8962,6 +9151,7 @@ department: optional source: openapi: ../openapi.yml + inline: true Parties: docs: >- A party is a company entity that is tied to a purchase order that has a @@ -9138,6 +9328,7 @@ department: optional source: openapi: ../openapi.yml + inline: true CreateParty: docs: >- A party is a company entity that is tied to a purchase order and has a @@ -11358,6 +11549,7 @@ errors: "types": { "BookingCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -11370,6 +11562,7 @@ errors: }, "BookingShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -11410,6 +11603,7 @@ errors: }, "BookingsIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -11422,6 +11616,7 @@ errors: }, "BookingsIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -11473,6 +11668,7 @@ errors: data: optional> source: openapi: ../openapi.yml + inline: true BookingsIndexResponse: properties: _object: optional @@ -12741,6 +12937,7 @@ docs: Endpoints relating to Booking objects "types": { "BookingAmendmentCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -13273,6 +13470,7 @@ docs: >- "types": { "BookingLineItemCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -13295,6 +13493,7 @@ docs: >- }, "BookingLineItemIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -13307,6 +13506,7 @@ docs: >- }, "BookingLineItemIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -13319,6 +13519,7 @@ docs: >- }, "BookingLineItemShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -13347,6 +13548,7 @@ docs: >- data: optional> source: openapi: ../openapi.yml + inline: true BookingLineItemIndexResponse: properties: _object: optional @@ -13700,6 +13902,7 @@ docs: >- "types": { "CarbonCalculationCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -14653,6 +14856,7 @@ docs: Endpoints relating to Carbon Calculations "types": { "CommercialInvoicesCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -14665,6 +14869,7 @@ docs: Endpoints relating to Carbon Calculations }, "CommercialInvoicesIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -14677,6 +14882,7 @@ docs: Endpoints relating to Carbon Calculations }, "CommercialInvoicesIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -14689,6 +14895,7 @@ docs: Endpoints relating to Carbon Calculations }, "CommercialInvoicesShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -14701,6 +14908,7 @@ docs: Endpoints relating to Carbon Calculations }, "CommercialInvoicesUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -14724,6 +14932,7 @@ types: data: optional> source: openapi: ../openapi.yml + inline: true CommercialInvoicesIndexResponse: properties: _object: optional @@ -15827,6 +16036,7 @@ docs: Endpoints relating to Commercial Invoice objects "types": { "NetworkCompanyCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -15839,6 +16049,7 @@ docs: Endpoints relating to Commercial Invoice objects }, "NetworkCompanyIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -15851,6 +16062,7 @@ docs: Endpoints relating to Commercial Invoice objects }, "NetworkCompanyIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -15864,6 +16076,7 @@ docs: Endpoints relating to Commercial Invoice objects }, "NetworkCompanyMeResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -15876,6 +16089,7 @@ docs: Endpoints relating to Commercial Invoice objects }, "NetworkCompanyShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -15888,6 +16102,7 @@ docs: Endpoints relating to Commercial Invoice objects }, "NetworkCompanyUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -15912,6 +16127,7 @@ types: data: optional> source: openapi: ../openapi.yml + inline: true NetworkCompanyIndexResponse: properties: _object: optional @@ -16705,6 +16921,7 @@ docs: Endpoints relating to Company objects "types": { "CompanyEntityIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -16717,6 +16934,7 @@ docs: Endpoints relating to Company objects }, "CompanyEntityIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -16730,6 +16948,7 @@ docs: Endpoints relating to Company objects }, "NetworkCompanyEntityCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -16742,6 +16961,7 @@ docs: Endpoints relating to Company objects }, "NetworkCompanyEntityShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -16754,6 +16974,7 @@ docs: Endpoints relating to Company objects }, "NetworkCompanyEntityUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -16778,6 +16999,7 @@ types: data: optional> source: openapi: ../openapi.yml + inline: true CompanyEntityIndexResponse: properties: _object: optional @@ -17420,6 +17642,7 @@ docs: Endpoints relating to CompanyEntity objects "types": { "NetworkContactCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -17432,6 +17655,7 @@ docs: Endpoints relating to CompanyEntity objects }, "NetworkContactIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -17444,6 +17668,7 @@ docs: Endpoints relating to CompanyEntity objects }, "NetworkContactIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -17457,6 +17682,7 @@ docs: Endpoints relating to CompanyEntity objects }, "NetworkContactShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -17469,6 +17695,7 @@ docs: Endpoints relating to CompanyEntity objects }, "NetworkContactUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -17493,6 +17720,7 @@ types: data: optional> source: openapi: ../openapi.yml + inline: true NetworkContactIndexResponse: properties: _object: optional @@ -18030,6 +18258,7 @@ docs: Endpoints relating to Contact objects "types": { "ContainerListResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -18042,6 +18271,7 @@ docs: Endpoints relating to Contact objects }, "ContainerListResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -18054,6 +18284,7 @@ docs: Endpoints relating to Contact objects }, "ContainerShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -18077,6 +18308,7 @@ types: data: optional> source: openapi: ../openapi.yml + inline: true ContainerListResponse: properties: _object: optional @@ -18480,6 +18712,7 @@ docs: Endpoints relating to Container objects "types": { "OceanContainerLegsIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -18492,6 +18725,7 @@ docs: Endpoints relating to Container objects }, "OceanContainerLegsIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -18504,6 +18738,7 @@ docs: Endpoints relating to Container objects }, "OceanContainerLegsShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -18527,6 +18762,7 @@ types: data: optional> source: openapi: ../openapi.yml + inline: true OceanContainerLegsIndexResponse: properties: _object: optional @@ -18820,6 +19056,7 @@ docs: Endpoints relating to ContainerLeg objects "types": { "CustomsEntriesShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -18832,6 +19069,7 @@ docs: Endpoints relating to ContainerLeg objects }, "CustomsEntryIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -18844,6 +19082,7 @@ docs: Endpoints relating to ContainerLeg objects }, "CustomsEntryIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -18867,6 +19106,7 @@ types: data: optional> source: openapi: ../openapi.yml + inline: true CustomsEntryIndexResponse: properties: _object: optional @@ -19255,6 +19495,7 @@ docs: Endpoints relating to Customs Entry objects "types": { "DocumentsCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -19267,6 +19508,7 @@ docs: Endpoints relating to Customs Entry objects }, "DocumentsIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -19279,6 +19521,7 @@ docs: Endpoints relating to Customs Entry objects }, "DocumentsIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -19292,6 +19535,7 @@ docs: Endpoints relating to Customs Entry objects }, "DocumentsShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -19316,6 +19560,7 @@ types: data: optional> source: openapi: ../openapi.yml + inline: true DocumentsIndexResponse: properties: _object: optional @@ -19786,6 +20031,7 @@ docs: Endpoints relating to Document objects }, "EventsIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -19798,6 +20044,7 @@ docs: Endpoints relating to Document objects }, "EventsIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -19810,6 +20057,7 @@ docs: Endpoints relating to Document objects }, "EventsShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -19847,6 +20095,7 @@ docs: Endpoints relating to Document objects data: optional> source: openapi: ../openapi.yml + inline: true EventsIndexResponse: properties: _object: optional @@ -20689,6 +20938,7 @@ Other details about this invoice", }, "InvoiceIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -20701,6 +20951,7 @@ Other details about this invoice", }, "InvoiceIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -20713,6 +20964,7 @@ Other details about this invoice", }, "InvoicesShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -20749,6 +21001,7 @@ Other details about this invoice", data: optional> source: openapi: ../openapi.yml + inline: true InvoiceIndexResponse: properties: _object: optional @@ -21687,6 +21940,7 @@ docs: Endpoints relating to Invoice objects "types": { "LocationIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -21699,6 +21953,7 @@ docs: Endpoints relating to Invoice objects }, "LocationIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -21712,6 +21967,7 @@ docs: Endpoints relating to Invoice objects }, "LocationUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -21724,6 +21980,7 @@ docs: Endpoints relating to Invoice objects }, "NetworkLocationCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -21736,6 +21993,7 @@ docs: Endpoints relating to Invoice objects }, "NetworkLocationShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -21760,6 +22018,7 @@ types: data: optional> source: openapi: ../openapi.yml + inline: true LocationIndexResponse: properties: _object: optional @@ -22277,6 +22536,7 @@ docs: Endpoints relating to Location objects }, "PortsIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -22289,6 +22549,7 @@ docs: Endpoints relating to Location objects }, "PortsIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>>", @@ -22320,6 +22581,7 @@ docs: Endpoints relating to Location objects data: optional>> source: openapi: ../openapi.yml + inline: true PortsIndexResponse: properties: _object: optional @@ -22853,6 +23115,7 @@ docs: Endpoints relating to Ports objects "types": { "ProductCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -22865,6 +23128,7 @@ docs: Endpoints relating to Ports objects }, "ProductIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -22877,6 +23141,7 @@ docs: Endpoints relating to Ports objects }, "ProductIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -22889,6 +23154,7 @@ docs: Endpoints relating to Ports objects }, "ProductShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -22901,6 +23167,7 @@ docs: Endpoints relating to Ports objects }, "ProductUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -22924,6 +23191,7 @@ types: data: optional> source: openapi: ../openapi.yml + inline: true ProductIndexResponse: properties: _object: optional @@ -24321,6 +24589,7 @@ docs: Endpoints relating to Product objects }, "PurchaseOrderIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -24333,6 +24602,7 @@ docs: Endpoints relating to Product objects }, "PurchaseOrderIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -24345,6 +24615,7 @@ docs: Endpoints relating to Product objects }, "PurchaseOrderShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -24396,6 +24667,7 @@ docs: Endpoints relating to Product objects data: optional> source: openapi: ../openapi.yml + inline: true PurchaseOrderIndexResponse: properties: _object: optional @@ -25601,6 +25873,7 @@ docs: >- }, "PurchaseOrderLineItemIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -25613,6 +25886,7 @@ docs: >- }, "PurchaseOrderLineItemIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -25625,6 +25899,7 @@ docs: >- }, "PurchaseOrderLineItemShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -25653,6 +25928,7 @@ docs: >- data: optional> source: openapi: ../openapi.yml + inline: true PurchaseOrderLineItemIndexResponse: properties: _object: optional @@ -27221,6 +27497,7 @@ docs: >- }, "ShipmentIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -27233,6 +27510,7 @@ docs: >- }, "ShipmentIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -27245,6 +27523,7 @@ docs: >- }, "ShipmentShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -27257,6 +27536,7 @@ docs: >- }, "ShipmentUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -27269,6 +27549,7 @@ docs: >- }, "ShipmentsShareableResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -27281,6 +27562,7 @@ docs: >- }, "ShipmentsShareableResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "shipments": "optional>", @@ -27291,6 +27573,7 @@ docs: >- }, "ShipmentsShareableResponseDataShipmentsItem": { "docs": undefined, + "inline": true, "properties": { "expiration_date": "optional", "shareable_url": "optional", @@ -27328,6 +27611,7 @@ docs: >- data: optional> source: openapi: ../openapi.yml + inline: true ShipmentIndexResponse: properties: _object: optional @@ -27359,12 +27643,14 @@ docs: >- expiration_date: optional source: openapi: ../openapi.yml + inline: true ShipmentsShareableResponseData: properties: _object: optional shipments: optional> source: openapi: ../openapi.yml + inline: true ShipmentsShareableResponse: properties: _object: optional @@ -28788,6 +29074,7 @@ docs: Endpoints relating to Shipment objects "types": { "ShipmentLegIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -28800,6 +29087,7 @@ docs: Endpoints relating to Shipment objects }, "ShipmentLegIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -28812,6 +29100,7 @@ docs: Endpoints relating to Shipment objects }, "ShipmentLegShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -28835,6 +29124,7 @@ types: data: optional> source: openapi: ../openapi.yml + inline: true ShipmentLegIndexResponse: properties: _object: optional diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/float.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/float.json index 3f9e90b448d..4eef66bfac5 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/float.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/float.json @@ -55,6 +55,7 @@ "Response": { "docs": "A generic response type used throughout the API. ", + "inline": undefined, "properties": { "id": "optional", "value": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/hathora.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/hathora.json index 4ded7d5271e..c4e0482b4e0 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/hathora.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/hathora.json @@ -982,6 +982,7 @@ "types": { "ActiveConnectionInfo": { "docs": undefined, + "inline": undefined, "properties": { "host": "string", "port": "double", @@ -994,6 +995,7 @@ }, "AppConfig": { "docs": undefined, + "inline": undefined, "properties": { "appName": { "type": "string", @@ -1012,6 +1014,7 @@ }, "AppConfigAuthConfiguration": { "docs": undefined, + "inline": true, "properties": { "anonymous": "optional", "google": "optional", @@ -1023,6 +1026,7 @@ }, "AppConfigAuthConfigurationGoogle": { "docs": undefined, + "inline": true, "properties": { "clientId": "string", }, @@ -1033,6 +1037,7 @@ "AppId": "string", "Application": { "docs": undefined, + "inline": undefined, "properties": { "appId": "string", "appName": "string", @@ -1050,6 +1055,7 @@ }, "ApplicationAuthConfiguration": { "docs": undefined, + "inline": true, "properties": { "anonymous": "optional", "google": "optional", @@ -1061,6 +1067,7 @@ }, "ApplicationAuthConfigurationGoogle": { "docs": undefined, + "inline": true, "properties": { "clientId": "string", }, @@ -1073,6 +1080,7 @@ "extends": [ "Application", ], + "inline": undefined, "properties": { "deployment": "Deployment", }, @@ -1082,6 +1090,7 @@ }, "Build": { "docs": undefined, + "inline": undefined, "properties": { "appId": "AppId", "buildId": "BuildId", @@ -1101,6 +1110,7 @@ "BuildId": "double", "BuildRegionalContainerTagsItem": { "docs": undefined, + "inline": true, "properties": { "containerTag": "string", "region": "Region", @@ -1139,6 +1149,7 @@ "extends": [ "DeploymentConfig", ], + "inline": undefined, "properties": { "appId": "AppId", "buildId": "BuildId", @@ -1154,6 +1165,7 @@ }, "DeploymentConfig": { "docs": undefined, + "inline": undefined, "properties": { "containerPort": { "type": "integer", @@ -1185,6 +1197,7 @@ }, "DeploymentConfigEnvItem": { "docs": undefined, + "inline": true, "properties": { "name": { "type": "string", @@ -1213,6 +1226,7 @@ "DiscoveryResponse": "list", "DiscoveryResponseItem": { "docs": undefined, + "inline": undefined, "properties": { "host": "string", "port": "double", @@ -1224,6 +1238,7 @@ }, "Lobby": { "docs": undefined, + "inline": undefined, "properties": { "appId": "AppId", "createdAt": "datetime", @@ -1262,6 +1277,7 @@ }, "MetricValue": { "docs": undefined, + "inline": undefined, "properties": { "timestamp": "double", "value": "double", @@ -1278,6 +1294,7 @@ "OrgId": "string", "PickRoomExcludeKeyofRoomAllocations": { "docs": "From T, pick a set of properties whose keys are in the union K", + "inline": undefined, "properties": { "appId": "AppId", "currentAllocation": "optional", @@ -1301,6 +1318,7 @@ }, "Process": { "docs": undefined, + "inline": undefined, "properties": { "activeConnections": "double", "appId": "AppId", @@ -1329,6 +1347,7 @@ "extends": [ "Process", ], + "inline": undefined, "properties": { "rooms": "list", "totalRooms": "double", @@ -1339,6 +1358,7 @@ }, "RecordPartialMetricNameMetricValueArray": { "docs": "Construct a type with a set of properties K of type T", + "inline": undefined, "properties": { "cpu": "optional>", "memory": "optional>", @@ -1351,6 +1371,7 @@ }, "RecordStringNever": { "docs": "Construct a type with a set of properties K of type T", + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.json", @@ -1375,6 +1396,7 @@ }, "Room": { "docs": undefined, + "inline": undefined, "properties": { "allocations": "list", "appId": "AppId", @@ -1388,6 +1410,7 @@ }, "RoomAllocation": { "docs": undefined, + "inline": undefined, "properties": { "processId": "ProcessId", "roomAllocationId": "RoomAllocationId", @@ -1414,6 +1437,7 @@ "RoomWithoutAllocations": "OmitRoomAllocations", "StartingConnectionInfo": { "docs": undefined, + "inline": undefined, "properties": { "roomId": "RoomId", }, @@ -1942,6 +1966,7 @@ types: clientId: string source: openapi: ../openapi.json + inline: true ApplicationAuthConfiguration: properties: google: optional @@ -1949,6 +1974,7 @@ types: anonymous: optional source: openapi: ../openapi.json + inline: true Application: properties: deletedBy: optional @@ -1991,6 +2017,7 @@ types: maxLength: 100 source: openapi: ../openapi.json + inline: true DeploymentConfig: properties: env: list @@ -2036,6 +2063,7 @@ types: clientId: string source: openapi: ../openapi.json + inline: true AppConfigAuthConfiguration: properties: google: optional @@ -2043,6 +2071,7 @@ types: anonymous: optional source: openapi: ../openapi.json + inline: true AppConfig: properties: authConfiguration: AppConfigAuthConfiguration @@ -2073,6 +2102,7 @@ types: region: Region source: openapi: ../openapi.json + inline: true BuildStatus: enum: - created @@ -2788,6 +2818,7 @@ service: "types": { "LoginAnonymousResponse": { "docs": undefined, + "inline": undefined, "properties": { "token": "string", }, @@ -2797,6 +2828,7 @@ service: }, "LoginGoogleResponse": { "docs": undefined, + "inline": undefined, "properties": { "token": "string", }, @@ -2806,6 +2838,7 @@ service: }, "LoginNicknameResponse": { "docs": undefined, + "inline": undefined, "properties": { "token": "string", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/hookdeck.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/hookdeck.json index 3027d419245..a5abcd54a1c 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/hookdeck.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/hookdeck.json @@ -2474,6 +2474,7 @@ "types": { "AlertRule": { "docs": undefined, + "inline": undefined, "properties": { "strategy": "AlertStrategy", }, @@ -2493,6 +2494,7 @@ }, "ApiErrorResponse": { "docs": "Error response model", + "inline": undefined, "properties": { "code": { "docs": "Error code", @@ -2514,6 +2516,7 @@ }, "ApiErrorResponseData": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -2521,6 +2524,7 @@ }, "ApiKeyIntegrationConfigs": { "docs": undefined, + "inline": undefined, "properties": { "api_key": "string", "header_key": "string", @@ -2531,6 +2535,7 @@ }, "AttachedIntegrationToSource": { "docs": undefined, + "inline": undefined, "properties": { "success": "boolean", }, @@ -2604,6 +2609,7 @@ }, "BasicAuthIntegrationConfigs": { "docs": undefined, + "inline": undefined, "properties": { "name": "string", "password": "string", @@ -2614,6 +2620,7 @@ }, "BatchOperation": { "docs": undefined, + "inline": undefined, "properties": { "cancelled_at": { "docs": "Date the bulk retry was cancelled", @@ -2679,6 +2686,7 @@ }, "BatchOperationPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -2690,6 +2698,7 @@ }, "BatchOperationPlan": { "docs": undefined, + "inline": undefined, "properties": { "estimated_batch": { "docs": "Number of batches required to complete the bulk retry", @@ -2712,6 +2721,7 @@ "discriminated": false, "docs": "Query object to filter records", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -2722,6 +2732,7 @@ }, "Bookmark": { "docs": undefined, + "inline": undefined, "properties": { "alias": { "docs": "Alternate alias for the bookmark", @@ -2767,6 +2778,7 @@ }, "BookmarkPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -2778,6 +2790,7 @@ }, "Connection": { "docs": undefined, + "inline": undefined, "properties": { "archived_at": { "docs": "Date the connection was archived", @@ -2827,6 +2840,7 @@ "discriminated": false, "docs": "JSON using our filter syntax to filter on request headers", "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -2839,6 +2853,7 @@ }, "ConnectionFilterPropertyThree": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -2846,6 +2861,7 @@ }, "ConnectionPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -2857,6 +2873,7 @@ }, "ConsoleLine": { "docs": undefined, + "inline": undefined, "properties": { "message": "string", "type": "ConsoleLineType", @@ -2879,6 +2896,7 @@ }, "DelayRule": { "docs": undefined, + "inline": undefined, "properties": { "delay": { "docs": "Delay to introduce in MS", @@ -2891,6 +2909,7 @@ }, "DeletedBookmarkResponse": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "Bookmark ID", @@ -2903,6 +2922,7 @@ }, "DeletedIntegration": { "docs": undefined, + "inline": undefined, "properties": { "id": "string", }, @@ -2912,6 +2932,7 @@ }, "DeletedIssueTriggerResponse": { "docs": undefined, + "inline": undefined, "properties": { "id": "string", }, @@ -2921,6 +2942,7 @@ }, "DeliveryIssue": { "docs": "Delivery issue", + "inline": undefined, "properties": { "aggregation_keys": "DeliveryIssueAggregationKeys", "auto_resolved_at": "optional", @@ -2970,6 +2992,7 @@ }, "DeliveryIssueAggregationKeys": { "docs": "Keys used as the aggregation keys a 'delivery' type issue", + "inline": undefined, "properties": { "error_code": "list", "response_status": "list", @@ -2981,6 +3004,7 @@ }, "DeliveryIssueData": { "docs": "Delivery issue data", + "inline": undefined, "properties": { "trigger_attempt": "optional", "trigger_event": "optional", @@ -2991,6 +3015,7 @@ }, "DeliveryIssueReference": { "docs": "Reference to the event and attempt an issue is being created for.", + "inline": undefined, "properties": { "attempt_id": "string", "event_id": "string", @@ -3001,6 +3026,7 @@ }, "DeliveryIssueWithData": { "docs": "Delivery issue", + "inline": undefined, "properties": { "aggregation_keys": "DeliveryIssueAggregationKeys", "auto_resolved_at": "optional", @@ -3051,6 +3077,7 @@ }, "Destination": { "docs": "Associated [Destination](#destination-object) object", + "inline": undefined, "properties": { "archived_at": { "docs": "Date the destination was archived", @@ -3097,6 +3124,7 @@ }, "DestinationPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -3120,6 +3148,7 @@ }, "DetachedIntegrationFromSource": { "docs": undefined, + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -3127,6 +3156,7 @@ }, "Event": { "docs": undefined, + "inline": undefined, "properties": { "attempts": { "docs": "Number of delivery attempts made", @@ -3200,6 +3230,7 @@ "EventArray": "list", "EventAttempt": { "docs": undefined, + "inline": undefined, "properties": { "archived_at": { "docs": "Date the attempt was archived", @@ -3277,6 +3308,7 @@ }, "EventAttemptBody": { "docs": "Response body from the destination", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -3284,6 +3316,7 @@ }, "EventAttemptPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>>", @@ -3295,6 +3328,7 @@ }, "EventData": { "docs": undefined, + "inline": true, "properties": { "body": "optional", "headers": "optional", @@ -3311,6 +3345,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3322,6 +3357,7 @@ }, "EventDataBodyOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -3331,6 +3367,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3343,6 +3380,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3353,6 +3391,7 @@ }, "EventDataParsedQueryOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -3360,6 +3399,7 @@ }, "EventPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -3383,6 +3423,7 @@ }, "FilterRule": { "docs": undefined, + "inline": undefined, "properties": { "body": "optional", "headers": "optional", @@ -3406,6 +3447,7 @@ }, "HandledHmacConfigs": { "docs": undefined, + "inline": undefined, "properties": { "webhook_secret_key": "string", }, @@ -3426,6 +3468,7 @@ }, "HmacIntegrationConfigs": { "docs": undefined, + "inline": undefined, "properties": { "algorithm": "HmacAlgorithms", "encoding": "HmacIntegrationConfigsEncoding", @@ -3447,6 +3490,7 @@ }, "IgnoredEvent": { "docs": undefined, + "inline": undefined, "properties": { "cause": "IgnoredEventCause", "created_at": "datetime", @@ -3476,6 +3520,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3486,6 +3531,7 @@ }, "IgnoredEventPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -3497,6 +3543,7 @@ }, "Integration": { "docs": undefined, + "inline": undefined, "properties": { "configs": { "docs": "Decrypted Key/Value object of the associated configuration for that provider", @@ -3540,6 +3587,7 @@ "discriminated": false, "docs": "Decrypted Key/Value object of the associated configuration for that provider", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3563,6 +3611,7 @@ }, "IntegrationPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -3622,6 +3671,7 @@ }, "IssueCount": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "Number of issues", @@ -3646,6 +3696,7 @@ }, "IssueTrigger": { "docs": undefined, + "inline": undefined, "properties": { "channels": "optional", "configs": "IssueTriggerReference", @@ -3685,6 +3736,7 @@ }, "IssueTriggerBackpressureConfigs": { "docs": "Configurations for a 'Backpressure' issue trigger", + "inline": undefined, "properties": { "delay": "IssueTriggerBackpressureDelay", "destinations": { @@ -3700,6 +3752,7 @@ "discriminated": false, "docs": "A pattern to match on the destination name or array of destination IDs. Use `*` as wildcard.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3721,6 +3774,7 @@ }, "IssueTriggerChannels": { "docs": "Notification channels object for the specific channel type", + "inline": undefined, "properties": { "email": "optional", "opsgenie": "optional", @@ -3732,6 +3786,7 @@ }, "IssueTriggerDeliveryConfigs": { "docs": "Configurations for a 'delivery' issue trigger", + "inline": undefined, "properties": { "connections": { "docs": "A pattern to match on the connection name or array of connection IDs. Use `*` as wildcard.", @@ -3747,6 +3802,7 @@ "discriminated": false, "docs": "A pattern to match on the connection name or array of connection IDs. Use `*` as wildcard.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3757,6 +3813,7 @@ }, "IssueTriggerEmailChannel": { "docs": "Email channel for an issue trigger", + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -3764,6 +3821,7 @@ }, "IssueTriggerIntegrationChannel": { "docs": "Integration channel for an issue trigger", + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -3771,6 +3829,7 @@ }, "IssueTriggerPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -3784,6 +3843,7 @@ "discriminated": false, "docs": "Configuration object for the specific issue type selected", "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -3795,6 +3855,7 @@ }, "IssueTriggerSlackChannel": { "docs": "Slack channel for an issue trigger", + "inline": undefined, "properties": { "channel_name": { "docs": "Channel name", @@ -3817,6 +3878,7 @@ }, "IssueTriggerTransformationConfigs": { "docs": "Configurations for a 'Transformation' issue trigger", + "inline": undefined, "properties": { "log_level": "TransformationExecutionLogLevel", "transformations": { @@ -3832,6 +3894,7 @@ "discriminated": false, "docs": "A pattern to match on the transformation name or array of transformation IDs. Use `*` as wildcard.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3867,6 +3930,7 @@ }, "IssueWithDataPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -3887,6 +3951,7 @@ }, "RawBody": { "docs": undefined, + "inline": undefined, "properties": { "body": "string", }, @@ -3896,6 +3961,7 @@ }, "Request": { "docs": undefined, + "inline": undefined, "properties": { "cli_events_count": { "docs": "The count of CLI events created from this request", @@ -3960,6 +4026,7 @@ }, "RequestData": { "docs": undefined, + "inline": true, "properties": { "body": "optional", "headers": "optional", @@ -3976,6 +4043,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3987,6 +4055,7 @@ }, "RequestDataBodyOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -3996,6 +4065,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -4008,6 +4078,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -4018,6 +4089,7 @@ }, "RequestDataParsedQueryOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4035,6 +4107,7 @@ }, "RequestPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -4062,6 +4135,7 @@ }, "RetriedEvent": { "docs": undefined, + "inline": undefined, "properties": { "attempt": "optional", "event": "Event", @@ -4072,6 +4146,7 @@ }, "RetryRequest": { "docs": undefined, + "inline": undefined, "properties": { "events": "optional>", "request": "Request", @@ -4082,6 +4157,7 @@ }, "RetryRule": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "Maximum number of retries to attempt", @@ -4126,6 +4202,7 @@ }, "Ruleset": { "docs": "Associated [Ruleset](#ruleset-object) object", + "inline": undefined, "properties": { "archived_at": { "docs": "Date the ruleset was archived", @@ -4166,6 +4243,7 @@ }, "RulesetPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>>", @@ -4177,6 +4255,7 @@ }, "SeekPagination": { "docs": undefined, + "inline": undefined, "properties": { "dir": "optional", "limit": "optional", @@ -4192,6 +4271,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -4204,6 +4284,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -4214,6 +4295,7 @@ }, "ShopifyIntegrationConfigs": { "docs": undefined, + "inline": undefined, "properties": { "api_key": "optional", "api_secret": "optional", @@ -4237,6 +4319,7 @@ }, "ShortEventData": { "docs": undefined, + "inline": undefined, "properties": { "body": "optional", "headers": "optional", @@ -4253,6 +4336,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -4264,6 +4348,7 @@ }, "ShortEventDataBodyOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4273,6 +4358,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -4285,6 +4371,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -4295,6 +4382,7 @@ }, "ShortEventDataParsedQueryOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4302,6 +4390,7 @@ }, "Source": { "docs": "Associated [Source](#source-object) object", + "inline": undefined, "properties": { "archived_at": { "docs": "Date the source was archived", @@ -4346,6 +4435,7 @@ }, "SourceIntegration": { "docs": "Integration object", + "inline": true, "properties": { "features": { "docs": "List of enabled features", @@ -4367,6 +4457,7 @@ }, "SourcePaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -4378,6 +4469,7 @@ }, "ToggleWebhookNotifications": { "docs": undefined, + "inline": undefined, "properties": { "enabled": "boolean", "source_id": "string", @@ -4413,6 +4505,7 @@ }, "TransformFull": { "docs": undefined, + "inline": undefined, "properties": { "transformation": { "docs": "You can optionally define a new transformation while creating a transform rule", @@ -4433,6 +4526,7 @@ }, "TransformFullTransformation": { "docs": "You can optionally define a new transformation while creating a transform rule", + "inline": true, "properties": { "code": { "docs": "A string representation of your JavaScript (ES6) code to run", @@ -4453,6 +4547,7 @@ }, "TransformReference": { "docs": undefined, + "inline": undefined, "properties": { "transformation_id": { "docs": "ID of the attached transformation object. Optional input, always set once the rule is defined", @@ -4471,6 +4566,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -4481,6 +4577,7 @@ }, "Transformation": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "JavaScript code to be executed", @@ -4519,6 +4616,7 @@ }, "TransformationExecution": { "docs": undefined, + "inline": undefined, "properties": { "created_at": "datetime", "id": "string", @@ -4553,6 +4651,7 @@ }, "TransformationExecutionPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -4564,6 +4663,7 @@ }, "TransformationExecutorOutput": { "docs": undefined, + "inline": undefined, "properties": { "console": "optional>", "execution_id": "optional", @@ -4578,6 +4678,7 @@ }, "TransformationExecutorOutputRequest": { "docs": undefined, + "inline": true, "properties": { "body": "optional", "headers": "optional", @@ -4593,6 +4694,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -4603,6 +4705,7 @@ }, "TransformationExecutorOutputRequestBodyOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4612,6 +4715,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -4624,6 +4728,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -4634,6 +4739,7 @@ }, "TransformationExecutorOutputRequestParsedQueryOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4643,6 +4749,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -4653,6 +4760,7 @@ }, "TransformationExecutorOutputRequestQueryZero": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4660,6 +4768,7 @@ }, "TransformationFailedMeta": { "docs": undefined, + "inline": undefined, "properties": { "transformation_id": "string", }, @@ -4669,6 +4778,7 @@ }, "TransformationIssue": { "docs": "Transformation issue", + "inline": undefined, "properties": { "aggregation_keys": "TransformationIssueAggregationKeys", "auto_resolved_at": "optional", @@ -4718,6 +4828,7 @@ }, "TransformationIssueAggregationKeys": { "docs": "Keys used as the aggregation keys a 'transformation' type issue", + "inline": undefined, "properties": { "log_level": "TransformationExecutionLogLevel", "transformation_id": "list", @@ -4728,6 +4839,7 @@ }, "TransformationIssueData": { "docs": "Transformation issue data", + "inline": undefined, "properties": { "transformation_execution": "TransformationExecution", "trigger_attempt": "optional", @@ -4738,6 +4850,7 @@ }, "TransformationIssueReference": { "docs": "Reference to the event request transformation an issue is being created for.", + "inline": undefined, "properties": { "transformation_execution_id": "string", "trigger_event_request_transformation_id": { @@ -4751,6 +4864,7 @@ }, "TransformationIssueWithData": { "docs": "Transformation issue", + "inline": undefined, "properties": { "aggregation_keys": "TransformationIssueAggregationKeys", "auto_resolved_at": "optional", @@ -4801,6 +4915,7 @@ }, "TransformationPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -6213,6 +6328,7 @@ types: - list source: openapi: ../openapi.yml + inline: true SeekPaginationDir: discriminated: false union: @@ -6220,6 +6336,7 @@ types: - list source: openapi: ../openapi.yml + inline: true SeekPagination: properties: order_by: optional @@ -6254,6 +6371,7 @@ types: - list source: openapi: ../openapi.yml + inline: true IssueTriggerDeliveryConfigs: docs: Configurations for a 'delivery' issue trigger properties: @@ -6285,6 +6403,7 @@ types: - list source: openapi: ../openapi.yml + inline: true IssueTriggerTransformationConfigs: docs: Configurations for a 'Transformation' issue trigger properties: @@ -6314,6 +6433,7 @@ types: - list source: openapi: ../openapi.yml + inline: true IssueTriggerBackpressureConfigs: docs: Configurations for a 'Backpressure' issue trigger properties: @@ -6399,6 +6519,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true ApiErrorResponse: docs: Error response model properties: @@ -6476,6 +6597,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true EventAttempt: properties: id: @@ -6548,6 +6670,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true ShortEventDataParsedQuery: discriminated: false union: @@ -6555,6 +6678,7 @@ types: - ShortEventDataParsedQueryOne source: openapi: ../openapi.yml + inline: true ShortEventDataHeaders: discriminated: false union: @@ -6562,10 +6686,12 @@ types: - map> source: openapi: ../openapi.yml + inline: true ShortEventDataBodyOne: properties: {} source: openapi: ../openapi.yml + inline: true ShortEventDataBody: discriminated: false union: @@ -6574,6 +6700,7 @@ types: - list source: openapi: ../openapi.yml + inline: true ShortEventData: properties: path: string @@ -6636,6 +6763,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true EventDataParsedQuery: discriminated: false union: @@ -6643,6 +6771,7 @@ types: - EventDataParsedQueryOne source: openapi: ../openapi.yml + inline: true EventDataHeaders: discriminated: false union: @@ -6650,10 +6779,12 @@ types: - map> source: openapi: ../openapi.yml + inline: true EventDataBodyOne: properties: {} source: openapi: ../openapi.yml + inline: true EventDataBody: discriminated: false union: @@ -6662,6 +6793,7 @@ types: - list source: openapi: ../openapi.yml + inline: true EventData: properties: path: string @@ -6672,6 +6804,7 @@ types: is_large_payload: optional source: openapi: ../openapi.yml + inline: true Event: properties: id: @@ -6811,6 +6944,7 @@ types: - optional source: openapi: ../openapi.yml + inline: true BatchOperation: properties: id: @@ -6982,6 +7116,7 @@ types: - ShopifyIntegrationConfigs source: openapi: ../openapi.yml + inline: true Integration: properties: id: @@ -7327,6 +7462,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true RequestDataParsedQuery: discriminated: false union: @@ -7334,6 +7470,7 @@ types: - RequestDataParsedQueryOne source: openapi: ../openapi.yml + inline: true RequestDataHeaders: discriminated: false union: @@ -7341,10 +7478,12 @@ types: - map> source: openapi: ../openapi.yml + inline: true RequestDataBodyOne: properties: {} source: openapi: ../openapi.yml + inline: true RequestDataBody: discriminated: false union: @@ -7353,6 +7492,7 @@ types: - list source: openapi: ../openapi.yml + inline: true RequestData: properties: path: string @@ -7363,6 +7503,7 @@ types: is_large_payload: optional source: openapi: ../openapi.yml + inline: true Request: properties: id: @@ -7453,6 +7594,7 @@ types: - TransformationFailedMeta source: openapi: ../openapi.yml + inline: true IgnoredEvent: properties: id: string @@ -7506,6 +7648,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true ConnectionFilterProperty: discriminated: false docs: JSON using our filter syntax to filter on request headers @@ -7554,6 +7697,7 @@ types: your transformation code source: openapi: ../openapi.yml + inline: true TransformFull: properties: type: @@ -7647,6 +7791,7 @@ types: type: list source: openapi: ../openapi.yml + inline: true Source: docs: Associated [Source](#source-object) object properties: @@ -7747,10 +7892,12 @@ types: - map source: openapi: ../openapi.yml + inline: true TransformationExecutorOutputRequestQueryZero: properties: {} source: openapi: ../openapi.yml + inline: true TransformationExecutorOutputRequestQuery: discriminated: false union: @@ -7758,10 +7905,12 @@ types: - string source: openapi: ../openapi.yml + inline: true TransformationExecutorOutputRequestParsedQueryOne: properties: {} source: openapi: ../openapi.yml + inline: true TransformationExecutorOutputRequestParsedQuery: discriminated: false union: @@ -7769,10 +7918,12 @@ types: - TransformationExecutorOutputRequestParsedQueryOne source: openapi: ../openapi.yml + inline: true TransformationExecutorOutputRequestBodyOne: properties: {} source: openapi: ../openapi.yml + inline: true TransformationExecutorOutputRequestBody: discriminated: false union: @@ -7780,6 +7931,7 @@ types: - TransformationExecutorOutputRequestBodyOne source: openapi: ../openapi.yml + inline: true TransformationExecutorOutputRequest: properties: headers: optional @@ -7789,6 +7941,7 @@ types: body: optional source: openapi: ../openapi.yml + inline: true TransformationExecutorOutput: properties: request_id: optional @@ -9273,6 +9426,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "types": { "CreateEventBulkRetryRequestQuery": { "docs": "Filter properties for the events to be included in the bulk retry", + "inline": true, "properties": { "attempts": { "docs": "Filter by number of attempts", @@ -9348,6 +9502,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "Filter by number of attempts", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -9367,6 +9522,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. }, "CreateEventBulkRetryRequestQueryAttemptsAny": { "docs": undefined, + "inline": true, "properties": { "any": "optional", "contains": { @@ -9428,6 +9584,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "URL Encoded string of the JSON to match to the data body", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -9438,6 +9595,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. }, "CreateEventBulkRetryRequestQueryBodyOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -9447,6 +9605,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -9467,6 +9626,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "Filter by CLI IDs. `?[any]=true` operator for any CLI.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -9478,6 +9638,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. }, "CreateEventBulkRetryRequestQueryCliIdAny": { "docs": undefined, + "inline": true, "properties": { "any": "optional", }, @@ -9489,6 +9650,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -9501,6 +9663,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "Filter by `created_at` date using a date operator", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -9511,6 +9674,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. }, "CreateEventBulkRetryRequestQueryCreatedAtAny": { "docs": undefined, + "inline": true, "properties": { "any": "optional", "gt": "optional", @@ -9526,6 +9690,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "Filter by destination IDs", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -9547,6 +9712,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -9567,6 +9733,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -9587,6 +9754,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "URL Encoded string of the JSON to match to the data headers", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -9597,6 +9765,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. }, "CreateEventBulkRetryRequestQueryHeadersOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -9606,6 +9775,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "Filter by event IDs", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -9627,6 +9797,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -9647,6 +9818,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "Filter by `last_attempt_at` date using a date operator", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -9657,6 +9829,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. }, "CreateEventBulkRetryRequestQueryLastAttemptAtAny": { "docs": undefined, + "inline": true, "properties": { "any": "optional", "gt": "optional", @@ -9672,6 +9845,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "URL Encoded string of the JSON to match to the parsed query (JSON representation of the query)", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -9682,6 +9856,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. }, "CreateEventBulkRetryRequestQueryParsedQueryOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -9691,6 +9866,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "Filter by HTTP response status code", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -9711,6 +9887,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. }, "CreateEventBulkRetryRequestQueryResponseStatusAny": { "docs": undefined, + "inline": true, "properties": { "any": "optional", "contains": { @@ -9772,6 +9949,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "Filter by source IDs", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -9793,6 +9971,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "Lifecyle status of the event", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -9805,6 +9984,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "Filter by `successful_at` date using a date operator", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -9815,6 +9995,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. }, "CreateEventBulkRetryRequestQuerySuccessfulAtAny": { "docs": undefined, + "inline": true, "properties": { "any": "optional", "gt": "optional", @@ -9830,6 +10011,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "Filter by webhook connection IDs", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -9879,6 +10061,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryStatus: discriminated: false docs: Lifecyle status of the event @@ -9887,6 +10070,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryIssueId: discriminated: false union: @@ -9896,6 +10080,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryWebhookId: discriminated: false docs: Filter by webhook connection IDs @@ -9907,6 +10092,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryDestinationId: discriminated: false docs: Filter by destination IDs @@ -9918,6 +10104,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQuerySourceId: discriminated: false docs: Filter by source IDs @@ -9929,6 +10116,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryAttemptsAny: properties: gt: @@ -9954,6 +10142,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. min: 0 source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryAttempts: discriminated: false docs: Filter by number of attempts @@ -9964,6 +10153,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - CreateEventBulkRetryRequestQueryAttemptsAny source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryResponseStatusAny: properties: gt: @@ -9994,6 +10184,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. max: 600 source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryResponseStatus: discriminated: false docs: Filter by HTTP response status code @@ -10006,6 +10197,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQuerySuccessfulAtAny: properties: gt: optional @@ -10015,6 +10207,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. any: optional source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQuerySuccessfulAt: discriminated: false docs: Filter by `successful_at` date using a date operator @@ -10023,6 +10216,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - CreateEventBulkRetryRequestQuerySuccessfulAtAny source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryCreatedAtAny: properties: gt: optional @@ -10032,6 +10226,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. any: optional source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryCreatedAt: discriminated: false docs: Filter by `created_at` date using a date operator @@ -10040,6 +10235,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - CreateEventBulkRetryRequestQueryCreatedAtAny source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryErrorCode: discriminated: false union: @@ -10049,11 +10245,13 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryCliIdAny: properties: any: optional source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryCliId: discriminated: false docs: Filter by CLI IDs. `?[any]=true` operator for any CLI. @@ -10063,6 +10261,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryCliUserId: discriminated: false union: @@ -10070,6 +10269,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryLastAttemptAtAny: properties: gt: optional @@ -10079,6 +10279,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. any: optional source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryLastAttemptAt: discriminated: false docs: Filter by `last_attempt_at` date using a date operator @@ -10087,6 +10288,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - CreateEventBulkRetryRequestQueryLastAttemptAtAny source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryEventDataId: discriminated: false union: @@ -10096,10 +10298,12 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryHeadersOne: properties: {} source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryHeaders: discriminated: false docs: URL Encoded string of the JSON to match to the data headers @@ -10108,10 +10312,12 @@ docs: A bookmark lets you conveniently store and replay a specific request. - CreateEventBulkRetryRequestQueryHeadersOne source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryBodyOne: properties: {} source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryBody: discriminated: false docs: URL Encoded string of the JSON to match to the data body @@ -10120,10 +10326,12 @@ docs: A bookmark lets you conveniently store and replay a specific request. - CreateEventBulkRetryRequestQueryBodyOne source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryParsedQueryOne: properties: {} source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryParsedQuery: discriminated: false docs: >- @@ -10134,6 +10342,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - CreateEventBulkRetryRequestQueryParsedQueryOne source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryBulkRetryId: discriminated: false union: @@ -10143,6 +10352,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQuery: docs: Filter properties for the events to be included in the bulk retry properties: @@ -10200,6 +10410,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. docs: URL Encoded string of the string to match partially to the path source: openapi: ../openapi.yml + inline: true imports: root: __package__.yml service: @@ -10696,6 +10907,7 @@ docs: '' "types": { "CreateIgnoredEventBulkRetryRequestQuery": { "docs": "Filter by the bulk retry ignored event query object", + "inline": true, "properties": { "cause": { "docs": "The cause of the ignored event", @@ -10724,6 +10936,7 @@ docs: '' "discriminated": false, "docs": "The cause of the ignored event", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -10744,6 +10957,7 @@ docs: '' "discriminated": false, "docs": "Connection ID of the ignored event", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -10791,6 +11005,7 @@ docs: '' - list source: openapi: ../openapi.yml + inline: true CreateIgnoredEventBulkRetryRequestQueryWebhookId: discriminated: false docs: Connection ID of the ignored event @@ -10801,6 +11016,7 @@ docs: '' - list source: openapi: ../openapi.yml + inline: true CreateIgnoredEventBulkRetryRequestQuery: docs: Filter by the bulk retry ignored event query object properties: @@ -10819,6 +11035,7 @@ docs: '' maxLength: 255 source: openapi: ../openapi.yml + inline: true imports: root: __package__.yml service: @@ -11313,6 +11530,7 @@ docs: '' "types": { "CreateRequestBulkRetryRequestQuery": { "docs": "Filter properties for the events to be included in the bulk retry, use query parameters of [Requests](#requests)", + "inline": true, "properties": { "body": { "docs": "URL Encoded string of the JSON to match to the data body", @@ -11361,6 +11579,7 @@ docs: '' "discriminated": false, "docs": "URL Encoded string of the JSON to match to the data body", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -11371,6 +11590,7 @@ docs: '' }, "CreateRequestBulkRetryRequestQueryBodyOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -11380,6 +11600,7 @@ docs: '' "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -11400,6 +11621,7 @@ docs: '' "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -11410,6 +11632,7 @@ docs: '' }, "CreateRequestBulkRetryRequestQueryCreatedAtAny": { "docs": undefined, + "inline": true, "properties": { "any": "optional", "gt": "optional", @@ -11425,6 +11648,7 @@ docs: '' "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -11445,6 +11669,7 @@ docs: '' }, "CreateRequestBulkRetryRequestQueryEventsCountAny": { "docs": undefined, + "inline": true, "properties": { "any": "optional", "contains": { @@ -11506,6 +11731,7 @@ docs: '' "discriminated": false, "docs": "URL Encoded string of the JSON to match to the data headers", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -11516,6 +11742,7 @@ docs: '' }, "CreateRequestBulkRetryRequestQueryHeadersOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -11525,6 +11752,7 @@ docs: '' "discriminated": false, "docs": "Filter by requests IDs", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -11546,6 +11774,7 @@ docs: '' "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -11566,6 +11795,7 @@ docs: '' }, "CreateRequestBulkRetryRequestQueryIgnoredCountAny": { "docs": undefined, + "inline": true, "properties": { "any": "optional", "contains": { @@ -11627,6 +11857,7 @@ docs: '' "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -11637,6 +11868,7 @@ docs: '' }, "CreateRequestBulkRetryRequestQueryIngestedAtAny": { "docs": undefined, + "inline": true, "properties": { "any": "optional", "gt": "optional", @@ -11652,6 +11884,7 @@ docs: '' "discriminated": false, "docs": "URL Encoded string of the JSON to match to the parsed query (JSON representation of the query)", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -11662,6 +11895,7 @@ docs: '' }, "CreateRequestBulkRetryRequestQueryParsedQueryOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -11671,6 +11905,7 @@ docs: '' "discriminated": false, "docs": "Filter by rejection cause", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -11682,6 +11917,7 @@ docs: '' }, "CreateRequestBulkRetryRequestQueryRejectionCauseAny": { "docs": undefined, + "inline": true, "properties": { "any": "optional", "contains": "optional", @@ -11698,6 +11934,7 @@ docs: '' "discriminated": false, "docs": "Filter by source IDs", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -11756,6 +11993,7 @@ docs: '' - list source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryStatus: enum: - accepted @@ -11772,6 +12010,7 @@ docs: '' contains: optional source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryRejectionCause: discriminated: false docs: Filter by rejection cause @@ -11781,6 +12020,7 @@ docs: '' - list source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryIgnoredCountAny: properties: gt: @@ -11806,6 +12046,7 @@ docs: '' min: 0 source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryIgnoredCount: discriminated: false union: @@ -11816,6 +12057,7 @@ docs: '' - list source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryEventsCountAny: properties: gt: @@ -11841,6 +12083,7 @@ docs: '' min: 0 source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryEventsCount: discriminated: false union: @@ -11851,6 +12094,7 @@ docs: '' - list source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQuerySourceId: discriminated: false docs: Filter by source IDs @@ -11862,10 +12106,12 @@ docs: '' - list source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryHeadersOne: properties: {} source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryHeaders: discriminated: false docs: URL Encoded string of the JSON to match to the data headers @@ -11874,10 +12120,12 @@ docs: '' - CreateRequestBulkRetryRequestQueryHeadersOne source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryBodyOne: properties: {} source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryBody: discriminated: false docs: URL Encoded string of the JSON to match to the data body @@ -11886,10 +12134,12 @@ docs: '' - CreateRequestBulkRetryRequestQueryBodyOne source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryParsedQueryOne: properties: {} source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryParsedQuery: discriminated: false docs: >- @@ -11900,6 +12150,7 @@ docs: '' - CreateRequestBulkRetryRequestQueryParsedQueryOne source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryCreatedAtAny: properties: gt: optional @@ -11909,6 +12160,7 @@ docs: '' any: optional source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryCreatedAt: discriminated: false union: @@ -11916,6 +12168,7 @@ docs: '' - CreateRequestBulkRetryRequestQueryCreatedAtAny source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryIngestedAtAny: properties: gt: optional @@ -11925,6 +12178,7 @@ docs: '' any: optional source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryIngestedAt: discriminated: false union: @@ -11932,6 +12186,7 @@ docs: '' - CreateRequestBulkRetryRequestQueryIngestedAtAny source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryBulkRetryId: discriminated: false union: @@ -11941,6 +12196,7 @@ docs: '' - list source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQuery: docs: >- Filter properties for the events to be included in the bulk retry, use @@ -11980,6 +12236,7 @@ docs: '' bulk_retry_id: optional source: openapi: ../openapi.yml + inline: true imports: root: __package__.yml service: @@ -13287,6 +13544,7 @@ docs: '' "types": { "CreateConnectionRequestDestination": { "docs": "Destination input object", + "inline": true, "properties": { "cli_path": { "docs": "Path for the CLI destination", @@ -13333,6 +13591,7 @@ docs: '' }, "CreateConnectionRequestRuleset": { "docs": "Ruleset input object", + "inline": true, "properties": { "is_team_default": "optional", "name": { @@ -13356,6 +13615,7 @@ docs: '' }, "CreateConnectionRequestSource": { "docs": "Source input object", + "inline": true, "properties": { "name": { "docs": "A unique name for the source", @@ -13385,6 +13645,7 @@ docs: '' }, "UpdateConnectionRequestRuleset": { "docs": "Ruleset input object", + "inline": true, "properties": { "is_team_default": "optional", "name": { @@ -13408,6 +13669,7 @@ docs: '' }, "UpsertConnectionRequestDestination": { "docs": "Destination input object", + "inline": true, "properties": { "cli_path": { "docs": "Path for the CLI destination", @@ -13454,6 +13716,7 @@ docs: '' }, "UpsertConnectionRequestRuleset": { "docs": "Ruleset input object", + "inline": true, "properties": { "is_team_default": "optional", "name": { @@ -13477,6 +13740,7 @@ docs: '' }, "UpsertConnectionRequestSource": { "docs": "Source input object", + "inline": true, "properties": { "name": { "docs": "A unique name for the source", @@ -13535,6 +13799,7 @@ docs: '' path_forwarding_disabled: optional source: openapi: ../openapi.yml + inline: true CreateConnectionRequestSource: docs: Source input object properties: @@ -13546,6 +13811,7 @@ docs: '' maxLength: 155 source: openapi: ../openapi.yml + inline: true CreateConnectionRequestRuleset: docs: Ruleset input object properties: @@ -13561,6 +13827,7 @@ docs: '' is_team_default: optional source: openapi: ../openapi.yml + inline: true UpsertConnectionRequestDestinationRateLimitPeriod: enum: - second @@ -13593,6 +13860,7 @@ docs: '' path_forwarding_disabled: optional source: openapi: ../openapi.yml + inline: true UpsertConnectionRequestSource: docs: Source input object properties: @@ -13604,6 +13872,7 @@ docs: '' maxLength: 155 source: openapi: ../openapi.yml + inline: true UpsertConnectionRequestRuleset: docs: Ruleset input object properties: @@ -13619,6 +13888,7 @@ docs: '' is_team_default: optional source: openapi: ../openapi.yml + inline: true UpdateConnectionRequestRuleset: docs: Ruleset input object properties: @@ -13634,6 +13904,7 @@ docs: '' is_team_default: optional source: openapi: ../openapi.yml + inline: true imports: root: __package__.yml service: @@ -16428,6 +16699,7 @@ docs: An event is any request that Hookdeck receives from a source. "discriminated": false, "docs": "Decrypted Key/Value object of the associated configuration for that provider", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -16443,6 +16715,7 @@ docs: An event is any request that Hookdeck receives from a source. "discriminated": false, "docs": "Decrypted Key/Value object of the associated configuration for that provider", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -16744,6 +17017,7 @@ types: - root.ShopifyIntegrationConfigs source: openapi: ../openapi.yml + inline: true UpdateIntegrationRequestConfigs: discriminated: false docs: >- @@ -16757,6 +17031,7 @@ types: - root.ShopifyIntegrationConfigs source: openapi: ../openapi.yml + inline: true ", }, "issueTriggers.yml": { @@ -17255,6 +17530,7 @@ types: "discriminated": false, "docs": "Configuration object for the specific issue type selected", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -17280,6 +17556,7 @@ types: "discriminated": false, "docs": "Configuration object for the specific issue type selected", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -17293,6 +17570,7 @@ types: "discriminated": false, "docs": "Configuration object for the specific issue type selected", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -17324,6 +17602,7 @@ types: - root.IssueTriggerBackpressureConfigs source: openapi: ../openapi.yml + inline: true UpsertIssueTriggerRequestConfigs: discriminated: false docs: Configuration object for the specific issue type selected @@ -17333,6 +17612,7 @@ types: - root.IssueTriggerBackpressureConfigs source: openapi: ../openapi.yml + inline: true UpdateIssueTriggerRequestConfigs: discriminated: false docs: Configuration object for the specific issue type selected @@ -17342,6 +17622,7 @@ types: - root.IssueTriggerBackpressureConfigs source: openapi: ../openapi.yml + inline: true service: auth: false base-path: '' @@ -21860,6 +22141,7 @@ docs: A source represents any third party that sends webhooks to Hookdeck. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -21901,6 +22183,7 @@ docs: A source represents any third party that sends webhooks to Hookdeck. }, "TestTransformationRequestEnv": { "docs": "Key-value environment variables to be passed to the transformation", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -21908,6 +22191,7 @@ docs: A source represents any third party that sends webhooks to Hookdeck. }, "TestTransformationRequestRequest": { "docs": "Request input to use for the transformation execution", + "inline": true, "properties": { "body": { "docs": "Body of the request", @@ -21938,6 +22222,7 @@ docs: A source represents any third party that sends webhooks to Hookdeck. "discriminated": false, "docs": "Body of the request", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -21948,6 +22233,7 @@ docs: A source represents any third party that sends webhooks to Hookdeck. }, "TestTransformationRequestRequestBodyZero": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -21955,6 +22241,7 @@ docs: A source represents any third party that sends webhooks to Hookdeck. }, "TestTransformationRequestRequestParsedQuery": { "docs": "JSON representation of the query params", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -21964,6 +22251,7 @@ docs: A source represents any third party that sends webhooks to Hookdeck. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -21976,6 +22264,7 @@ docs: A source represents any third party that sends webhooks to Hookdeck. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -22001,6 +22290,7 @@ docs: A source represents any third party that sends webhooks to Hookdeck. - float source: openapi: ../openapi.yml + inline: true UpsertTransformationRequestEnvValue: discriminated: false union: @@ -22008,6 +22298,7 @@ docs: A source represents any third party that sends webhooks to Hookdeck. - float source: openapi: ../openapi.yml + inline: true UpdateTransformationRequestEnvValue: discriminated: false union: @@ -22015,15 +22306,18 @@ docs: A source represents any third party that sends webhooks to Hookdeck. - float source: openapi: ../openapi.yml + inline: true TestTransformationRequestEnv: docs: Key-value environment variables to be passed to the transformation properties: {} source: openapi: ../openapi.yml + inline: true TestTransformationRequestRequestBodyZero: properties: {} source: openapi: ../openapi.yml + inline: true TestTransformationRequestRequestBody: discriminated: false docs: Body of the request @@ -22032,11 +22326,13 @@ docs: A source represents any third party that sends webhooks to Hookdeck. - string source: openapi: ../openapi.yml + inline: true TestTransformationRequestRequestParsedQuery: docs: JSON representation of the query params properties: {} source: openapi: ../openapi.yml + inline: true TestTransformationRequestRequest: docs: Request input to use for the transformation execution properties: @@ -22057,6 +22353,7 @@ docs: A source represents any third party that sends webhooks to Hookdeck. docs: JSON representation of the query params source: openapi: ../openapi.yml + inline: true GetTransformationExecutionsRequestLogLevel: enum: - debug diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/humanloop.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/humanloop.json index 5e200c13003..3776a029cf4 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/humanloop.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/humanloop.json @@ -658,6 +658,7 @@ "types": { "AgentConfigResponse": { "docs": undefined, + "inline": undefined, "properties": { "agent_class": { "docs": "Class of the agent.", @@ -703,6 +704,7 @@ "BooleanEvaluatorVersionStats": { "docs": "Base attributes for stats for an Evaluator Version-Evaluated Version pair in the Evaluation Report.", + "inline": undefined, "properties": { "evaluator_version_id": { "docs": "Unique identifier for the Evaluator Version.", @@ -739,6 +741,7 @@ in the Evaluation Report.", }, "CategoricalFeedbackLabel": { "docs": undefined, + "inline": undefined, "properties": { "sentiment": { "docs": "Whether the feedback sentiment is positive or negative.", @@ -756,6 +759,7 @@ in the Evaluation Report.", }, "ChatMessage": { "docs": undefined, + "inline": undefined, "properties": { "content": { "docs": "The content of the message.", @@ -802,6 +806,7 @@ in the Evaluation Report.", }, "ChatMessageWithToolCall": { "docs": undefined, + "inline": undefined, "properties": { "content": { "docs": "The content of the message.", @@ -865,6 +870,7 @@ in the Evaluation Report.", }, "CodeEvaluatorRequest": { "docs": undefined, + "inline": undefined, "properties": { "arguments_type": { "docs": "Whether this evaluator is target-free or target-required.", @@ -885,6 +891,7 @@ in the Evaluation Report.", }, "CommitRequest": { "docs": undefined, + "inline": undefined, "properties": { "commit_message": { "docs": "Message describing the changes made.", @@ -926,6 +933,7 @@ in the Evaluation Report.", "discriminated": false, "docs": "The content of the message.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -936,6 +944,7 @@ in the Evaluation Report.", }, "CreateDatapointRequest": { "docs": undefined, + "inline": undefined, "properties": { "inputs": { "docs": "The inputs to the prompt template.", @@ -958,6 +967,7 @@ in the Evaluation Report.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -976,6 +986,7 @@ in the Evaluation Report.", Evaluation benchmark your Prompt/Tool Versions. With the Datapoints in a Dataset Version, Logs corresponding to the Datapoint and each Evaluated Version are evaluated by the specified Evaluator Versions. Aggregated statistics are then calculated and presented in the Evaluation.", + "inline": undefined, "properties": { "dataset": { "docs": "The Dataset Version to use in this Evaluation.", @@ -996,6 +1007,7 @@ Aggregated statistics are then calculated and presented in the Evaluation.", }, "CreatePromptLogResponse": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "String ID of log.", @@ -1020,6 +1032,7 @@ Aggregated statistics are then calculated and presented in the Evaluation.", }, "CreateToolLogResponse": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "String ID of log.", @@ -1044,6 +1057,7 @@ Aggregated statistics are then calculated and presented in the Evaluation.", }, "DashboardConfiguration": { "docs": undefined, + "inline": undefined, "properties": { "model_config_ids": { "type": "list", @@ -1059,6 +1073,7 @@ Aggregated statistics are then calculated and presented in the Evaluation.", }, "DatapointResponse": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "Unique identifier for the Datapoint. Starts with `dp_`.", @@ -1085,6 +1100,7 @@ Aggregated statistics are then calculated and presented in the Evaluation.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1099,6 +1115,7 @@ Aggregated statistics are then calculated and presented in the Evaluation.", }, "DatasetRequest": { "docs": undefined, + "inline": undefined, "properties": { "version_id": { "docs": "Unique identifier for the Dataset Version to use in this evaluation. Starts with `dsv_`.", @@ -1114,6 +1131,7 @@ Aggregated statistics are then calculated and presented in the Evaluation.", Attributes defined here are common to all File Responses and should be overridden in the inheriting classes with documentation and appropriate Field definitions.", + "inline": undefined, "properties": { "commit_message": { "docs": "Message describing the changes made. If provided, a committed version of the Dataset is created. Otherwise, an uncommitted version is created.", @@ -1167,6 +1185,7 @@ in the inheriting classes with documentation and appropriate Field definitions." }, "EnvironmentResponse": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "type": "datetime", @@ -1195,6 +1214,7 @@ in the inheriting classes with documentation and appropriate Field definitions." "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -1209,6 +1229,7 @@ in the inheriting classes with documentation and appropriate Field definitions." }, "EvaluateeRequest": { "docs": undefined, + "inline": undefined, "properties": { "batch_id": { "docs": "Unique identifier for the batch of Logs to include in the Evaluation Report.", @@ -1230,6 +1251,7 @@ in the inheriting classes with documentation and appropriate Field definitions." }, "EvaluateeResponse": { "docs": undefined, + "inline": undefined, "properties": { "batch_id": { "docs": "Unique identifier for the batch of Logs to include in the Evaluation Report. ", @@ -1251,6 +1273,7 @@ in the inheriting classes with documentation and appropriate Field definitions." "docs": "This is similar to an `EvaluationResult` but is ephemeral as it is only for synchronous debug runs. It does not have an ID, or a reference to an evaluation run or even an evaluation function.", + "inline": undefined, "properties": { "datapoint_id": { "type": "optional", @@ -1275,6 +1298,7 @@ function.", }, "EvaluationEvaluatorResponse": { "docs": undefined, + "inline": undefined, "properties": { "orchestrated": { "docs": "Whether the Evaluator is orchestrated by Humanloop. Default is `True`. If `False`, a log for the Evaluator should be submitted by the user via the API.", @@ -1290,6 +1314,7 @@ function.", }, "EvaluationResponse": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "type": "datetime", @@ -1333,6 +1358,7 @@ function.", }, "EvaluationResultResponse": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "type": "datetime", @@ -1372,6 +1398,7 @@ function.", }, "EvaluationStats": { "docs": undefined, + "inline": undefined, "properties": { "overall_stats": { "docs": "Stats for the Evaluation Report as a whole.", @@ -1401,6 +1428,7 @@ function.", }, "EvaluatorActivationDeactivationRequest": { "docs": undefined, + "inline": undefined, "properties": { "evaluators_to_activate": { "docs": "Monitoring Evaluators to activate. These will be automatically run on new Logs.", @@ -1419,6 +1447,7 @@ function.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1435,6 +1464,7 @@ function.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1459,6 +1489,7 @@ function.", }, "EvaluatorConfigResponse": { "docs": undefined, + "inline": undefined, "properties": { "arguments_type": { "docs": "Whether this evaluator is target-free or target-required.", @@ -1511,6 +1542,7 @@ function.", }, "EvaluatorRequest": { "docs": undefined, + "inline": undefined, "properties": { "orchestrated": { "default": true, @@ -1528,6 +1560,7 @@ function.", }, "EvaluatorResponse": { "docs": "Request model for creating a new Evaluator", + "inline": undefined, "properties": { "commit_message": { "docs": "Message describing the changes made.", @@ -1625,6 +1658,7 @@ function.", }, "FeedbackResponse": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "User defined timestamp for when the feedback was created. ", @@ -1661,6 +1695,7 @@ function.", "discriminated": false, "docs": "The type of feedback. The default feedback types available are 'rating', 'action', 'issue', 'correction', and 'comment'.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1675,6 +1710,7 @@ function.", "discriminated": false, "docs": "The feedback value to set. This would be the appropriate text for 'correction' or 'comment', or a label to apply for 'rating', 'action', or 'issue'.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1698,6 +1734,7 @@ function.", }, "FeedbackTypeModel": { "docs": undefined, + "inline": undefined, "properties": { "type": { "display-name": "Feedback type", @@ -1717,6 +1754,7 @@ function.", "discriminated": false, "docs": "The type of feedback. The default feedback types available are 'rating', 'action', 'issue', 'correction', and 'comment'.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1734,6 +1772,7 @@ function.", "discriminated": false, "docs": "The File that the deployed Version belongs to.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1754,6 +1793,7 @@ function.", }, "FunctionTool": { "docs": "A function tool to be called by the model where user owns runtime.", + "inline": undefined, "properties": { "arguments": { "type": "optional", @@ -1766,6 +1806,7 @@ function.", }, "FunctionToolChoice": { "docs": "A function tool to be called by the model where user owns runtime.", + "inline": undefined, "properties": { "name": "string", }, @@ -1775,6 +1816,7 @@ function.", }, "GenericConfigResponse": { "docs": undefined, + "inline": undefined, "properties": { "created_by": { "docs": "The user who created the config.", @@ -1807,6 +1849,7 @@ function.", }, "HTTPValidationError": { "docs": undefined, + "inline": undefined, "properties": { "detail": { "type": "optional>", @@ -1818,6 +1861,7 @@ function.", }, "HumanEvaluatorRequest": { "docs": undefined, + "inline": undefined, "properties": { "arguments_type": { "docs": "Whether this evaluator is target-free or target-required.", @@ -1834,6 +1878,7 @@ function.", }, "ImageChatContent": { "docs": undefined, + "inline": undefined, "properties": { "image_url": { "docs": "The message's image content.", @@ -1846,6 +1891,7 @@ function.", }, "ImageUrl": { "docs": undefined, + "inline": undefined, "properties": { "detail": { "docs": "Specify the detail level of the image provided to the model. For more details see: https://platform.openai.com/docs/guides/vision/low-or-high-fidelity-image-understanding", @@ -1873,6 +1919,7 @@ function.", }, "InputResponse": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "Type of input.", @@ -1887,6 +1934,7 @@ function.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1897,6 +1945,7 @@ function.", }, "LLMEvaluatorRequest": { "docs": undefined, + "inline": undefined, "properties": { "arguments_type": { "docs": "Whether this evaluator is target-free or target-required.", @@ -1931,6 +1980,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", }, "LinkedToolRequest": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "The description of the linked tool.", @@ -1959,6 +2009,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", }, "LinkedToolResponse": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "Description of the tool referenced by the model", @@ -1987,6 +2038,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", }, "ListDatasets": { "docs": undefined, + "inline": undefined, "properties": { "records": { "docs": "The list of Datasets.", @@ -1999,6 +2051,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", }, "ListEvaluators": { "docs": undefined, + "inline": undefined, "properties": { "records": { "docs": "The list of Evaluators.", @@ -2011,6 +2064,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", }, "ListPrompts": { "docs": undefined, + "inline": undefined, "properties": { "records": { "docs": "The list of Prompts.", @@ -2023,6 +2077,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", }, "ListTools": { "docs": undefined, + "inline": undefined, "properties": { "records": { "docs": "The list of Tools.", @@ -2035,6 +2090,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", }, "LogResponse": { "docs": "Request model for logging a datapoint.", + "inline": undefined, "properties": { "batch_ids": { "docs": "List of batch IDs the log belongs to.", @@ -2210,6 +2266,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", "discriminated": false, "docs": "Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'type': 'function', 'function': {name': }} forces the model to use the named function.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -2224,6 +2281,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", }, "MetricValueResponse": { "docs": undefined, + "inline": undefined, "properties": { "metric_id": "string", "metric_name": "string", @@ -2235,6 +2293,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", }, "ModelConfigRequest": { "docs": "Model config used for logging both chat and completion.", + "inline": undefined, "properties": { "chat_template": { "docs": "Messages prepended to the list of messages sent to the provider. These messages that will take your specified inputs to form your final request to the provider model. Input variables within the template should be specified with syntax: {{INPUT_NAME}}.", @@ -2321,6 +2380,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", "discriminated": false, "docs": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -2333,6 +2393,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -2349,6 +2410,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", "docs": "Model config request. Contains fields that are common to all (i.e. both chat and complete) endpoints.", + "inline": undefined, "properties": { "chat_template": { "docs": "Messages prepended to the list of messages sent to the provider. These messages that will take your specified inputs to form your final request to the provider model. NB: Input variables within the template should be specified with syntax: {{INPUT_NAME}}.", @@ -2441,6 +2503,7 @@ Contains fields that are common to all (i.e. both chat and complete) endpoints." "discriminated": false, "docs": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -2454,6 +2517,7 @@ Contains fields that are common to all (i.e. both chat and complete) endpoints." The subset of ToolConfig parameters received by the chat endpoint. Does not have things like the signature or setup schema.", + "inline": undefined, "properties": { "description": { "docs": "The description of the tool shown to the model.", @@ -2519,6 +2583,7 @@ Does not have things like the signature or setup schema.", }, "MonitoringEvaluatorEnvironmentRequest": { "docs": undefined, + "inline": undefined, "properties": { "environment_id": { "docs": "Unique identifier for the Environment. The Evaluator Version deployed to this Environment will be used for monitoring.", @@ -2535,6 +2600,7 @@ Does not have things like the signature or setup schema.", }, "MonitoringEvaluatorResponse": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "type": "datetime", @@ -2571,6 +2637,7 @@ Does not have things like the signature or setup schema.", }, "MonitoringEvaluatorVersionRequest": { "docs": undefined, + "inline": undefined, "properties": { "evaluator_version_id": { "docs": "Unique identifier for the Evaluator Version to be used for monitoring.", @@ -2584,6 +2651,7 @@ Does not have things like the signature or setup schema.", "NumericEvaluatorVersionStats": { "docs": "Base attributes for stats for an Evaluator Version-Evaluated Version pair in the Evaluation Report.", + "inline": undefined, "properties": { "evaluator_version_id": { "docs": "Unique identifier for the Evaluator Version.", @@ -2635,6 +2703,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "OverallStats": { "docs": undefined, + "inline": undefined, "properties": { "num_datapoints": { "docs": "The total number of Datapoints in the Evaluation Report's Dataset Version.", @@ -2655,6 +2724,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "PaginatedDataDatapointResponse": { "docs": undefined, + "inline": undefined, "properties": { "page": "integer", "records": { @@ -2669,6 +2739,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "PaginatedDataDatasetResponse": { "docs": undefined, + "inline": undefined, "properties": { "page": "integer", "records": { @@ -2683,6 +2754,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "PaginatedDataEvaluationResponse": { "docs": undefined, + "inline": undefined, "properties": { "page": "integer", "records": { @@ -2697,6 +2769,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "PaginatedDataPromptLogResponse": { "docs": undefined, + "inline": undefined, "properties": { "page": "integer", "records": { @@ -2711,6 +2784,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "PaginatedDataSessionResponse": { "docs": undefined, + "inline": undefined, "properties": { "page": "integer", "records": { @@ -2747,6 +2821,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "PromptCallLogResponse": { "docs": "Sample specific response details for a Prompt call", + "inline": undefined, "properties": { "created_at": { "docs": "User defined timestamp for when the log was created. ", @@ -2803,6 +2878,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "PromptCallResponse": { "docs": "Response model for a Prompt call with potentially multiple log samples.", + "inline": undefined, "properties": { "batches": { "docs": "Array of Batch Ids that this log is part of. Batches are used to group Logs together for offline Evaluations", @@ -2882,6 +2958,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", - `'required'` means the model can decide to call one or more of the provided tools. - `{'type': 'function', 'function': {name': }}` forces the model to use the named function.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -2896,6 +2973,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "PromptCallStreamResponse": { "docs": "Response model for calling Prompt in streaming mode.", + "inline": undefined, "properties": { "created_at": { "docs": "User defined timestamp for when the log was created. ", @@ -2964,6 +3042,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "PromptKernelRequest": { "docs": undefined, + "inline": undefined, "properties": { "endpoint": { "docs": "The provider model endpoint used.", @@ -3039,6 +3118,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", "discriminated": false, "docs": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3049,6 +3129,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "PromptLogResponse": { "docs": "Request for creating a Prompt log.", + "inline": undefined, "properties": { "batches": { "docs": "Array of Batch Ids that this log is part of. Batches are used to group Logs together for offline Evaluations", @@ -3176,6 +3257,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", - `'required'` means the model can decide to call one or more of the provided tools. - `{'type': 'function', 'function': {name': }}` forces the model to use the named function.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3190,6 +3272,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "PromptResponse": { "docs": "Request model for creating a new Prompt", + "inline": undefined, "properties": { "commit_message": { "docs": "Message describing the changes made.", @@ -3318,6 +3401,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", "discriminated": false, "docs": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3328,6 +3412,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "ProviderApiKeys": { "docs": undefined, + "inline": undefined, "properties": { "ai21": { "type": "optional", @@ -3357,6 +3442,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "ResponseFormat": { "docs": "Response format of the model.", + "inline": undefined, "properties": { "type": { "type": "literal<"json_object">", @@ -3368,6 +3454,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "SessionResponse": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "type": "datetime", @@ -3423,6 +3510,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", "discriminated": false, "docs": "For chat endpoint, provide a Chat template. For completion endpoint, provide a Prompt template. Input variables within the template should be specified with double curly bracket syntax: {{INPUT_NAME}}.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3433,6 +3521,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "TextChatContent": { "docs": undefined, + "inline": undefined, "properties": { "text": { "docs": "The message's text content.", @@ -3456,6 +3545,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "ToolCall": { "docs": "A tool call to be made.", + "inline": undefined, "properties": { "function": { "type": "FunctionTool", @@ -3471,6 +3561,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "ToolChoice": { "docs": "Tool choice to force the model to use a tool.", + "inline": undefined, "properties": { "function": { "type": "FunctionToolChoice", @@ -3488,6 +3579,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", The subset of ToolConfig parameters received by the chat endpoint. Does not have things like the signature or setup schema.", + "inline": undefined, "properties": { "description": { "docs": "The description of the tool shown to the model.", @@ -3527,6 +3619,7 @@ Does not have things like the signature or setup schema.", }, "ToolConfigResponse": { "docs": undefined, + "inline": undefined, "properties": { "created_by": { "docs": "The user who created the config.", @@ -3587,6 +3680,7 @@ Does not have things like the signature or setup schema.", }, "ToolFunction": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "Description of the tool referenced by the model", @@ -3607,6 +3701,7 @@ Does not have things like the signature or setup schema.", }, "ToolKernelRequest": { "docs": undefined, + "inline": undefined, "properties": { "function": { "docs": "Callable function specification of the Tool shown to the model for tool calling.", @@ -3627,6 +3722,7 @@ Does not have things like the signature or setup schema.", }, "ToolResponse": { "docs": "Request to create a new Tool.", + "inline": undefined, "properties": { "commit_message": { "docs": "Message describing the changes made.", @@ -3708,6 +3804,7 @@ Does not have things like the signature or setup schema.", }, "ToolResultResponse": { "docs": "A result from a tool used to populate the prompt template", + "inline": undefined, "properties": { "id": "string", "name": "string", @@ -3732,6 +3829,7 @@ V4 uses organization and inline. Those are deprecated and will be removed in fav }, "ToolTemplateResponse": { "docs": "Template for a Humanloop runnable tool.", + "inline": undefined, "properties": { "description": { "docs": "Description of the tool referenced by the model", @@ -3785,6 +3883,7 @@ V4 uses organization and inline. Those are deprecated and will be removed in fav }, "UserResponse": { "docs": undefined, + "inline": undefined, "properties": { "email_address": { "docs": "The User's email address.", @@ -3805,6 +3904,7 @@ V4 uses organization and inline. Those are deprecated and will be removed in fav }, "ValidationError": { "docs": undefined, + "inline": undefined, "properties": { "loc": { "type": "list", @@ -3820,6 +3920,7 @@ V4 uses organization and inline. Those are deprecated and will be removed in fav "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3832,6 +3933,7 @@ V4 uses organization and inline. Those are deprecated and will be removed in fav "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3844,6 +3946,7 @@ V4 uses organization and inline. Those are deprecated and will be removed in fav "discriminated": false, "docs": "The specific Version being referenced.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3864,6 +3967,7 @@ V4 uses organization and inline. Those are deprecated and will be removed in fav }, "VersionDeploymentResponse": { "docs": "A variable reference to the Version deployed to an Environment", + "inline": undefined, "properties": { "environment": { "docs": "The Environment that the Version is deployed to.", @@ -3881,6 +3985,7 @@ V4 uses organization and inline. Those are deprecated and will be removed in fav }, "VersionIdResponse": { "docs": "A reference to a specific Version by its ID", + "inline": undefined, "properties": { "version": { "display-name": "Version", @@ -3912,6 +4017,7 @@ V4 uses organization and inline. Those are deprecated and will be removed in fav }, "VersionStats": { "docs": "Stats for an Evaluated Version in the Evaluation Report.", + "inline": undefined, "properties": { "evaluator_version_stats": { "docs": "Stats for each Evaluator Version used to evaluate this Evaluated Version.", @@ -3934,6 +4040,7 @@ V4 uses organization and inline. Those are deprecated and will be removed in fav "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -4379,6 +4486,7 @@ types: - list source: openapi: ../openapi.yml + inline: true ChatMessage: properties: content: @@ -4491,6 +4599,7 @@ types: - list source: openapi: ../openapi.yml + inline: true CreateDatapointRequest: properties: inputs: @@ -4585,6 +4694,7 @@ types: - list source: openapi: ../openapi.yml + inline: true DatapointResponse: properties: inputs: @@ -4727,6 +4837,7 @@ types: - double source: openapi: ../openapi.yml + inline: true EvaluationDebugResultResponse: docs: >- This is similar to an `EvaluationResult` but is ephemeral as it is only @@ -4853,6 +4964,7 @@ types: - type: MonitoringEvaluatorEnvironmentRequest source: openapi: ../openapi.yml + inline: true EvaluatorActivationDeactivationRequestEvaluatorsToDeactivateItem: discriminated: false union: @@ -4860,6 +4972,7 @@ types: - type: MonitoringEvaluatorEnvironmentRequest source: openapi: ../openapi.yml + inline: true EvaluatorActivationDeactivationRequest: properties: evaluators_to_activate: @@ -5016,6 +5129,7 @@ types: - string source: openapi: ../openapi.yml + inline: true FeedbackResponseValue: discriminated: false docs: >- @@ -5027,6 +5141,7 @@ types: - string source: openapi: ../openapi.yml + inline: true FeedbackResponse: properties: type: @@ -5066,6 +5181,7 @@ types: - string source: openapi: ../openapi.yml + inline: true FeedbackTypeModel: properties: type: @@ -5275,6 +5391,7 @@ types: - double source: openapi: ../openapi.yml + inline: true LogResponseToolChoice: discriminated: false docs: >- @@ -5291,6 +5408,7 @@ types: - type: ToolChoice source: openapi: ../openapi.yml + inline: true LogResponse: docs: Request model for logging a datapoint. properties: @@ -5457,6 +5575,7 @@ types: - list source: openapi: ../openapi.yml + inline: true ModelConfigRequestToolsItem: discriminated: false union: @@ -5464,6 +5583,7 @@ types: - type: ModelConfigToolRequest source: openapi: ../openapi.yml + inline: true ModelConfigRequest: docs: Model config used for logging both chat and completion. properties: @@ -5564,6 +5684,7 @@ types: - list source: openapi: ../openapi.yml + inline: true ModelConfigResponse: docs: >- Model config request. @@ -5960,6 +6081,7 @@ types: - type: ToolChoice source: openapi: ../openapi.yml + inline: true PromptCallResponse: docs: Response model for a Prompt call with potentially multiple log samples. properties: @@ -6104,6 +6226,7 @@ types: - list source: openapi: ../openapi.yml + inline: true PromptKernelRequestStop: discriminated: false docs: >- @@ -6114,6 +6237,7 @@ types: - list source: openapi: ../openapi.yml + inline: true PromptKernelRequest: properties: model: @@ -6220,6 +6344,7 @@ types: - type: ToolChoice source: openapi: ../openapi.yml + inline: true PromptLogResponse: docs: Request for creating a Prompt log. properties: @@ -6349,6 +6474,7 @@ types: - list source: openapi: ../openapi.yml + inline: true PromptResponse: docs: Request model for creating a new Prompt properties: @@ -6735,6 +6861,7 @@ types: - integer source: openapi: ../openapi.yml + inline: true ValidationError: properties: loc: @@ -6753,6 +6880,7 @@ types: - type: EvaluatorResponse source: openapi: ../openapi.yml + inline: true VersionDeploymentResponse: docs: A variable reference to the Version deployed to an Environment properties: @@ -6775,6 +6903,7 @@ types: - type: EvaluatorResponse source: openapi: ../openapi.yml + inline: true VersionIdResponse: docs: A reference to a specific Version by its ID properties: @@ -6801,6 +6930,7 @@ types: - type: BooleanEvaluatorVersionStats source: openapi: ../openapi.yml + inline: true VersionStats: docs: Stats for an Evaluated Version in the Evaluation Report. properties: @@ -13801,6 +13931,7 @@ within the Prompt for monitoring purposes.", - `'required'` means the model can decide to call one or more of the provided tools. - `{'type': 'function', 'function': {name': }}` forces the model to use the named function.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -13821,6 +13952,7 @@ within the Prompt for monitoring purposes.", - `'required'` means the model can decide to call one or more of the provided tools. - `{'type': 'function', 'function': {name': }}` forces the model to use the named function.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -13837,6 +13969,7 @@ within the Prompt for monitoring purposes.", "discriminated": false, "docs": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -13849,6 +13982,7 @@ within the Prompt for monitoring purposes.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -13865,6 +13999,7 @@ within the Prompt for monitoring purposes.", "discriminated": false, "docs": "For chat endpoint, provide a Chat template. For completion endpoint, provide a Prompt template. Input variables within the template should be specified with double curly bracket syntax: {{INPUT_NAME}}.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -15148,6 +15283,7 @@ types: - list source: openapi: ../openapi.yml + inline: true PromptRequestStop: discriminated: false docs: >- @@ -15158,6 +15294,7 @@ types: - list source: openapi: ../openapi.yml + inline: true PromptLogRequestToolChoice: discriminated: false docs: >- @@ -15182,6 +15319,7 @@ types: - type: root.ToolChoice source: openapi: ../openapi.yml + inline: true PromptCallRequestToolChoice: discriminated: false docs: >- @@ -15206,6 +15344,7 @@ types: - type: root.ToolChoice source: openapi: ../openapi.yml + inline: true PromptsCallResponse: discriminated: false union: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/hume.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/hume.json index 74ab8cf13fa..85e3504dc4d 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/hume.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/hume.json @@ -261,6 +261,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "BoundingBox": { "docs": "A bounding box around a face.", + "inline": undefined, "properties": { "h": { "docs": "Bounding box height.", @@ -285,6 +286,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "BurstPrediction": { "docs": undefined, + "inline": undefined, "properties": { "descriptions": { "docs": "Modality-specific descriptive features and their scores.", @@ -302,6 +304,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "Completed": { "docs": undefined, + "inline": undefined, "properties": { "created_timestamp_ms": { "docs": "When this job was created (Unix timestamp in milliseconds).", @@ -330,6 +333,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "DescriptionsScore": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "Name of the descriptive feature being expressed.", @@ -355,6 +359,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "EmotionScore": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "Name of the emotion being expressed.", @@ -375,6 +380,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "Error": { "docs": undefined, + "inline": undefined, "properties": { "file": { "docs": "A file path relative to the top level source URL or file.", @@ -391,6 +397,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "Face": { "docs": undefined, + "inline": undefined, "properties": { "descriptions": "optional", "facs": "optional", @@ -432,6 +439,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "FacePrediction": { "docs": undefined, + "inline": undefined, "properties": { "box": "BoundingBox", "descriptions": { @@ -465,6 +473,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "FacemeshPrediction": { "docs": undefined, + "inline": undefined, "properties": { "emotions": { "docs": "A high-dimensional embedding in emotion space.", @@ -477,6 +486,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "FacsScore": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "Name of the FACS 2.0 feature being expressed.", @@ -493,6 +503,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "Failed": { "docs": undefined, + "inline": undefined, "properties": { "created_timestamp_ms": { "docs": "When this job was created (Unix timestamp in milliseconds).", @@ -517,6 +528,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "File": { "docs": undefined, + "inline": undefined, "properties": { "content_type": { "docs": "The content type of the file.", @@ -549,6 +561,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "GroupedPredictionsBurstPrediction": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals.", @@ -562,6 +575,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "GroupedPredictionsFacePrediction": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals.", @@ -575,6 +589,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "GroupedPredictionsFacemeshPrediction": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals.", @@ -588,6 +603,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "GroupedPredictionsLanguagePrediction": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals.", @@ -601,6 +617,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "GroupedPredictionsNerPrediction": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals.", @@ -614,6 +631,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "GroupedPredictionsProsodyPrediction": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals.", @@ -627,6 +645,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "InProgress": { "docs": undefined, + "inline": undefined, "properties": { "created_timestamp_ms": { "docs": "When this job was created (Unix timestamp in milliseconds).", @@ -643,6 +662,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "JobId": { "docs": undefined, + "inline": undefined, "properties": { "job_id": { "docs": "The ID of the started job.", @@ -661,6 +681,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "JobRequest": { "docs": undefined, + "inline": undefined, "properties": { "job_id": { "docs": "The ID associated with this job.", @@ -691,6 +712,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "Language": { "docs": undefined, + "inline": undefined, "properties": { "granularity": "optional", "identify_speakers": { @@ -707,6 +729,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "LanguagePrediction": { "docs": undefined, + "inline": undefined, "properties": { "confidence": { "docs": "Value between `0.0` and `1.0` that indicates our transcription model’s relative confidence in this text.", @@ -743,6 +766,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "Models": { "docs": undefined, + "inline": undefined, "properties": { "burst": "optional", "face": "optional", @@ -757,6 +781,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "ModelsPredictions": { "docs": undefined, + "inline": undefined, "properties": { "burst": "optional", "face": "optional", @@ -771,6 +796,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "Ner": { "docs": undefined, + "inline": undefined, "properties": { "identify_speakers": { "default": false, @@ -784,6 +810,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "NerPrediction": { "docs": undefined, + "inline": undefined, "properties": { "confidence": { "docs": "Value between `0.0` and `1.0` that indicates our transcription model’s relative confidence in this text.", @@ -830,6 +857,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "PositionInterval": { "docs": "Position of a segment of text within a larger document, measured in characters. Uses zero-based indexing. The beginning index is inclusive and the end index is exclusive.", + "inline": undefined, "properties": { "begin": { "docs": "The index of the first character in the text segment, inclusive.", @@ -846,6 +874,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "Prediction": { "docs": undefined, + "inline": undefined, "properties": { "file": { "docs": "A file path relative to the top level source URL or file.", @@ -859,6 +888,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "PredictionsOptionalNullBurstPrediction": { "docs": undefined, + "inline": undefined, "properties": { "grouped_predictions": "list", "metadata": "optional", @@ -869,6 +899,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "PredictionsOptionalNullFacePrediction": { "docs": undefined, + "inline": undefined, "properties": { "grouped_predictions": "list", "metadata": "optional", @@ -879,6 +910,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "PredictionsOptionalNullFacemeshPrediction": { "docs": undefined, + "inline": undefined, "properties": { "grouped_predictions": "list", "metadata": "optional", @@ -889,6 +921,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "PredictionsOptionalTranscriptionMetadataLanguagePrediction": { "docs": undefined, + "inline": undefined, "properties": { "grouped_predictions": "list", "metadata": "optional", @@ -899,6 +932,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "PredictionsOptionalTranscriptionMetadataNerPrediction": { "docs": undefined, + "inline": undefined, "properties": { "grouped_predictions": "list", "metadata": "optional", @@ -909,6 +943,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "PredictionsOptionalTranscriptionMetadataProsodyPrediction": { "docs": undefined, + "inline": undefined, "properties": { "grouped_predictions": "list", "metadata": "optional", @@ -919,6 +954,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "Prosody": { "docs": "NOTE: the `granularity` field is ignored if transcription is not enabled or if the `window` field has been set.", + "inline": undefined, "properties": { "granularity": "optional", "identify_speakers": { @@ -934,6 +970,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "ProsodyPrediction": { "docs": undefined, + "inline": undefined, "properties": { "confidence": { "docs": "Value between `0.0` and `1.0` that indicates our transcription model’s relative confidence in this text.", @@ -959,6 +996,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "Queued": { "docs": undefined, + "inline": undefined, "properties": { "created_timestamp_ms": { "docs": "When this job was created (Unix timestamp in milliseconds).", @@ -971,6 +1009,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "Request": { "docs": undefined, + "inline": undefined, "properties": { "callback_url": { "docs": "If provided, a `POST` request will be made to the URL with the generated predictions on completion or the error message on failure.", @@ -997,6 +1036,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "Results": { "docs": undefined, + "inline": undefined, "properties": { "errors": "list", "predictions": "list", @@ -1007,6 +1047,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "SentimentScore": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "Level of sentiment, ranging from `1` (negative) to `9` (positive)", @@ -1050,6 +1091,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive "extends": [ "File", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yaml", @@ -1057,6 +1099,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "SourceResult": { "docs": undefined, + "inline": undefined, "properties": { "error": { "docs": "An error message.", @@ -1074,6 +1117,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive "extends": [ "Url", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yaml", @@ -1100,6 +1144,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive "extends": [ "Completed", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yaml", @@ -1110,6 +1155,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive "extends": [ "Failed", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yaml", @@ -1120,6 +1166,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive "extends": [ "InProgress", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yaml", @@ -1130,6 +1177,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive "extends": [ "Queued", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yaml", @@ -1148,6 +1196,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "TimeInterval": { "docs": "A time range with a beginning and end, measured in seconds.", + "inline": undefined, "properties": { "begin": { "docs": "Beginning of time range in seconds.", @@ -1164,6 +1213,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "ToxicityScore": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "Category of toxicity.", @@ -1180,6 +1230,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "Transcription": { "docs": undefined, + "inline": undefined, "properties": { "language": "optional", }, @@ -1189,6 +1240,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "TranscriptionMetadata": { "docs": "Transcription metadata for your media file.", + "inline": undefined, "properties": { "confidence": { "docs": "Value between `0.0` and `1.0` indicating our transcription model’s relative confidence in the transcription of your media file.", @@ -1202,6 +1254,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "Url": { "docs": undefined, + "inline": undefined, "properties": { "url": { "docs": "The URL of the source media file.", @@ -1223,6 +1276,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "Window": { "docs": undefined, + "inline": undefined, "properties": { "length": { "default": 4, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/inline-path-parameters.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/inline-path-parameters.json index a47eed7d1b8..8a25286f6d0 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/inline-path-parameters.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/inline-path-parameters.json @@ -82,6 +82,7 @@ "types": { "GetOrganizationUserResponse": { "docs": undefined, + "inline": undefined, "properties": { "results": "optional>", }, @@ -218,6 +219,7 @@ types: }, "SearchResponse": { "docs": undefined, + "inline": undefined, "properties": { "results": "optional>", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/inline-schema-reference.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/inline-schema-reference.json index cd447628f4a..9bc1aa13acb 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/inline-schema-reference.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/inline-schema-reference.json @@ -43,6 +43,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -55,6 +56,7 @@ }, "GetExampleResponseMessage": { "docs": undefined, + "inline": true, "properties": { "message": "optional", }, @@ -64,6 +66,7 @@ }, "NotFound": { "docs": undefined, + "inline": true, "properties": { "message": "optional", }, @@ -73,6 +76,7 @@ }, "Schema1": { "docs": undefined, + "inline": undefined, "properties": { "id": "optional", "name": "optional", @@ -83,6 +87,7 @@ }, "Schema2": { "docs": undefined, + "inline": undefined, "properties": { "age": "optional", "email": "optional", @@ -99,11 +104,13 @@ message: optional source: openapi: ../openapi.yml + inline: true GetExampleResponseMessage: properties: message: optional source: openapi: ../openapi.yml + inline: true GetExampleResponse: discriminated: false union: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/intercom.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/intercom.json index f274f4bfc5f..b87a42d8959 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/intercom.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/intercom.json @@ -3943,6 +3943,7 @@ "types": { "ActivityLog": { "docs": "Activities performed by Admins.", + "inline": undefined, "properties": { "activity_description": { "docs": "A sentence or two describing the activity.", @@ -4047,6 +4048,7 @@ }, "ActivityLogList": { "docs": "A paginated list of activity logs.", + "inline": undefined, "properties": { "activity_logs": { "docs": "An array of activity logs", @@ -4066,6 +4068,7 @@ }, "ActivityLogMetadata": { "docs": "Additional data provided about Admin activity.", + "inline": undefined, "properties": { "auto_changed": { "docs": "Indicates if the status was changed automatically or manually.", @@ -4110,6 +4113,7 @@ }, "ActivityLogPerformedBy": { "docs": "Details about the Admin involved in the activity.", + "inline": true, "properties": { "email": { "docs": "The email of the admin.", @@ -4134,6 +4138,7 @@ }, "AddressableList": { "docs": "A list used to access other resources from a parent model.", + "inline": undefined, "properties": { "id": { "docs": "The id of the addressable object", @@ -4166,6 +4171,7 @@ }, "Admin": { "docs": "Admins are the teammate accounts that have access to a workspace", + "inline": undefined, "properties": { "app": { "docs": "App that the admin belongs to.", @@ -4222,6 +4228,7 @@ }, "AdminPriorityLevel": { "docs": "Admin priority levels for the team", + "inline": undefined, "properties": { "primary_admin_ids": { "docs": "The primary admin ids for the team", @@ -4238,6 +4245,7 @@ }, "AdminReplyConversationRequest": { "docs": "Payload of the request to reply on behalf of an admin", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is authoring the comment.", @@ -4277,6 +4285,7 @@ }, "AdminReplyTicketRequest": { "docs": "Payload of the request to reply on behalf of an admin", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is authoring the comment.", @@ -4317,6 +4326,7 @@ }, "AdminReplyTicketRequestReplyOptionsItem": { "docs": undefined, + "inline": true, "properties": { "text": { "docs": "The text to display in this quick reply option.", @@ -4339,6 +4349,7 @@ }, "AdminWithAppAvatar": { "docs": "This object represents the avatar associated with the admin.", + "inline": true, "properties": { "image_url": { "docs": "This object represents the avatar associated with the admin.", @@ -4362,6 +4373,7 @@ }, "Admins": { "docs": "A list of admins associated with a given workspace.", + "inline": undefined, "properties": { "admins": { "docs": "A list of admins associated with a given workspace.", @@ -4378,6 +4390,7 @@ }, "App": { "docs": "App is a workspace on Intercom", + "inline": undefined, "properties": { "created_at": { "docs": "When the app was created.", @@ -4415,6 +4428,7 @@ }, "ArticleContent": { "docs": "The Content of an Article.", + "inline": undefined, "properties": { "author_id": { "docs": "The ID of the author of the article.", @@ -4469,6 +4483,7 @@ }, "ArticleStatistics": { "docs": "The statistics of an article.", + "inline": undefined, "properties": { "conversions": { "docs": "The number of conversations started from the article.", @@ -4505,6 +4520,7 @@ }, "ArticleTranslatedContent": { "docs": "The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.", + "inline": undefined, "properties": { "ar": { "docs": "The content of the article in Arabic", @@ -4665,6 +4681,7 @@ }, "Articles": { "docs": "This will return a list of articles for the App.", + "inline": undefined, "properties": { "data": { "docs": "An array of Article objects", @@ -4688,6 +4705,7 @@ }, "AssignConversationRequest": { "docs": "Payload of the request to assign a conversation", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is performing the action.", @@ -4718,6 +4736,7 @@ }, "CloseConversationRequest": { "docs": "Payload of the request to close a conversation", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is performing the action.", @@ -4735,6 +4754,7 @@ }, "Collections": { "docs": "This will return a list of Collections for the App.", + "inline": undefined, "properties": { "data": { "docs": "An array of collection objects", @@ -4758,6 +4778,7 @@ }, "Companies": { "docs": "This will return a list of companies for the App.", + "inline": undefined, "properties": { "data": { "docs": "An array containing Company Objects.", @@ -4781,6 +4802,7 @@ }, "CompanyAttachedContacts": { "docs": "A list of Contact Objects", + "inline": undefined, "properties": { "data": { "docs": "An array containing Contact Objects", @@ -4804,6 +4826,7 @@ }, "CompanyAttachedSegments": { "docs": "A list of Segment Objects", + "inline": undefined, "properties": { "data": { "docs": "An array containing Segment Objects", @@ -4820,6 +4843,7 @@ }, "CompanyScroll": { "docs": "Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.", + "inline": undefined, "properties": { "data": { "type": "optional>", @@ -4846,6 +4870,7 @@ }, "ContactArchived": { "docs": "archived contact object", + "inline": undefined, "properties": { "archived": { "docs": "Whether the contact is archived or not.", @@ -4870,6 +4895,7 @@ }, "ContactAttachedCompanies": { "docs": "A list of Company Objects", + "inline": undefined, "properties": { "companies": { "docs": "An array containing Company Objects", @@ -4893,6 +4919,7 @@ }, "ContactCompanies": { "docs": "An object containing companies meta data about the companies that a contact has. Up to 10 will be displayed here. Use the url to get more.", + "inline": undefined, "properties": { "has_more": { "docs": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all", @@ -4919,6 +4946,7 @@ }, "ContactDeleted": { "docs": "deleted contact object", + "inline": undefined, "properties": { "deleted": { "docs": "Whether the contact is deleted or not.", @@ -4943,6 +4971,7 @@ }, "ContactList": { "docs": "Contacts are your users in Intercom.", + "inline": undefined, "properties": { "data": { "docs": "The list of contact objects", @@ -4966,6 +4995,7 @@ }, "ContactLocation": { "docs": "An object containing location meta data about a Intercom contact.", + "inline": undefined, "properties": { "city": { "docs": "The city that the contact is located in", @@ -4990,6 +5020,7 @@ }, "ContactNotes": { "docs": "An object containing notes meta data about the notes that a contact has. Up to 10 will be displayed here. Use the url to get more.", + "inline": undefined, "properties": { "data": { "docs": "This object represents the notes attached to a contact.", @@ -5020,6 +5051,7 @@ }, "ContactReference": { "docs": "reference to contact object", + "inline": undefined, "properties": { "external_id": { "docs": "The unique identifier for the contact which is provided by the Client.", @@ -5040,6 +5072,7 @@ }, "ContactReplyBaseRequest": { "docs": undefined, + "inline": undefined, "properties": { "attachment_urls": { "docs": "A list of image URLs that will be added as attachments. You can include up to 10 URLs.", @@ -5064,6 +5097,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -5084,6 +5118,7 @@ "extends": [ "ContactReplyBaseRequest", ], + "inline": undefined, "properties": { "attachment_files": { "docs": "A list of files that will be added as attachments.", @@ -5103,6 +5138,7 @@ "extends": [ "ContactReplyBaseRequest", ], + "inline": undefined, "properties": { "intercom_user_id": { "docs": "The identifier for the contact as given by Intercom.", @@ -5117,6 +5153,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -5137,6 +5174,7 @@ "extends": [ "ContactReplyBaseRequest", ], + "inline": undefined, "properties": { "user_id": { "docs": "The external_id you have defined for the contact.", @@ -5152,6 +5190,7 @@ "extends": [ "ContactReplyBaseRequest", ], + "inline": undefined, "properties": { "attachment_files": { "docs": "A list of files that will be added as attachments. You can include up to 10 files.", @@ -5168,6 +5207,7 @@ }, "ContactSocialProfiles": { "docs": "An object containing social profiles that a contact has.", + "inline": undefined, "properties": { "data": { "docs": "A list of social profiles objects associated with the contact.", @@ -5180,6 +5220,7 @@ }, "ContactSubscriptionTypes": { "docs": "An object containing Subscription Types meta data about the SubscriptionTypes that a contact has.", + "inline": undefined, "properties": { "data": { "docs": "This object represents the subscriptions attached to a contact.", @@ -5210,6 +5251,7 @@ }, "ContactTags": { "docs": "An object containing tags meta data about the tags that a contact has. Up to 10 will be displayed here. Use the url to get more.", + "inline": undefined, "properties": { "data": { "docs": "This object represents the tags attached to a contact.", @@ -5240,6 +5282,7 @@ }, "ContactUnarchived": { "docs": "unarchived contact object", + "inline": undefined, "properties": { "archived": { "docs": "Whether the contact is archived or not.", @@ -5264,6 +5307,7 @@ }, "Contacts": { "docs": "The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.", + "inline": undefined, "properties": { "contacts": { "docs": "The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.", @@ -5280,6 +5324,7 @@ }, "ContentSourcesList": { "docs": undefined, + "inline": undefined, "properties": { "content_sources": { "docs": "The content sources used by AI Agent in the conversation.", @@ -5299,6 +5344,7 @@ }, "ConversationAttachmentFiles": { "docs": "Properties of the attachment files in a conversation part", + "inline": undefined, "properties": { "content_type": { "docs": "The content type of the file", @@ -5319,6 +5365,7 @@ }, "ConversationFirstContactReply": { "docs": "An object containing information on the first users message. For a contact initiated message this will represent the users original message.", + "inline": undefined, "properties": { "created_at": { "docs": "", @@ -5339,6 +5386,7 @@ }, "ConversationList": { "docs": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.", + "inline": undefined, "properties": { "conversations": { "docs": "The list of conversation objects", @@ -5362,6 +5410,7 @@ }, "ConversationPart": { "docs": "A Conversation Part represents a message in the conversation.", + "inline": undefined, "properties": { "assigned_to": { "docs": "The id of the admin that was assigned the conversation by this conversation_part (null if there has been no change in assignment.)", @@ -5417,6 +5466,7 @@ }, "ConversationPartAuthor": { "docs": "The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank.", + "inline": undefined, "properties": { "email": { "docs": "The email of the author", @@ -5447,6 +5497,7 @@ }, "ConversationParts": { "docs": "A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.", + "inline": undefined, "properties": { "conversation_parts": { "docs": "A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.", @@ -5467,6 +5518,7 @@ }, "ConversationRating": { "docs": "The Conversation Rating object which contains information on the rating and/or remark added by a Contact and the Admin assigned to the conversation.", + "inline": undefined, "properties": { "contact": { "type": "optional", @@ -5493,6 +5545,7 @@ }, "ConversationSource": { "docs": "The Conversation Part that originated this conversation, which can be Contact, Admin, Campaign, Automated or Operator initiated.", + "inline": undefined, "properties": { "attachments": { "docs": "A list of attachments for the part.", @@ -5536,6 +5589,7 @@ }, "ConversationStatistics": { "docs": "A Statistics object containing all information required for reporting, with timestamps and calculated metrics.", + "inline": undefined, "properties": { "count_assignments": { "docs": "Number of assignments after first_contact_reply_at.", @@ -5620,6 +5674,7 @@ }, "ConversationTeammates": { "docs": "The list of teammates who participated in the conversation (wrote at least one conversation part).", + "inline": undefined, "properties": { "teammates": { "docs": "The list of teammates who participated in the conversation (wrote at least one conversation part).", @@ -5636,6 +5691,7 @@ }, "CreateArticleRequest": { "docs": "You can create an Article", + "inline": undefined, "properties": { "author_id": { "docs": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", @@ -5688,6 +5744,7 @@ "CreateMessageRequestOne": "unknown", "CreateOrUpdateCompanyRequest": { "docs": "You can create or update a Company", + "inline": undefined, "properties": { "company_id": { "docs": "The company id you have defined for the company. Can't be updated", @@ -5732,6 +5789,7 @@ }, "CreateOrUpdateTagRequest": { "docs": "You can create or update an existing tag.", + "inline": undefined, "properties": { "id": { "docs": "The id of tag to updates.", @@ -5748,6 +5806,7 @@ }, "CreatePhoneSwitchRequest": { "docs": "You can create an phone switch", + "inline": undefined, "properties": { "custom_attributes": { "type": "optional", @@ -5765,6 +5824,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -5781,6 +5841,7 @@ "docs": "The request payload for creating a ticket type. You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) ", + "inline": undefined, "properties": { "category": { "docs": "Category of the Ticket Type.", @@ -5827,6 +5888,7 @@ "docs": "Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed. ", + "inline": undefined, "properties": { "next": { "type": "optional", @@ -5860,6 +5922,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -5874,6 +5937,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -5891,6 +5955,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "CustomerRequestIntercomUserId": { "docs": undefined, + "inline": true, "properties": { "intercom_user_id": { "docs": "The identifier for the contact as given by Intercom.", @@ -5903,6 +5968,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "CustomerRequestUserId": { "docs": undefined, + "inline": true, "properties": { "user_id": { "docs": "The external_id you have defined for the contact who is being added as a participant.", @@ -5915,6 +5981,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DataAttributeList": { "docs": "A list of all data attributes belonging to a workspace for contacts, companies or conversations.", + "inline": undefined, "properties": { "data": { "docs": "A list of data attributes", @@ -5931,6 +5998,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DataEventList": { "docs": "This will return a list of data events for the App.", + "inline": undefined, "properties": { "events": { "docs": "A list of data events", @@ -5951,6 +6019,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DataEventListPages": { "docs": "Pagination", + "inline": true, "properties": { "next": "optional", "since": "optional", @@ -5961,6 +6030,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DataEventSummary": { "docs": "This will return a summary of data events for the App.", + "inline": undefined, "properties": { "email": { "docs": "The email address of the user", @@ -5989,6 +6059,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DataEventSummaryItem": { "docs": "This will return a summary of a data event for the App.", + "inline": undefined, "properties": { "count": { "docs": "The number of times the event was sent", @@ -6017,6 +6088,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DataExportCsv": { "docs": "A CSV output file", + "inline": undefined, "properties": { "company_id": { "docs": "The company ID of the user in relation to the message that was sent. Will return -1 if no company is present.", @@ -6129,6 +6201,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DeletedArticleObject": { "docs": "Response returned when an object is deleted", + "inline": undefined, "properties": { "deleted": { "docs": "Whether the article was deleted successfully or not.", @@ -6149,6 +6222,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DeletedCollectionObject": { "docs": "Response returned when an object is deleted", + "inline": undefined, "properties": { "deleted": { "docs": "Whether the collection was deleted successfully or not.", @@ -6169,6 +6243,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DeletedCompanyObject": { "docs": "Response returned when an object is deleted", + "inline": undefined, "properties": { "deleted": { "docs": "Whether the company was deleted successfully or not.", @@ -6189,6 +6264,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DeletedObject": { "docs": "Response returned when an object is deleted", + "inline": undefined, "properties": { "deleted": { "docs": "Whether the news item was deleted successfully or not.", @@ -6209,6 +6285,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "Email": { "docs": undefined, + "inline": true, "properties": { "email": { "docs": "The email you have defined for the contact who is being added as a participant.", @@ -6221,6 +6298,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "Error": { "docs": "The API will return an Error List for a failed request, which will contain one or more Error objects.", + "inline": undefined, "properties": { "errors": { "docs": "An array of one or more error objects", @@ -6247,6 +6325,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "ErrorErrorsItem": { "docs": undefined, + "inline": true, "properties": { "code": { "docs": "A string indicating the kind of error, used to further qualify the HTTP response code", @@ -6267,6 +6346,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "File": { "docs": "The value describing a file upload set for a custom attribute", + "inline": undefined, "properties": { "content_type": { "docs": "The type of file", @@ -6302,6 +6382,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "GroupContent": { "docs": "The Content of a Group.", + "inline": undefined, "properties": { "description": { "docs": "The description of the collection. Only available for collections.", @@ -6322,6 +6403,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "GroupTranslatedContent": { "docs": "The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.", + "inline": undefined, "properties": { "ar": { "docs": "The content of the group in Arabic", @@ -6560,6 +6642,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "LinkedObject": { "docs": "A linked conversation or ticket.", + "inline": undefined, "properties": { "category": { "docs": "Category of the Linked Ticket Object.", @@ -6580,6 +6663,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "LinkedObjectList": { "docs": "An object containing metadata about linked conversations and linked tickets. Up to 1000 can be returned.", + "inline": undefined, "properties": { "data": { "docs": "An array containing the linked conversations and linked tickets.", @@ -6614,6 +6698,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "MultipleFilterSearchRequest": { "docs": "Search using Intercoms Search APIs with more than one filter.", + "inline": undefined, "properties": { "operator": { "docs": "An operator to allow boolean inspection between multiple fields.", @@ -6641,6 +6726,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -6657,6 +6743,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "NewsItemRequest": { "docs": "A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.", + "inline": undefined, "properties": { "body": { "docs": "The news item body, which may contain HTML.", @@ -6707,6 +6794,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "NoteList": { "docs": "A paginated list of notes associated with a contact.", + "inline": undefined, "properties": { "data": { "docs": "An array of notes.", @@ -6730,6 +6818,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "OpenConversationRequest": { "docs": "Payload of the request to open a conversation", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is performing the action.", @@ -6745,6 +6834,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows. ", + "inline": undefined, "properties": { "next": { "docs": "A link to the next page of results. A response that does not contain a next link does not have further data to fetch.", @@ -6775,6 +6865,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "PaginatedResponse": { "docs": "Paginated Response", + "inline": undefined, "properties": { "data": { "docs": "An array of Objects", @@ -6829,6 +6920,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "PartAttachment": { "docs": "The file attached to a part", + "inline": undefined, "properties": { "content_type": { "docs": "The content type of the attachment", @@ -6865,6 +6957,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "PhoneSwitch": { "docs": "Phone Switch Response", + "inline": undefined, "properties": { "phone": { "docs": "Phone number in E.164 format, that has received the SMS to continue the conversation in the Messenger.", @@ -6901,6 +6994,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "RedactConversationRequestConversationPart": { "docs": "Payload of the request to redact a conversation part", + "inline": true, "properties": { "conversation_id": { "docs": "The id of the conversation.", @@ -6917,6 +7011,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "RedactConversationRequestSource": { "docs": "Payload of the request to redact a conversation source", + "inline": true, "properties": { "conversation_id": { "docs": "The id of the conversation.", @@ -6933,6 +7028,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "Reference": { "docs": "reference to another object", + "inline": undefined, "properties": { "id": { "docs": "", @@ -6951,6 +7047,7 @@ Their responses are likely to contain a pages object that hosts pagination links "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -6965,6 +7062,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "SearchRequest": { "docs": "Search using Intercoms Search APIs.", + "inline": undefined, "properties": { "pagination": { "type": "optional", @@ -6979,6 +7077,7 @@ Their responses are likely to contain a pages object that hosts pagination links "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -6993,6 +7092,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "SegmentList": { "docs": "This will return a list of Segment Objects. The result may also have a pages object if the response is paginated.", + "inline": undefined, "properties": { "pages": { "docs": "A pagination object, which may be empty, indicating no further pages to fetch.", @@ -7013,6 +7113,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "Segments": { "docs": "A list of segments objects attached to a specific contact.", + "inline": undefined, "properties": { "data": { "docs": "Segment objects associated with the contact.", @@ -7029,6 +7130,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "SingleFilterSearchRequest": { "docs": "Search using Intercoms Search APIs with a single filter.", + "inline": undefined, "properties": { "field": { "docs": "The accepted field that you want to search on.", @@ -7081,6 +7183,7 @@ Their responses are likely to contain a pages object that hosts pagination links "docs": "The SLA Applied object contains the details for which SLA has been applied to this conversation. Important: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null. ", + "inline": undefined, "properties": { "sla_name": { "docs": "The name of the SLA as given by the teammate when it was created.", @@ -7119,6 +7222,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "SnoozeConversationRequest": { "docs": "Payload of the request to snooze a conversation", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is performing the action.", @@ -7135,6 +7239,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "SocialProfile": { "docs": "A Social Profile allows you to label your contacts, companies, and conversations and list them using that Social Profile.", + "inline": undefined, "properties": { "name": { "docs": "The name of the Social media profile", @@ -7161,6 +7266,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "StartingAfterPaging": { "docs": undefined, + "inline": undefined, "properties": { "per_page": { "docs": "The number of results to fetch per page.", @@ -7177,6 +7283,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "SubscriptionTypeList": { "docs": "A list of subscription type objects.", + "inline": undefined, "properties": { "data": { "docs": "A list of subscription type objects associated with the workspace .", @@ -7193,6 +7300,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TagCompanyRequest": { "docs": "You can tag a single company or a list of companies.", + "inline": undefined, "properties": { "companies": { "docs": "The id or company_id of the company can be passed as input parameters.", @@ -7209,6 +7317,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TagCompanyRequestCompaniesItem": { "docs": undefined, + "inline": true, "properties": { "company_id": { "docs": "The company id you have defined for the company.", @@ -7225,6 +7334,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TagMultipleUsersRequest": { "docs": "You can tag a list of users.", + "inline": undefined, "properties": { "name": { "docs": "The name of the tag, which will be created if not found.", @@ -7238,6 +7348,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TagMultipleUsersRequestUsersItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The Intercom defined id representing the user.", @@ -7250,6 +7361,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "Tags": { "docs": "A list of tags objects associated with a conversation", + "inline": undefined, "properties": { "tags": { "docs": "A list of tags objects associated with the conversation.", @@ -7266,6 +7378,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TeamList": { "docs": "This will return a list of team objects for the App.", + "inline": undefined, "properties": { "teams": { "docs": "A list of team objects", @@ -7282,6 +7395,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TeamPriorityLevel": { "docs": "Admin priority levels for teams", + "inline": undefined, "properties": { "primary_team_ids": { "docs": "The primary team ids for the team", @@ -7304,6 +7418,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -7319,6 +7434,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketList": { "docs": "Tickets are how you track requests from your users.", + "inline": undefined, "properties": { "pages": { "type": "optional", @@ -7342,6 +7458,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketPartAuthor": { "docs": "The author that wrote or triggered the part. Can be a bot, admin, team or user.", + "inline": undefined, "properties": { "email": { "docs": "The email of the author", @@ -7384,6 +7501,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketParts": { "docs": "A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts.", + "inline": undefined, "properties": { "ticket_parts": { "docs": "A list of Ticket Part objects for each ticket. There is a limit of 500 parts.", @@ -7404,6 +7522,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketReply": { "docs": "A Ticket Part representing a note, comment, or quick_reply on a ticket", + "inline": undefined, "properties": { "attachments": { "docs": "A list of attachments for the part.", @@ -7464,6 +7583,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -7476,6 +7596,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketTypeAttribute": { "docs": "Ticket type attribute, used to define each data field to be captured in a ticket.", + "inline": undefined, "properties": { "archived": { "docs": "Whether the ticket type attribute is archived or not.", @@ -7556,6 +7677,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketTypeAttributeList": { "docs": "A list of attributes associated with a given ticket type.", + "inline": undefined, "properties": { "ticket_type_attributes": { "docs": "A list of ticket type attributes associated with a given ticket type.", @@ -7572,6 +7694,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketTypeList": { "docs": "A list of ticket types associated with a given workspace.", + "inline": undefined, "properties": { "ticket_types": { "docs": "A list of ticket_types associated with a given workspace.", @@ -7588,6 +7711,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "Translation": { "docs": "A translation object contains the localised details of a subscription type.", + "inline": undefined, "properties": { "description": { "docs": "The localised description of the subscription type.", @@ -7608,6 +7732,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "UntagCompanyRequest": { "docs": "You can tag a single company or a list of companies.", + "inline": undefined, "properties": { "companies": { "docs": "The id or company_id of the company can be passed as input parameters.", @@ -7624,6 +7749,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "UntagCompanyRequestCompaniesItem": { "docs": undefined, + "inline": true, "properties": { "company_id": { "docs": "The company id you have defined for the company.", @@ -7644,6 +7770,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "UpdateArticleRequest": { "docs": "You can Update an Article", + "inline": undefined, "properties": { "author_id": { "docs": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", @@ -7695,6 +7822,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a "docs": "The request payload for updating a ticket type. You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) ", + "inline": undefined, "properties": { "archived": { "docs": "The archived status of the ticket type.", @@ -7744,6 +7872,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( "UpdateVisitorRequestOne": "unknown", "Visitor": { "docs": "Visitors are useful for representing anonymous people that have not yet been identified. They usually represent website visitors. Visitors are not visible in Intercom platform. The Visitors resource provides methods to fetch, update, convert and delete.", + "inline": undefined, "properties": { "anonymous": { "docs": "Identifies if this visitor is anonymous.", @@ -7885,6 +8014,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorAvatar": { "docs": undefined, + "inline": true, "properties": { "image_url": { "docs": "This object represents the avatar associated with the visitor.", @@ -7908,6 +8038,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorCompanies": { "docs": undefined, + "inline": true, "properties": { "companies": "optional>", "type": { @@ -7921,6 +8052,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorDeletedObject": { "docs": "Response returned when an object is deleted", + "inline": undefined, "properties": { "id": { "docs": "The unique identifier for the visitor which is given by Intercom.", @@ -7941,6 +8073,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorLocationData": { "docs": undefined, + "inline": true, "properties": { "city_name": { "docs": "The city name of the visitor.", @@ -7982,6 +8115,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorSegments": { "docs": undefined, + "inline": true, "properties": { "segments": "optional>", "type": { @@ -7995,6 +8129,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorSocialProfiles": { "docs": undefined, + "inline": true, "properties": { "social_profiles": "optional>", "type": { @@ -8008,6 +8143,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorTags": { "docs": undefined, + "inline": true, "properties": { "tags": "optional>", "type": { @@ -8021,6 +8157,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorTagsTagsItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The id of the tag.", @@ -10290,6 +10427,7 @@ types: docs: The IP address of the admin. source: openapi: ../openapi.yml + inline: true ActivityLogActivityType: enum: - admin_assignment_limit_change @@ -10533,6 +10671,7 @@ types: format: uuid source: openapi: ../openapi.yml + inline: true AdminReplyTicketRequest: docs: Payload of the request to reply on behalf of an admin properties: @@ -10579,6 +10718,7 @@ types: format: uri source: openapi: ../openapi.yml + inline: true Admin: docs: Admins are the teammate accounts that have access to a workspace properties: @@ -11162,6 +11302,7 @@ types: participant. source: openapi: ../openapi.yml + inline: true ContactReplyIntercomUserIdRequest: docs: >- Payload of the request to reply on behalf of a contact using their @@ -11844,6 +11985,7 @@ types: docs: The identifier for the contact as given by Intercom. source: openapi: ../openapi.yml + inline: true CustomerRequestUserId: properties: user_id: @@ -11853,6 +11995,7 @@ types: a participant. source: openapi: ../openapi.yml + inline: true CustomerRequest: discriminated: false union: @@ -11881,6 +12024,7 @@ types: since: optional source: openapi: ../openapi.yml + inline: true DataEventList: docs: This will return a list of data events for the App. properties: @@ -12119,6 +12263,7 @@ types: was in error. source: openapi: ../openapi.yml + inline: true Error: docs: >- The API will return an Error List for a failed request, which will contain @@ -12398,6 +12543,7 @@ types: type: list source: openapi: ../openapi.yml + inline: true MultipleFilterSearchRequest: docs: Search using Intercoms Search APIs with more than one filter. properties: @@ -12592,6 +12738,7 @@ types: docs: The id of the conversation_part. source: openapi: ../openapi.yml + inline: true RedactConversationRequestSource: docs: Payload of the request to redact a conversation source properties: @@ -12603,6 +12750,7 @@ types: docs: The id of the source. source: openapi: ../openapi.yml + inline: true RedactConversationRequest: discriminant: type base-properties: {} @@ -12640,6 +12788,7 @@ types: - type: MultipleFilterSearchRequest source: openapi: ../openapi.yml + inline: true SearchRequest: docs: Search using Intercoms Search APIs. properties: @@ -12798,6 +12947,7 @@ types: docs: The company id you have defined for the company. source: openapi: ../openapi.yml + inline: true TagCompanyRequest: docs: You can tag a single company or a list of companies. properties: @@ -12827,6 +12977,7 @@ types: docs: The Intercom defined id representing the user. source: openapi: ../openapi.yml + inline: true TagMultipleUsersRequest: docs: You can tag a list of users. properties: @@ -13121,6 +13272,7 @@ types: docs: Always set to true source: openapi: ../openapi.yml + inline: true UntagCompanyRequest: docs: You can tag a single company or a list of companies. properties: @@ -13239,6 +13391,7 @@ types: format: uri source: openapi: ../openapi.yml + inline: true VisitorCompanies: properties: type: @@ -13247,6 +13400,7 @@ types: companies: optional> source: openapi: ../openapi.yml + inline: true VisitorLocationData: properties: type: @@ -13276,6 +13430,7 @@ types: docs: The timezone of the visitor. source: openapi: ../openapi.yml + inline: true VisitorSocialProfiles: properties: type: @@ -13284,6 +13439,7 @@ types: social_profiles: optional> source: openapi: ../openapi.yml + inline: true VisitorTagsTagsItem: properties: type: @@ -13297,6 +13453,7 @@ types: docs: The name of the tag. source: openapi: ../openapi.yml + inline: true VisitorTags: properties: type: @@ -13305,6 +13462,7 @@ types: tags: optional> source: openapi: ../openapi.yml + inline: true VisitorSegments: properties: type: @@ -13313,6 +13471,7 @@ types: segments: optional> source: openapi: ../openapi.yml + inline: true Visitor: docs: >- Visitors are useful for representing anonymous people that have not yet @@ -13859,6 +14018,7 @@ You can view the currently authorised admin along with the embedded app object ( "types": { "Admin": { "docs": "Admins are teammate accounts that have access to a workspace.", + "inline": undefined, "properties": { "avatar": { "docs": "Image for the associated team or teammate", @@ -14271,6 +14431,7 @@ types: "types": { "AiAgent": { "docs": "Data related to AI Agent involvement in the conversation.", + "inline": undefined, "properties": { "content_sources": { "type": "optional", @@ -14376,6 +14537,7 @@ imports: "types": { "ContentSource": { "docs": "The content source used by AI Agent in the conversation.", + "inline": undefined, "properties": { "content_type": { "docs": "The type of the content source.", @@ -17011,6 +17173,7 @@ imports: "extends": [ "Articles", ], + "inline": undefined, "properties": { "statistics": { "type": "optional", @@ -17033,6 +17196,7 @@ imports: }, "ArticleSearchHighlights": { "docs": "The highlighted results of an Article search. In the examples provided my search query is always "my query".", + "inline": undefined, "properties": { "article_id": { "docs": "The ID of the corresponding article.", @@ -17053,6 +17217,7 @@ imports: }, "ArticleSearchHighlightsHighlightedSummaryItemItem": { "docs": "An instance of highlighted summary text.", + "inline": true, "properties": { "text": { "docs": "The text of the title.", @@ -17079,6 +17244,7 @@ imports: }, "ArticleSearchHighlightsHighlightedTitleItem": { "docs": "A highlighted article title.", + "inline": true, "properties": { "text": { "docs": "The text of the title.", @@ -17105,6 +17271,7 @@ imports: }, "ArticleSearchResponse": { "docs": "The results of an Article search", + "inline": undefined, "properties": { "data": { "docs": "An object containing the results of the search.", @@ -17128,6 +17295,7 @@ imports: }, "ArticleSearchResponseData": { "docs": "An object containing the results of the search.", + "inline": true, "properties": { "articles": { "docs": "An array of Article objects", @@ -17144,6 +17312,7 @@ imports: }, "Articles": { "docs": "The data returned about your articles when you list them.", + "inline": undefined, "properties": { "author_id": { "docs": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", @@ -19605,6 +19774,7 @@ types: docs: The text of the title. source: openapi: ../openapi.yml + inline: true ArticleSearchHighlightsHighlightedSummaryItemItemType: enum: - highlight @@ -19623,6 +19793,7 @@ types: docs: The text of the title. source: openapi: ../openapi.yml + inline: true ArticleSearchHighlights: docs: >- The highlighted results of an Article search. In the examples provided my @@ -19651,6 +19822,7 @@ types: docs: A corresponding array of highlighted Article content source: openapi: ../openapi.yml + inline: true ArticleSearchResponse: docs: The results of an Article search properties: @@ -20780,6 +20952,7 @@ You can fetch all companies and filter by `segment_id` or `tag_id` as a query pa "types": { "Company": { "docs": "Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.", + "inline": undefined, "properties": { "app_id": { "docs": "The Intercom defined code of the workspace the company is associated to.", @@ -20863,6 +21036,7 @@ You can fetch all companies and filter by `segment_id` or `tag_id` as a query pa }, "CompanyPlan": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The id of the plan", @@ -20883,6 +21057,7 @@ You can fetch all companies and filter by `segment_id` or `tag_id` as a query pa }, "CompanySegments": { "docs": "The list of segments associated with the company", + "inline": true, "properties": { "segments": "optional>", "type": { @@ -20896,6 +21071,7 @@ You can fetch all companies and filter by `segment_id` or `tag_id` as a query pa }, "CompanyTags": { "docs": "The list of tags associated with the company", + "inline": true, "properties": { "tags": "optional>", "type": { @@ -21757,6 +21933,7 @@ types: docs: The name of the plan source: openapi: ../openapi.yml + inline: true CompanyTags: docs: The list of tags associated with the company properties: @@ -21766,6 +21943,7 @@ types: tags: optional> source: openapi: ../openapi.yml + inline: true CompanySegments: docs: The list of segments associated with the company properties: @@ -21775,6 +21953,7 @@ types: segments: optional> source: openapi: ../openapi.yml + inline: true Company: docs: >- Companies allow you to represent organizations using your product. Each @@ -23146,6 +23325,7 @@ The data property will show a combined list of: "types": { "Contact": { "docs": "Contact are the objects that represent your leads and users in Intercom.", + "inline": undefined, "properties": { "android_app_name": { "docs": "The name of the Android app which the contact is using.", @@ -23332,6 +23512,7 @@ The data property will show a combined list of: }, "ContactAvatar": { "docs": undefined, + "inline": true, "properties": { "image_url": { "docs": "An image URL containing the avatar of a contact.", @@ -24490,6 +24671,7 @@ types: format: uri source: openapi: ../openapi.yml + inline: true Contact: docs: Contact are the objects that represent your leads and users in Intercom. properties: @@ -29748,6 +29930,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -29765,6 +29948,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, }, "AttachContactToConversationRequestCustomerIntercomUserId": { "docs": undefined, + "inline": true, "properties": { "customer": { "type": "optional", @@ -29780,6 +29964,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, }, "AttachContactToConversationRequestCustomerUserId": { "docs": undefined, + "inline": true, "properties": { "customer": { "type": "optional", @@ -29795,6 +29980,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, }, "Conversation": { "docs": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.", + "inline": undefined, "properties": { "admin_assignee_id": { "docs": "The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null.", @@ -29916,6 +30102,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, }, "CreateConversationRequestFrom": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The identifier for the contact which is given by Intercom.", @@ -29949,6 +30136,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, }, "Email": { "docs": undefined, + "inline": true, "properties": { "customer": { "type": "optional", @@ -34156,6 +34344,7 @@ types: maxLength: 24 source: openapi: ../openapi.yml + inline: true ManageConversationRequestBody: discriminant: message_type base-properties: {} @@ -34179,6 +34368,7 @@ types: type: optional source: openapi: ../openapi.yml + inline: true AttachContactToConversationRequestCustomerUserId: properties: user_id: @@ -34190,6 +34380,7 @@ types: type: optional source: openapi: ../openapi.yml + inline: true Email: properties: email: @@ -34201,6 +34392,7 @@ types: type: optional source: openapi: ../openapi.yml + inline: true AttachContactToConversationRequestCustomer: discriminated: false union: @@ -34209,6 +34401,7 @@ types: - type: Email source: openapi: ../openapi.yml + inline: true ConversationState: enum: - open @@ -34316,6 +34509,7 @@ types: "types": { "CustomObjectInstance": { "docs": "A Custom Object Instance represents an instance of a custom object type. This allows you to create and set custom attributes to store data about your customers that is not already captured by Intercom. The parent object includes recommended default attributes and you can add your own custom attributes.", + "inline": undefined, "properties": { "custom_attributes": { "docs": "The custom attributes you have set on the custom object instance.", @@ -35290,6 +35484,7 @@ You can update a data attribute. }, "DataAttribute": { "docs": "Data Attributes are metadata used to describe your contact, company and conversation models. These include standard and custom attributes. By using the data attributes endpoint, you can get the global list of attributes for your workspace, as well as create and archive custom attributes.", + "inline": undefined, "properties": { "admin_id": { "docs": "Teammate who created the attribute. Only applicable to CDAs", @@ -36424,6 +36619,7 @@ You can optionally define the result page size as well with the `per_page` param "types": { "CreateDataEventSummariesRequestEventSummaries": { "docs": "A list of event summaries for the user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.", + "inline": true, "properties": { "count": { "docs": "The number of times the event occurred.", @@ -36448,6 +36644,7 @@ You can optionally define the result page size as well with the `per_page` param }, "DataEvent": { "docs": "Data events are used to notify Intercom of changes to your data.", + "inline": undefined, "properties": { "created_at": { "docs": "The time the event occurred as a UTC Unix timestamp", @@ -36490,6 +36687,7 @@ You can optionally define the result page size as well with the `per_page` param "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -36507,6 +36705,7 @@ You can optionally define the result page size as well with the `per_page` param }, "LisDataEventsRequestFilterEmail": { "docs": undefined, + "inline": true, "properties": { "email": "string", }, @@ -36516,6 +36715,7 @@ You can optionally define the result page size as well with the `per_page` param }, "LisDataEventsRequestFilterIntercomUserId": { "docs": undefined, + "inline": true, "properties": { "intercom_user_id": "string", }, @@ -36525,6 +36725,7 @@ You can optionally define the result page size as well with the `per_page` param }, "LisDataEventsRequestFilterUserId": { "docs": undefined, + "inline": true, "properties": { "user_id": "string", }, @@ -36540,16 +36741,19 @@ You can optionally define the result page size as well with the `per_page` param user_id: string source: openapi: ../openapi.yml + inline: true LisDataEventsRequestFilterIntercomUserId: properties: intercom_user_id: string source: openapi: ../openapi.yml + inline: true LisDataEventsRequestFilterEmail: properties: email: string source: openapi: ../openapi.yml + inline: true LisDataEventsRequestFilter: discriminated: false union: @@ -36582,6 +36786,7 @@ You can optionally define the result page size as well with the `per_page` param docs: The last time the event was sent source: openapi: ../openapi.yml + inline: true DataEvent: docs: Data events are used to notify Intercom of changes to your data. properties: @@ -37054,6 +37259,7 @@ Your exported message data will be streamed continuously back down to you in a g "types": { "DataExport": { "docs": "The data export api is used to view all message sent & viewed in a given timeframe.", + "inline": undefined, "properties": { "download_expires_at": { "docs": "The time after which you will not be able to access the data.", @@ -38703,6 +38909,7 @@ Collections will be returned in descending order on the `updated_at` attribute. "types": { "Collection": { "docs": "Collections are top level containers for Articles within the Help Center.", + "inline": undefined, "properties": { "created_at": { "docs": "The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.", @@ -38762,6 +38969,7 @@ Collections will be returned in descending order on the `updated_at` attribute. }, "HelpCenter": { "docs": "Help Centers contain collections", + "inline": undefined, "properties": { "created_at": { "docs": "The time when the Help Center was created.", @@ -38798,6 +39006,7 @@ Collections will be returned in descending order on the `updated_at` attribute. }, "HelpCenterList": { "docs": "A list of Help Centers belonging to the App", + "inline": undefined, "properties": { "data": { "docs": "An array of Help Center objects", @@ -40233,6 +40442,7 @@ This will return the Message model that has been created. "types": { "Message": { "docs": "Message are how you reach out to contacts in Intercom. They are created when an admin sends an outbound message to a contact.", + "inline": undefined, "properties": { "body": { "docs": "The message body, which may contain HTML.", @@ -41012,6 +41222,7 @@ types: "types": { "NewsItem": { "docs": "A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.", + "inline": undefined, "properties": { "body": { "docs": "The news item body, which may contain HTML.", @@ -41091,6 +41302,7 @@ types: Newsfeeds currently cannot be edited through the API, please refer to [this article](https://www.intercom.com/help/en/articles/6362267-getting-started-with-news) to set up your newsfeeds in Intercom. ", + "inline": undefined, "properties": { "created_at": { "docs": "Timestamp for when the newsfeed was created.", @@ -41115,6 +41327,7 @@ Newsfeeds currently cannot be edited through the API, please refer to [this arti }, "NewsfeedAssignment": { "docs": "Assigns a news item to a newsfeed.", + "inline": undefined, "properties": { "newsfeed_id": { "docs": "The unique identifier for the newsfeed which is given by Intercom. Publish dates cannot be in the future, to schedule news items use the dedicated feature in app (see this article).", @@ -41991,6 +42204,7 @@ types: "types": { "Note": { "docs": "Notes allow you to annotate and comment on your contacts.", + "inline": undefined, "properties": { "author": { "docs": "Optional. Represents the Admin that created the note.", @@ -42023,6 +42237,7 @@ types: }, "NoteContact": { "docs": "Represents the contact that the note was created about.", + "inline": true, "properties": { "id": { "docs": "The id of the contact.", @@ -42323,6 +42538,7 @@ types: docs: The id of the contact. source: openapi: ../openapi.yml + inline: true Note: docs: Notes allow you to annotate and comment on your contacts. properties: @@ -42472,6 +42688,7 @@ types: "types": { "Segment": { "docs": "A segment is a group of your contacts defined by the rules that you set.", + "inline": undefined, "properties": { "count": { "docs": "The number of items in the user segment. It's returned when `include_count=true` is included in the request.", @@ -42922,6 +43139,7 @@ This will return a subscription type model for the subscription type that was ad "types": { "SubscriptionType": { "docs": "A subscription type lets customers easily opt out of non-essential communications without missing what's important to them.", + "inline": undefined, "properties": { "consent_type": { "docs": "Describes the type of consent.", @@ -44256,6 +44474,7 @@ This will return a tag object. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -44276,6 +44495,7 @@ This will return a tag object. }, "Tag": { "docs": "A tag allows you to label your contacts, companies, and conversations and list them using that tag.", + "inline": undefined, "properties": { "applied_at": { "docs": "The time when the tag was applied to the object", @@ -45006,6 +45226,7 @@ types: "types": { "Team": { "docs": "Teams are groups of admins in Intercom.", + "inline": undefined, "properties": { "admin_ids": { "docs": "The list of admin IDs that are a part of the team.", @@ -47669,6 +47890,7 @@ The table below shows the operators you can use to define how you want to search "types": { "Contacts": { "docs": "The list of contacts affected by a ticket.", + "inline": undefined, "properties": { "contacts": { "docs": "The list of contacts affected by this ticket.", @@ -47687,6 +47909,7 @@ The table below shows the operators you can use to define how you want to search "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -47704,6 +47927,7 @@ The table below shows the operators you can use to define how you want to search }, "CreateTicketRequestContactsItemExternalId": { "docs": undefined, + "inline": true, "properties": { "external_id": { "docs": "The external_id you have defined for the contact who is being added as a participant.", @@ -47716,6 +47940,7 @@ The table below shows the operators you can use to define how you want to search }, "Email": { "docs": undefined, + "inline": true, "properties": { "email": { "docs": "The email you have defined for the contact who is being added as a participant. If a contact with this email does not exist, one will be created.", @@ -47728,6 +47953,7 @@ The table below shows the operators you can use to define how you want to search }, "ID": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The identifier for the contact as given by Intercom.", @@ -47742,6 +47968,7 @@ The table below shows the operators you can use to define how you want to search "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -47756,6 +47983,7 @@ The table below shows the operators you can use to define how you want to search }, "Ticket": { "docs": "Tickets are how you track requests from your users.", + "inline": undefined, "properties": { "admin_assignee_id": { "docs": "The id representing the admin assigned to the ticket.", @@ -47849,6 +48077,7 @@ The table below shows the operators you can use to define how you want to search }, "TicketPart": { "docs": "A Ticket Part represents a message in the ticket.", + "inline": undefined, "properties": { "assigned_to": { "docs": "The id of the admin that was assigned the ticket by this ticket_part (null if there has been no change in assignment.)", @@ -47944,6 +48173,7 @@ The table below shows the operators you can use to define how you want to search }, "TicketType": { "docs": "A ticket type, used to define the data fields to be captured in a ticket.", + "inline": undefined, "properties": { "archived": { "docs": "Whether the ticket type is archived or not.", @@ -48009,6 +48239,7 @@ The table below shows the operators you can use to define how you want to search }, "UpdateTicketRequestAssignment": { "docs": undefined, + "inline": true, "properties": { "admin_id": { "docs": "The ID of the admin performing the action.", @@ -48053,6 +48284,7 @@ types: docs: The identifier for the contact as given by Intercom. source: openapi: ../openapi.yml + inline: true CreateTicketRequestContactsItemExternalId: properties: external_id: @@ -48062,6 +48294,7 @@ types: a participant. source: openapi: ../openapi.yml + inline: true Email: properties: email: @@ -48072,6 +48305,7 @@ types: created. source: openapi: ../openapi.yml + inline: true CreateTicketRequestContactsItem: discriminated: false union: @@ -48080,6 +48314,7 @@ types: - type: Email source: openapi: ../openapi.yml + inline: true UpdateTicketRequestState: enum: - in_progress @@ -48100,6 +48335,7 @@ types: 0 to unassign it. source: openapi: ../openapi.yml + inline: true TicketCategory: enum: - Customer diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/json-string.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/json-string.json index 9c68f8b6963..516fcbe17fb 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/json-string.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/json-string.json @@ -8,6 +8,7 @@ "types": { "User": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/merge.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/merge.json index 95f50fc2068..5419f90792a 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/merge.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/merge.json @@ -8,6 +8,7 @@ "types": { "AccountDetails": { "docs": undefined, + "inline": undefined, "properties": { "category": "optional", "end_user_email_address": { @@ -58,6 +59,7 @@ The `LinkedAccount` object is used to represent an end user's link with a specif ### Usage Example View a list of your organization's `LinkedAccount` objects.", + "inline": undefined, "properties": { "category": "optional", "end_user_email_address": "string", @@ -79,6 +81,7 @@ View a list of your organization's `LinkedAccount` objects.", }, "AccountDetailsAndActionsIntegration": { "docs": undefined, + "inline": undefined, "properties": { "available_model_operations": "optional>", "categories": "list", @@ -108,6 +111,7 @@ View a list of your organization's `LinkedAccount` objects.", }, "AccountIntegration": { "docs": undefined, + "inline": undefined, "properties": { "api_endpoints_to_documentation_urls": { "docs": "Mapping of API endpoints to documentation urls for support. Example: {'GET': [['/common-model-scopes', 'https://docs.merge.dev/accounting/common-model-scopes/#common_model_scopes_retrieve'],['/common-model-actions', 'https://docs.merge.dev/accounting/common-model-actions/#common_model_actions_retrieve']], 'POST': []}", @@ -163,6 +167,7 @@ View a list of your organization's `LinkedAccount` objects.", }, "AccountToken": { "docs": undefined, + "inline": undefined, "properties": { "account_token": "string", "integration": "AccountIntegration", @@ -189,6 +194,7 @@ The `Activity` object is used to see all available model/operation combinations ### Usage Example Fetch all the actions available for the `Zenefits` integration.", + "inline": undefined, "properties": { "available_model_operations": "optional>", "integration": "AccountIntegration", @@ -205,6 +211,7 @@ The `BankInfo` object is used to represent the Bank Account information for an E ### Usage Example Fetch from the `LIST BankInfo` endpoint and filter by `ID` to show all bank information.", + "inline": undefined, "properties": { "account_number": { "docs": "The account number.", @@ -280,6 +287,7 @@ The `Benefit` object is used to represent a benefit that an employee has enrolle ### Usage Example Fetch from the `LIST Benefits` endpoint and filter by `ID` to show all benefits.", + "inline": undefined, "properties": { "benefit_plan_type": { "docs": "The type of benefit plan", @@ -387,6 +395,7 @@ Fetch from the `LIST Benefits` endpoint and filter by `ID` to show all benefits. }, "CommonModelScopesBodyRequest": { "docs": undefined, + "inline": undefined, "properties": { "disabled_fields": "list", "enabled_actions": "list", @@ -411,6 +420,7 @@ The `Company` object is used to represent a company within the HRIS / Payroll sy ### Usage Example Fetch from the `LIST Companies` endpoint and filter by `ID` to show all companies.", + "inline": undefined, "properties": { "display_name": { "docs": "The company's display name.", @@ -454,6 +464,7 @@ Fetch from the `LIST Companies` endpoint and filter by `ID` to show all companie }, "ConditionSchema": { "docs": undefined, + "inline": undefined, "properties": { "common_model": { "docs": "The common model for which a condition schema is defined.", @@ -1035,6 +1046,7 @@ The `DataPassthrough` object is used to send information to an otherwise-unsuppo ### Usage Example Create a `DataPassthrough` to get team hierarchies from your Rippling integration.", + "inline": undefined, "properties": { "base_url_override": { "type": "optional", @@ -1084,6 +1096,7 @@ Create a `DataPassthrough` to get team hierarchies from your Rippling integratio }, "DebugModeLog": { "docs": undefined, + "inline": undefined, "properties": { "dashboard_view": "string", "log_id": "string", @@ -1095,6 +1108,7 @@ Create a `DataPassthrough` to get team hierarchies from your Rippling integratio }, "DebugModelLogSummary": { "docs": undefined, + "inline": undefined, "properties": { "method": "string", "status_code": "integer", @@ -1111,6 +1125,7 @@ The `Deduction` object is used to represent an array of the wages withheld from ### Usage Example Fetch from the `LIST Deductions` endpoint and filter by `ID` to show all deductions.", + "inline": undefined, "properties": { "company_deduction": { "docs": "The amount of money that is withheld on behalf of an employee by the company.", @@ -1168,6 +1183,7 @@ The `Earning` object is used to represent an array of different compensations th ### Usage Example Fetch from the `LIST Earnings` endpoint and filter by `ID` to show all earnings.", + "inline": undefined, "properties": { "amount": { "docs": "The amount earned.", @@ -1241,6 +1257,7 @@ The `Employee` object is used to represent any person who has been employed by a ### Usage Example Fetch from the `LIST Employee` endpoint and filter by `ID` to show all employees.", + "inline": undefined, "properties": { "avatar": { "docs": "The URL of the employee's avatar image.", @@ -1464,6 +1481,7 @@ Fetch from the `LIST Employee` endpoint and filter by `ID` to show all employees }, "EmployeeEndpointRequest": { "docs": undefined, + "inline": undefined, "properties": { "model": "EmployeeRequest", }, @@ -1478,6 +1496,7 @@ The `EmployeePayrollRun` object is used to represent an employee's pay statement ### Usage Example Fetch from the `LIST EmployeePayrollRun` endpoint and filter by `ID` to show all employee payroll runs.", + "inline": undefined, "properties": { "check_date": { "docs": "The day and time the payroll run was checked.", @@ -1557,6 +1576,7 @@ The `Employee` object is used to represent any person who has been employed by a ### Usage Example Fetch from the `LIST Employee` endpoint and filter by `ID` to show all employees.", + "inline": undefined, "properties": { "avatar": { "docs": "The URL of the employee's avatar image.", @@ -1754,6 +1774,7 @@ Fetch from the `LIST Employee` endpoint and filter by `ID` to show all employees }, "EmployeeResponse": { "docs": undefined, + "inline": undefined, "properties": { "errors": "list", "logs": "optional>", @@ -1773,6 +1794,7 @@ Please note: When there is a change in pay or title, integrations with historica ### Usage Example Fetch from the `LIST Employments` endpoint and filter by `ID` to show all employees.", + "inline": undefined, "properties": { "effective_date": { "docs": "The position's effective date.", @@ -2248,6 +2270,7 @@ Fetch from the `LIST Employments` endpoint and filter by `ID` to show all employ }, "EndUserDetailsRequest": { "docs": undefined, + "inline": undefined, "properties": { "categories": { "docs": "The integration categories to show in Merge Link.", @@ -2321,6 +2344,7 @@ Fetch from the `LIST Employments` endpoint and filter by `ID` to show all employ }, "ErrorValidationProblem": { "docs": undefined, + "inline": undefined, "properties": { "detail": "string", "problem_type": "string", @@ -2396,6 +2420,7 @@ The `GenerateRemoteKey` object is used to represent a request for a new remote k ### Usage Example Post a `GenerateRemoteKey` to create a new remote key.", + "inline": undefined, "properties": { "name": { "type": "string", @@ -2418,6 +2443,7 @@ The `Group` object is used to represent any subset of employees, such as `PayGro ### Usage Example Fetch from the `LIST Employee` endpoint and expand groups to view an employee's groups.", + "inline": undefined, "properties": { "field_mappings": "optional>", "id": { @@ -2490,6 +2516,7 @@ Fetch from the `LIST Employee` endpoint and expand groups to view an employee's }, "IgnoreCommonModelRequest": { "docs": undefined, + "inline": undefined, "properties": { "message": { "type": "optional", @@ -2508,6 +2535,7 @@ Fetch from the `LIST Employee` endpoint and expand groups to view an employee's }, "Issue": { "docs": undefined, + "inline": undefined, "properties": { "end_user": "optional>", "error_description": "string", @@ -2549,6 +2577,7 @@ Fetch from the `LIST Employee` endpoint and expand groups to view an employee's }, "LinkToken": { "docs": undefined, + "inline": undefined, "properties": { "integration_name": "optional", "link_token": "string", @@ -2560,6 +2589,7 @@ Fetch from the `LIST Employee` endpoint and expand groups to view an employee's }, "LinkedAccountCondition": { "docs": undefined, + "inline": undefined, "properties": { "common_model": { "docs": "The common model for a specific condition.", @@ -2595,6 +2625,7 @@ Fetch from the `LIST Employee` endpoint and expand groups to view an employee's }, "LinkedAccountConditionRequest": { "docs": undefined, + "inline": undefined, "properties": { "condition_schema_id": { "docs": "The ID indicating which condition schema to use for a specific condition.", @@ -2624,6 +2655,7 @@ Fetch from the `LIST Employee` endpoint and expand groups to view an employee's }, "LinkedAccountSelectiveSyncConfiguration": { "docs": undefined, + "inline": undefined, "properties": { "linked_account_conditions": { "docs": "The conditions belonging to a selective sync.", @@ -2636,6 +2668,7 @@ Fetch from the `LIST Employee` endpoint and expand groups to view an employee's }, "LinkedAccountSelectiveSyncConfigurationRequest": { "docs": undefined, + "inline": undefined, "properties": { "linked_account_conditions": { "docs": "The conditions belonging to a selective sync.", @@ -2648,6 +2681,7 @@ Fetch from the `LIST Employee` endpoint and expand groups to view an employee's }, "LinkedAccountStatus": { "docs": undefined, + "inline": undefined, "properties": { "can_make_request": "boolean", "linked_account_status": "string", @@ -2663,6 +2697,7 @@ The `Location` object is used to represent an address that can be associated wit ### Usage Example Fetch from the `LIST Locations` endpoint and filter by `ID` to show all office locations.", + "inline": undefined, "properties": { "city": { "docs": "The location's city.", @@ -3011,6 +3046,7 @@ Fetch from the `LIST Locations` endpoint and filter by `ID` to show all office l }, "MetaResponse": { "docs": undefined, + "inline": undefined, "properties": { "has_conditional_params": "boolean", "has_required_linked_account_params": "boolean", @@ -3050,6 +3086,7 @@ The `ModelOperation` object is used to represent the operations that are current ### Usage Example View what operations are supported for the `Candidate` endpoint.", + "inline": undefined, "properties": { "available_operations": "list", "model_name": "string", @@ -3067,6 +3104,7 @@ The `MultipartFormField` object is used to represent fields in an HTTP request u ### Usage Example Create a `MultipartFormField` to define a multipart form entry.", + "inline": undefined, "properties": { "content_type": { "docs": "The MIME type of the file, if the field is for a file.", @@ -3123,6 +3161,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "OperatorSchema": { "docs": undefined, + "inline": undefined, "properties": { "is_unique": { "docs": "Whether the operator can be repeated multiple times.", @@ -3139,6 +3178,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedAccountDetailsAndActionsList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3150,6 +3190,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedBankInfoList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3161,6 +3202,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedBenefitList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3172,6 +3214,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedCompanyList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3183,6 +3226,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedConditionSchemaList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3194,6 +3238,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedEmployeeList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3205,6 +3250,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedEmployeePayrollRunList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3216,6 +3262,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedEmploymentList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3227,6 +3274,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedGroupList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3238,6 +3286,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedIssueList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3249,6 +3298,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedLocationList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3260,6 +3310,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedPayGroupList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3271,6 +3322,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedPayrollRunList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3282,6 +3334,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedSyncStatusList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3293,6 +3346,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedTeamList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3304,6 +3358,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedTimeOffBalanceList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3315,6 +3370,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedTimeOffList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3978,6 +4034,7 @@ The `PayGroup` object is used to represent a subset of employees that are put to ### Usage Example Fetch from the `LIST PayGroup` endpoint and filter by `ID` to show all pay group information.", + "inline": undefined, "properties": { "field_mappings": "optional>", "id": { @@ -4043,6 +4100,7 @@ The `PayrollRun` object is used to represent a group of pay statements for a spe ### Usage Example Fetch from the `LIST PayrollRuns` endpoint and filter by `ID` to show all payroll runs.", + "inline": undefined, "properties": { "check_date": { "docs": "The day and time the payroll run was checked.", @@ -4138,6 +4196,7 @@ Fetch from the `LIST PayrollRuns` endpoint and filter by `ID` to show all payrol }, "RemoteData": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional>", "path": "string", @@ -4153,6 +4212,7 @@ The `RemoteKey` object is used to represent a request for a new remote key. ### Usage Example Post a `GenerateRemoteKey` to receive a new `RemoteKey`.", + "inline": undefined, "properties": { "key": "string", "name": "string", @@ -4168,6 +4228,7 @@ The `RemoteKeyForRegeneration` object is used to exchange an old remote key for ### Usage Example Post a `RemoteKeyForRegeneration` to swap out an old remote key for a new one", + "inline": undefined, "properties": { "name": { "type": "string", @@ -4190,6 +4251,7 @@ The `RemoteResponse` object is used to represent information returned from a thi ### Usage Example View the `RemoteResponse` returned from your `DataPassthrough`.", + "inline": undefined, "properties": { "headers": "optional>", "method": "string", @@ -4298,6 +4360,7 @@ The `SyncStatus` object is used to represent the syncing state of an account ### Usage Example View the `SyncStatus` for an account to see how recently its models were synced.", + "inline": undefined, "properties": { "is_initial_sync": "boolean", "last_sync_start": "optional", @@ -4337,6 +4400,7 @@ The `Tax` object is used to represent an array of the tax deductions for a given ### Usage Example Fetch from the `LIST Taxes` endpoint and filter by `ID` to show all taxes.", + "inline": undefined, "properties": { "amount": { "docs": "The tax amount.", @@ -4394,6 +4458,7 @@ The `Team` object is used to represent a subdivision of the company, usually a d ### Usage Example If you're building a way to filter by `Team`, you'd hit the `GET Teams` endpoint to fetch the `Teams`, and then use the `ID` of the team your user selects to filter the `GET Employees` endpoint.", + "inline": undefined, "properties": { "field_mappings": "optional>", "id": { @@ -4444,6 +4509,7 @@ The `TimeOff` object is used to represent all employees' Time Off entries. ### Usage Example Fetch from the `LIST TimeOffs` endpoint and filter by `ID` to show all time off requests.", + "inline": undefined, "properties": { "amount": { "docs": "The time off quantity measured by the prescribed “units”.", @@ -4541,6 +4607,7 @@ The `TimeOffBalance` object is used to represent current balances for an employe ### Usage Example Fetch from the `LIST TimeOffBalances` endpoint and filter by `ID` to show all time off balances.", + "inline": undefined, "properties": { "balance": { "docs": "The current remaining PTO balance, always measured in terms of hours.", @@ -4601,6 +4668,7 @@ Fetch from the `LIST TimeOffBalances` endpoint and filter by `ID` to show all ti }, "TimeOffEndpointRequest": { "docs": undefined, + "inline": undefined, "properties": { "model": "TimeOffRequest", }, @@ -4615,6 +4683,7 @@ The `TimeOff` object is used to represent all employees' Time Off entries. ### Usage Example Fetch from the `LIST TimeOffs` endpoint and filter by `ID` to show all time off requests.", + "inline": undefined, "properties": { "amount": { "docs": "The time off quantity measured by the prescribed “units”.", @@ -4689,6 +4758,7 @@ Fetch from the `LIST TimeOffs` endpoint and filter by `ID` to show all time off }, "TimeOffResponse": { "docs": undefined, + "inline": undefined, "properties": { "errors": "list", "logs": "optional>", @@ -4729,6 +4799,7 @@ Fetch from the `LIST TimeOffs` endpoint and filter by `ID` to show all time off }, "ValidationProblemSource": { "docs": undefined, + "inline": undefined, "properties": { "pointer": "string", }, @@ -4738,6 +4809,7 @@ Fetch from the `LIST TimeOffs` endpoint and filter by `ID` to show all time off }, "WarningValidationProblem": { "docs": undefined, + "inline": undefined, "properties": { "detail": "string", "problem_type": "string", @@ -4750,6 +4822,7 @@ Fetch from the `LIST TimeOffs` endpoint and filter by `ID` to show all time off }, "WebhookReceiver": { "docs": undefined, + "inline": undefined, "properties": { "event": "string", "is_active": "boolean", @@ -4761,6 +4834,7 @@ Fetch from the `LIST TimeOffs` endpoint and filter by `ID` to show all time off }, "WebhookReceiverRequest": { "docs": undefined, + "inline": undefined, "properties": { "event": { "type": "string", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/multi-url-generators-yml.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/multi-url-generators-yml.json index baf93b1b740..b19790b569e 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/multi-url-generators-yml.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/multi-url-generators-yml.json @@ -141,6 +141,7 @@ "types": { "Token": { "docs": undefined, + "inline": undefined, "properties": { "accessToken": "optional", "expiresIn": "optional", @@ -152,6 +153,7 @@ }, "User": { "docs": undefined, + "inline": undefined, "properties": { "createdAt": "optional", "email": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/non-alphanumeric-characters.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/non-alphanumeric-characters.json index 43fd15d72e3..0e93f21bc04 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/non-alphanumeric-characters.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/non-alphanumeric-characters.json @@ -72,6 +72,7 @@ }, "Settings": { "docs": undefined, + "inline": undefined, "properties": { "separator": "optional", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/ntropy.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/ntropy.json index da9a04af27f..a1bfd4b33c3 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/ntropy.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/ntropy.json @@ -608,6 +608,7 @@ "types": { "Account": { "docs": undefined, + "inline": undefined, "properties": { "closing_balance": { "type": "optional", @@ -631,6 +632,7 @@ }, "AccountHolder": { "docs": undefined, + "inline": undefined, "properties": { "address": { "type": "optional
", @@ -648,6 +650,7 @@ }, "AccountHolderExternal": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "The timestamp of when the account holder was created.", @@ -720,6 +723,7 @@ }, "Address": { "docs": undefined, + "inline": undefined, "properties": { "city": { "type": "optional", @@ -743,6 +747,7 @@ }, "BankStatement": { "docs": "Represents a bank statement with details about the file and its status.", + "inline": undefined, "properties": { "created_at": { "docs": "The date and time when the job was created.", @@ -774,6 +779,7 @@ }, "BankStatementAccount": { "docs": undefined, + "inline": undefined, "properties": { "closing_balance": { "docs": "The closing balance of the account for the statement period.", @@ -830,6 +836,7 @@ }, "BankStatementError": { "docs": undefined, + "inline": undefined, "properties": { "code": { "type": "BankStatementErrorCode", @@ -852,6 +859,7 @@ }, "BankStatementFile": { "docs": undefined, + "inline": undefined, "properties": { "no_pages": { "docs": "The number of pages in the bank statement file.", @@ -868,6 +876,7 @@ }, "BankStatementResults": { "docs": undefined, + "inline": undefined, "properties": { "accounts": { "docs": "List of accounts in the bank statement.", @@ -891,6 +900,7 @@ }, "BankStatementTransaction": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "The amount of the transaction in the `currency`. Must be a positive value. For example, if the `currency` is USD, then it's the amount in dollars.", @@ -952,6 +962,7 @@ }, "Batch": { "docs": "The `Batch` object represents the status and progress of an asynchronous batch enrichment job.", + "inline": undefined, "properties": { "created_at": { "docs": "The timestamp of when the batch was created.", @@ -985,6 +996,7 @@ "BatchResult": { "docs": "The `BatchResult` object represents the result of a batch enrichment job, including its status and enriched transactions.", + "inline": undefined, "properties": { "id": { "docs": "A unique identifier for the batch.", @@ -1019,6 +1031,7 @@ enriched transactions.", }, "Categories": { "docs": undefined, + "inline": undefined, "properties": { "accounting": { "docs": "The corresponding accounting category. Only available for `business` transactions.", @@ -1047,6 +1060,7 @@ enriched transactions.", }, "CategorySet": { "docs": undefined, + "inline": undefined, "properties": { "incoming": { "type": "list", @@ -1061,6 +1075,7 @@ enriched transactions.", }, "Counterparty": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The unique UUID identifier of the entity", @@ -1512,6 +1527,7 @@ enriched transactions.", }, "CustomCategorySet": { "docs": undefined, + "inline": undefined, "properties": { "incoming": { "type": "list", @@ -1552,6 +1568,7 @@ enriched transactions.", }, "EnrichedTransaction": { "docs": undefined, + "inline": undefined, "properties": { "categories": { "type": "optional", @@ -1586,6 +1603,7 @@ enriched transactions.", }, "EnrichmentResult": { "docs": undefined, + "inline": undefined, "properties": { "transactions": { "docs": "A list of enriched transactions resulting from the enrichment of this batch.", @@ -1598,6 +1616,7 @@ enriched transactions.", }, "Entities": { "docs": "Entities found by identity identification", + "inline": undefined, "properties": { "counterparty": { "type": "optional", @@ -1612,6 +1631,7 @@ enriched transactions.", }, "Entity": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The unique UUID identifier of the entity", @@ -1658,6 +1678,7 @@ enriched transactions.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -1729,6 +1750,7 @@ enriched transactions.", }, "FnCall!": { "docs": undefined, + "inline": true, "properties": { "!": { "type": "expression", @@ -1740,6 +1762,7 @@ enriched transactions.", }, "FnCall&&": { "docs": undefined, + "inline": true, "properties": { "&&": "list", }, @@ -1749,6 +1772,7 @@ enriched transactions.", }, "FnCall*": { "docs": undefined, + "inline": true, "properties": { "*": "list", }, @@ -1758,6 +1782,7 @@ enriched transactions.", }, "FnCall+": { "docs": undefined, + "inline": true, "properties": { "+": "list", }, @@ -1767,6 +1792,7 @@ enriched transactions.", }, "FnCall-": { "docs": undefined, + "inline": true, "properties": { "-": "list", }, @@ -1776,6 +1802,7 @@ enriched transactions.", }, "FnCall/": { "docs": undefined, + "inline": true, "properties": { "/": "list", }, @@ -1785,6 +1812,7 @@ enriched transactions.", }, "FnCall//": { "docs": undefined, + "inline": true, "properties": { "//": "list", }, @@ -1794,6 +1822,7 @@ enriched transactions.", }, "FnCall<": { "docs": undefined, + "inline": true, "properties": { "<": "list", }, @@ -1803,6 +1832,7 @@ enriched transactions.", }, "FnCall<=": { "docs": undefined, + "inline": true, "properties": { "<=": "list", }, @@ -1812,6 +1842,7 @@ enriched transactions.", }, "FnCall==": { "docs": undefined, + "inline": true, "properties": { "==": "list", }, @@ -1821,6 +1852,7 @@ enriched transactions.", }, "FnCall>": { "docs": undefined, + "inline": true, "properties": { ">": "list", }, @@ -1830,6 +1862,7 @@ enriched transactions.", }, "FnCall>=": { "docs": undefined, + "inline": true, "properties": { ">=": "list", }, @@ -1839,6 +1872,7 @@ enriched transactions.", }, "FnCallEndsWith": { "docs": undefined, + "inline": true, "properties": { "ends_with": "list", }, @@ -1848,6 +1882,7 @@ enriched transactions.", }, "FnCallGet": { "docs": undefined, + "inline": true, "properties": { "get": { "type": "properties", @@ -1859,6 +1894,7 @@ enriched transactions.", }, "FnCallHasLabel": { "docs": undefined, + "inline": true, "properties": { "has_label": { "type": "expression", @@ -1870,6 +1906,7 @@ enriched transactions.", }, "FnCallHasMcc": { "docs": undefined, + "inline": true, "properties": { "has_mcc": { "type": "expression", @@ -1881,6 +1918,7 @@ enriched transactions.", }, "FnCallIsSubstring": { "docs": undefined, + "inline": true, "properties": { "is_substring": "list", }, @@ -1890,6 +1928,7 @@ enriched transactions.", }, "FnCallStartsWith": { "docs": undefined, + "inline": true, "properties": { "starts_with": "list", }, @@ -1899,6 +1938,7 @@ enriched transactions.", }, "FnCallToLower": { "docs": undefined, + "inline": true, "properties": { "to_lower": { "type": "expression", @@ -1910,6 +1950,7 @@ enriched transactions.", }, "FnCallToUpper": { "docs": undefined, + "inline": true, "properties": { "to_upper": { "type": "expression", @@ -1921,6 +1962,7 @@ enriched transactions.", }, "FnCall||": { "docs": undefined, + "inline": true, "properties": { "||": "list", }, @@ -1930,6 +1972,7 @@ enriched transactions.", }, "HTTPValidationError": { "docs": undefined, + "inline": undefined, "properties": { "detail": { "type": "optional>", @@ -1941,6 +1984,7 @@ enriched transactions.", }, "Intermediary": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The unique UUID identifier of the entity", @@ -1982,6 +2026,7 @@ enriched transactions.", }, "Location": { "docs": undefined, + "inline": undefined, "properties": { "raw_address": { "docs": "An unstructured string containing the address", @@ -1999,6 +2044,7 @@ enriched transactions.", "LocationInput": { "docs": "Location of where the transaction has taken place. This can greatly improve entity identification, especially under ambiguity.", + "inline": undefined, "properties": { "country": { "docs": "The country where the transaction was made in ISO 3166-2 format", @@ -2015,6 +2061,7 @@ under ambiguity.", }, "LocationStructured": { "docs": undefined, + "inline": undefined, "properties": { "apple_maps_url": { "docs": "A URL link to view the location on Apple Maps", @@ -2069,6 +2116,7 @@ under ambiguity.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -2095,6 +2143,7 @@ under ambiguity.", }, "ModifyLabelsAddLabel": { "docs": undefined, + "inline": true, "properties": { "add_label": { "type": "expression", @@ -2106,6 +2155,7 @@ under ambiguity.", }, "ModifyLabelsAddMcc": { "docs": undefined, + "inline": true, "properties": { "add_mcc": { "type": "expression", @@ -2117,6 +2167,7 @@ under ambiguity.", }, "ModifyLabelsRemoveLabel": { "docs": undefined, + "inline": true, "properties": { "remove_label": { "type": "expression", @@ -2128,6 +2179,7 @@ under ambiguity.", }, "ModifyLabelsRemoveMcc": { "docs": undefined, + "inline": true, "properties": { "remove_mcc": { "type": "expression", @@ -2139,6 +2191,7 @@ under ambiguity.", }, "ModifyLabelsSetLabels": { "docs": undefined, + "inline": true, "properties": { "set_labels": "list", }, @@ -2148,6 +2201,7 @@ under ambiguity.", }, "ModifyLabelsSetMcc": { "docs": undefined, + "inline": true, "properties": { "set_mcc": "list", }, @@ -2157,6 +2211,7 @@ under ambiguity.", }, "PagedResponseAccountHolderExternal": { "docs": undefined, + "inline": undefined, "properties": { "data": { "type": "list", @@ -2169,6 +2224,7 @@ under ambiguity.", }, "PagedResponseBankStatement": { "docs": undefined, + "inline": undefined, "properties": { "data": { "type": "list", @@ -2181,6 +2237,7 @@ under ambiguity.", }, "PagedResponseBatch": { "docs": undefined, + "inline": undefined, "properties": { "data": { "type": "list", @@ -2193,6 +2250,7 @@ under ambiguity.", }, "PagedResponseReport": { "docs": undefined, + "inline": undefined, "properties": { "data": { "type": "list", @@ -2207,6 +2265,7 @@ under ambiguity.", }, "PagedResponseTransaction": { "docs": undefined, + "inline": undefined, "properties": { "data": { "type": "list", @@ -2219,6 +2278,7 @@ under ambiguity.", }, "PagedResponseWebhook": { "docs": undefined, + "inline": undefined, "properties": { "data": { "type": "list", @@ -2232,6 +2292,7 @@ under ambiguity.", "Recurrence": { "docs": "The `Recurrence` object represents the recurrence pattern of a transaction. It provides information about whether a transaction is a one-time event or a part of a recurring series.", + "inline": undefined, "properties": { "type": { "docs": "Whether the transaction is a one-time transfer `one-off`, regularly with varying pricing `recurring` or with fixed pricing `subscription`", @@ -2244,6 +2305,7 @@ whether a transaction is a one-time event or a part of a recurring series.", }, "RecurrenceGroup": { "docs": undefined, + "inline": undefined, "properties": { "average_amount": { "docs": "The average amount per transaction in this group", @@ -2335,6 +2397,7 @@ whether a transaction is a one-time event or a part of a recurring series.", }, "Report": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "The date and time when the report was created.", @@ -2394,6 +2457,7 @@ whether a transaction is a one-time event or a part of a recurring series.", }, "StatementInfo": { "docs": undefined, + "inline": undefined, "properties": { "account_holder": { "type": "optional", @@ -2429,6 +2493,7 @@ whether a transaction is a one-time event or a part of a recurring series.", }, "SyncEnrichmentOutput": { "docs": undefined, + "inline": undefined, "properties": { "transactions": { "docs": "A list of enriched transactions resulting from the enrichment of this batch.", @@ -2441,6 +2506,7 @@ whether a transaction is a one-time event or a part of a recurring series.", }, "Transaction": { "docs": undefined, + "inline": undefined, "properties": { "account_holder_id": { "docs": "The unique ID of the account holder of the transaction", @@ -2527,6 +2593,7 @@ whether a transaction is a one-time event or a part of a recurring series.", }, "TransactionError": { "docs": undefined, + "inline": undefined, "properties": { "code": { "type": "TransactionErrorCode", @@ -2549,6 +2616,7 @@ whether a transaction is a one-time event or a part of a recurring series.", }, "TransactionInput": { "docs": undefined, + "inline": undefined, "properties": { "account_holder_id": { "docs": "The unique ID of the account holder. Unsetting it will disable [categorization](./docs/v3/enrichment/entities).", @@ -2613,6 +2681,7 @@ whether a transaction is a one-time event or a part of a recurring series.", }, "ValidationError": { "docs": undefined, + "inline": undefined, "properties": { "loc": { "type": "list", @@ -2628,6 +2697,7 @@ whether a transaction is a one-time event or a part of a recurring series.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -2638,6 +2708,7 @@ whether a transaction is a one-time event or a part of a recurring series.", }, "Webhook": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "The date and time when the webhook was created.", @@ -2719,6 +2790,7 @@ whether a transaction is a one-time event or a part of a recurring series.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -2738,6 +2810,7 @@ whether a transaction is a one-time event or a part of a recurring series.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -2750,6 +2823,7 @@ whether a transaction is a one-time event or a part of a recurring series.", }, "if": { "docs": undefined, + "inline": undefined, "properties": { "else": { "type": "optional>", @@ -2787,6 +2861,7 @@ whether a transaction is a one-time event or a part of a recurring series.", }, "set": { "docs": undefined, + "inline": undefined, "properties": { "set": { "type": "EditableTxProp", @@ -4388,6 +4463,7 @@ types: - integer source: openapi: ../openapi.yml + inline: true ValidationError: properties: loc: @@ -4476,112 +4552,133 @@ types: '&&': list source: openapi: ../openapi.yml + inline: true FnCall||: properties: '||': list source: openapi: ../openapi.yml + inline: true FnCall==: properties: '==': list source: openapi: ../openapi.yml + inline: true FnCall+: properties: +: list source: openapi: ../openapi.yml + inline: true FnCall-: properties: '-': list source: openapi: ../openapi.yml + inline: true FnCall*: properties: '*': list source: openapi: ../openapi.yml + inline: true FnCall/: properties: /: list source: openapi: ../openapi.yml + inline: true FnCall//: properties: //: list source: openapi: ../openapi.yml + inline: true FnCall<: properties: <: list source: openapi: ../openapi.yml + inline: true FnCall<=: properties: <=: list source: openapi: ../openapi.yml + inline: true FnCall>: properties: '>': list source: openapi: ../openapi.yml + inline: true FnCall>=: properties: '>=': list source: openapi: ../openapi.yml + inline: true FnCall!: properties: '!': type: expression source: openapi: ../openapi.yml + inline: true FnCallIsSubstring: properties: is_substring: list source: openapi: ../openapi.yml + inline: true FnCallStartsWith: properties: starts_with: list source: openapi: ../openapi.yml + inline: true FnCallEndsWith: properties: ends_with: list source: openapi: ../openapi.yml + inline: true FnCallToLower: properties: to_lower: type: expression source: openapi: ../openapi.yml + inline: true FnCallToUpper: properties: to_upper: type: expression source: openapi: ../openapi.yml + inline: true FnCallHasLabel: properties: has_label: type: expression source: openapi: ../openapi.yml + inline: true FnCallHasMcc: properties: has_mcc: type: expression source: openapi: ../openapi.yml + inline: true FnCallGet: properties: get: type: properties source: openapi: ../openapi.yml + inline: true FnCall: discriminated: false union: @@ -4632,34 +4729,40 @@ types: type: expression source: openapi: ../openapi.yml + inline: true ModifyLabelsRemoveLabel: properties: remove_label: type: expression source: openapi: ../openapi.yml + inline: true ModifyLabelsSetLabels: properties: set_labels: list source: openapi: ../openapi.yml + inline: true ModifyLabelsAddMcc: properties: add_mcc: type: expression source: openapi: ../openapi.yml + inline: true ModifyLabelsRemoveMcc: properties: remove_mcc: type: expression source: openapi: ../openapi.yml + inline: true ModifyLabelsSetMcc: properties: set_mcc: list source: openapi: ../openapi.yml + inline: true ModifyLabels: discriminated: false union: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/oauth.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/oauth.json index 5fa4d286016..6e76ddae20f 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/oauth.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/oauth.json @@ -129,6 +129,7 @@ }, "AuthGetTokenResponse": { "docs": undefined, + "inline": undefined, "properties": { "access_token": "optional", "expires_in": { diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/only-include-referenced-schemas.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/only-include-referenced-schemas.json index 1af8e788077..e7c0346d557 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/only-include-referenced-schemas.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/only-include-referenced-schemas.json @@ -3942,6 +3942,7 @@ "types": { "ActivityLog": { "docs": "Activities performed by Admins.", + "inline": undefined, "properties": { "activity_description": { "docs": "A sentence or two describing the activity.", @@ -4046,6 +4047,7 @@ }, "ActivityLogList": { "docs": "A paginated list of activity logs.", + "inline": undefined, "properties": { "activity_logs": { "docs": "An array of activity logs", @@ -4065,6 +4067,7 @@ }, "ActivityLogMetadata": { "docs": "Additional data provided about Admin activity.", + "inline": undefined, "properties": { "auto_changed": { "docs": "Indicates if the status was changed automatically or manually.", @@ -4109,6 +4112,7 @@ }, "ActivityLogPerformedBy": { "docs": "Details about the Admin involved in the activity.", + "inline": true, "properties": { "email": { "docs": "The email of the admin.", @@ -4133,6 +4137,7 @@ }, "AddressableList": { "docs": "A list used to access other resources from a parent model.", + "inline": undefined, "properties": { "id": { "docs": "The id of the addressable object", @@ -4165,6 +4170,7 @@ }, "Admin": { "docs": "Admins are the teammate accounts that have access to a workspace", + "inline": undefined, "properties": { "app": { "docs": "App that the admin belongs to.", @@ -4221,6 +4227,7 @@ }, "AdminPriorityLevel": { "docs": "Admin priority levels for the team", + "inline": undefined, "properties": { "primary_admin_ids": { "docs": "The primary admin ids for the team", @@ -4237,6 +4244,7 @@ }, "AdminReplyConversationRequest": { "docs": "Payload of the request to reply on behalf of an admin", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is authoring the comment.", @@ -4276,6 +4284,7 @@ }, "AdminReplyTicketRequest": { "docs": "Payload of the request to reply on behalf of an admin", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is authoring the comment.", @@ -4316,6 +4325,7 @@ }, "AdminReplyTicketRequestReplyOptionsItem": { "docs": undefined, + "inline": true, "properties": { "text": { "docs": "The text to display in this quick reply option.", @@ -4338,6 +4348,7 @@ }, "AdminWithAppAvatar": { "docs": "This object represents the avatar associated with the admin.", + "inline": true, "properties": { "image_url": { "docs": "This object represents the avatar associated with the admin.", @@ -4361,6 +4372,7 @@ }, "Admins": { "docs": "A list of admins associated with a given workspace.", + "inline": undefined, "properties": { "admins": { "docs": "A list of admins associated with a given workspace.", @@ -4377,6 +4389,7 @@ }, "App": { "docs": "App is a workspace on Intercom", + "inline": undefined, "properties": { "created_at": { "docs": "When the app was created.", @@ -4414,6 +4427,7 @@ }, "ArticleContent": { "docs": "The Content of an Article.", + "inline": undefined, "properties": { "author_id": { "docs": "The ID of the author of the article.", @@ -4468,6 +4482,7 @@ }, "ArticleStatistics": { "docs": "The statistics of an article.", + "inline": undefined, "properties": { "conversions": { "docs": "The number of conversations started from the article.", @@ -4504,6 +4519,7 @@ }, "ArticleTranslatedContent": { "docs": "The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.", + "inline": undefined, "properties": { "ar": { "docs": "The content of the article in Arabic", @@ -4664,6 +4680,7 @@ }, "Articles": { "docs": "This will return a list of articles for the App.", + "inline": undefined, "properties": { "data": { "docs": "An array of Article objects", @@ -4687,6 +4704,7 @@ }, "AssignConversationRequest": { "docs": "Payload of the request to assign a conversation", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is performing the action.", @@ -4717,6 +4735,7 @@ }, "CloseConversationRequest": { "docs": "Payload of the request to close a conversation", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is performing the action.", @@ -4734,6 +4753,7 @@ }, "Collections": { "docs": "This will return a list of Collections for the App.", + "inline": undefined, "properties": { "data": { "docs": "An array of collection objects", @@ -4757,6 +4777,7 @@ }, "Companies": { "docs": "This will return a list of companies for the App.", + "inline": undefined, "properties": { "data": { "docs": "An array containing Company Objects.", @@ -4780,6 +4801,7 @@ }, "CompanyAttachedContacts": { "docs": "A list of Contact Objects", + "inline": undefined, "properties": { "data": { "docs": "An array containing Contact Objects", @@ -4803,6 +4825,7 @@ }, "CompanyAttachedSegments": { "docs": "A list of Segment Objects", + "inline": undefined, "properties": { "data": { "docs": "An array containing Segment Objects", @@ -4819,6 +4842,7 @@ }, "CompanyScroll": { "docs": "Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.", + "inline": undefined, "properties": { "data": { "type": "optional>", @@ -4845,6 +4869,7 @@ }, "ContactArchived": { "docs": "archived contact object", + "inline": undefined, "properties": { "archived": { "docs": "Whether the contact is archived or not.", @@ -4869,6 +4894,7 @@ }, "ContactAttachedCompanies": { "docs": "A list of Company Objects", + "inline": undefined, "properties": { "companies": { "docs": "An array containing Company Objects", @@ -4892,6 +4918,7 @@ }, "ContactCompanies": { "docs": "An object containing companies meta data about the companies that a contact has. Up to 10 will be displayed here. Use the url to get more.", + "inline": undefined, "properties": { "has_more": { "docs": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all", @@ -4918,6 +4945,7 @@ }, "ContactDeleted": { "docs": "deleted contact object", + "inline": undefined, "properties": { "deleted": { "docs": "Whether the contact is deleted or not.", @@ -4942,6 +4970,7 @@ }, "ContactList": { "docs": "Contacts are your users in Intercom.", + "inline": undefined, "properties": { "data": { "docs": "The list of contact objects", @@ -4965,6 +4994,7 @@ }, "ContactLocation": { "docs": "An object containing location meta data about a Intercom contact.", + "inline": undefined, "properties": { "city": { "docs": "The city that the contact is located in", @@ -4989,6 +5019,7 @@ }, "ContactNotes": { "docs": "An object containing notes meta data about the notes that a contact has. Up to 10 will be displayed here. Use the url to get more.", + "inline": undefined, "properties": { "data": { "docs": "This object represents the notes attached to a contact.", @@ -5019,6 +5050,7 @@ }, "ContactReference": { "docs": "reference to contact object", + "inline": undefined, "properties": { "external_id": { "docs": "The unique identifier for the contact which is provided by the Client.", @@ -5039,6 +5071,7 @@ }, "ContactReplyBaseRequest": { "docs": undefined, + "inline": undefined, "properties": { "attachment_urls": { "docs": "A list of image URLs that will be added as attachments. You can include up to 10 URLs.", @@ -5063,6 +5096,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -5083,6 +5117,7 @@ "extends": [ "ContactReplyBaseRequest", ], + "inline": undefined, "properties": { "attachment_files": { "docs": "A list of files that will be added as attachments.", @@ -5102,6 +5137,7 @@ "extends": [ "ContactReplyBaseRequest", ], + "inline": undefined, "properties": { "intercom_user_id": { "docs": "The identifier for the contact as given by Intercom.", @@ -5116,6 +5152,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -5136,6 +5173,7 @@ "extends": [ "ContactReplyBaseRequest", ], + "inline": undefined, "properties": { "user_id": { "docs": "The external_id you have defined for the contact.", @@ -5151,6 +5189,7 @@ "extends": [ "ContactReplyBaseRequest", ], + "inline": undefined, "properties": { "attachment_files": { "docs": "A list of files that will be added as attachments. You can include up to 10 files.", @@ -5167,6 +5206,7 @@ }, "ContactSocialProfiles": { "docs": "An object containing social profiles that a contact has.", + "inline": undefined, "properties": { "data": { "docs": "A list of social profiles objects associated with the contact.", @@ -5179,6 +5219,7 @@ }, "ContactTags": { "docs": "An object containing tags meta data about the tags that a contact has. Up to 10 will be displayed here. Use the url to get more.", + "inline": undefined, "properties": { "data": { "docs": "This object represents the tags attached to a contact.", @@ -5209,6 +5250,7 @@ }, "ContactUnarchived": { "docs": "unarchived contact object", + "inline": undefined, "properties": { "archived": { "docs": "Whether the contact is archived or not.", @@ -5233,6 +5275,7 @@ }, "Contacts": { "docs": "The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.", + "inline": undefined, "properties": { "contacts": { "docs": "The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.", @@ -5249,6 +5292,7 @@ }, "ContentSourcesList": { "docs": undefined, + "inline": undefined, "properties": { "content_sources": { "docs": "The content sources used by AI Agent in the conversation.", @@ -5268,6 +5312,7 @@ }, "ConversationAttachmentFiles": { "docs": "Properties of the attachment files in a conversation part", + "inline": undefined, "properties": { "content_type": { "docs": "The content type of the file", @@ -5288,6 +5333,7 @@ }, "ConversationFirstContactReply": { "docs": "An object containing information on the first users message. For a contact initiated message this will represent the users original message.", + "inline": undefined, "properties": { "created_at": { "docs": "", @@ -5308,6 +5354,7 @@ }, "ConversationList": { "docs": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.", + "inline": undefined, "properties": { "conversations": { "docs": "The list of conversation objects", @@ -5331,6 +5378,7 @@ }, "ConversationPart": { "docs": "A Conversation Part represents a message in the conversation.", + "inline": undefined, "properties": { "assigned_to": { "docs": "The id of the admin that was assigned the conversation by this conversation_part (null if there has been no change in assignment.)", @@ -5386,6 +5434,7 @@ }, "ConversationPartAuthor": { "docs": "The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank.", + "inline": undefined, "properties": { "email": { "docs": "The email of the author", @@ -5416,6 +5465,7 @@ }, "ConversationParts": { "docs": "A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.", + "inline": undefined, "properties": { "conversation_parts": { "docs": "A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.", @@ -5436,6 +5486,7 @@ }, "ConversationRating": { "docs": "The Conversation Rating object which contains information on the rating and/or remark added by a Contact and the Admin assigned to the conversation.", + "inline": undefined, "properties": { "contact": { "type": "optional", @@ -5462,6 +5513,7 @@ }, "ConversationSource": { "docs": "The Conversation Part that originated this conversation, which can be Contact, Admin, Campaign, Automated or Operator initiated.", + "inline": undefined, "properties": { "attachments": { "docs": "A list of attachments for the part.", @@ -5505,6 +5557,7 @@ }, "ConversationStatistics": { "docs": "A Statistics object containing all information required for reporting, with timestamps and calculated metrics.", + "inline": undefined, "properties": { "count_assignments": { "docs": "Number of assignments after first_contact_reply_at.", @@ -5589,6 +5642,7 @@ }, "ConversationTeammates": { "docs": "The list of teammates who participated in the conversation (wrote at least one conversation part).", + "inline": undefined, "properties": { "teammates": { "docs": "The list of teammates who participated in the conversation (wrote at least one conversation part).", @@ -5605,6 +5659,7 @@ }, "CreateArticleRequest": { "docs": "You can create an Article", + "inline": undefined, "properties": { "author_id": { "docs": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", @@ -5657,6 +5712,7 @@ "CreateMessageRequestOne": "unknown", "CreateOrUpdateCompanyRequest": { "docs": "You can create or update a Company", + "inline": undefined, "properties": { "company_id": { "docs": "The company id you have defined for the company. Can't be updated", @@ -5701,6 +5757,7 @@ }, "CreateOrUpdateTagRequest": { "docs": "You can create or update an existing tag.", + "inline": undefined, "properties": { "id": { "docs": "The id of tag to updates.", @@ -5717,6 +5774,7 @@ }, "CreatePhoneSwitchRequest": { "docs": "You can create an phone switch", + "inline": undefined, "properties": { "custom_attributes": { "type": "optional", @@ -5734,6 +5792,7 @@ "docs": "The request payload for creating a ticket type. You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) ", + "inline": undefined, "properties": { "category": { "docs": "Category of the Ticket Type.", @@ -5780,6 +5839,7 @@ "docs": "Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed. ", + "inline": undefined, "properties": { "next": { "type": "optional", @@ -5813,6 +5873,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -5827,6 +5888,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -5844,6 +5906,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "CustomerRequestIntercomUserId": { "docs": undefined, + "inline": true, "properties": { "intercom_user_id": { "docs": "The identifier for the contact as given by Intercom.", @@ -5856,6 +5919,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "CustomerRequestUserId": { "docs": undefined, + "inline": true, "properties": { "user_id": { "docs": "The external_id you have defined for the contact who is being added as a participant.", @@ -5868,6 +5932,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DataAttributeList": { "docs": "A list of all data attributes belonging to a workspace for contacts, companies or conversations.", + "inline": undefined, "properties": { "data": { "docs": "A list of data attributes", @@ -5884,6 +5949,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DataEventSummary": { "docs": "This will return a summary of data events for the App.", + "inline": undefined, "properties": { "email": { "docs": "The email address of the user", @@ -5912,6 +5978,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DataEventSummaryItem": { "docs": "This will return a summary of a data event for the App.", + "inline": undefined, "properties": { "count": { "docs": "The number of times the event was sent", @@ -5940,6 +6007,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DeletedArticleObject": { "docs": "Response returned when an object is deleted", + "inline": undefined, "properties": { "deleted": { "docs": "Whether the article was deleted successfully or not.", @@ -5960,6 +6028,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DeletedCollectionObject": { "docs": "Response returned when an object is deleted", + "inline": undefined, "properties": { "deleted": { "docs": "Whether the collection was deleted successfully or not.", @@ -5980,6 +6049,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DeletedCompanyObject": { "docs": "Response returned when an object is deleted", + "inline": undefined, "properties": { "deleted": { "docs": "Whether the company was deleted successfully or not.", @@ -6000,6 +6070,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DeletedObject": { "docs": "Response returned when an object is deleted", + "inline": undefined, "properties": { "deleted": { "docs": "Whether the news item was deleted successfully or not.", @@ -6020,6 +6091,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "Email": { "docs": undefined, + "inline": true, "properties": { "email": { "docs": "The email you have defined for the contact who is being added as a participant.", @@ -6032,6 +6104,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "Error": { "docs": "The API will return an Error List for a failed request, which will contain one or more Error objects.", + "inline": undefined, "properties": { "errors": { "docs": "An array of one or more error objects", @@ -6058,6 +6131,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "ErrorErrorsItem": { "docs": undefined, + "inline": true, "properties": { "code": { "docs": "A string indicating the kind of error, used to further qualify the HTTP response code", @@ -6078,6 +6152,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "File": { "docs": "The value describing a file upload set for a custom attribute", + "inline": undefined, "properties": { "content_type": { "docs": "The type of file", @@ -6113,6 +6188,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "GroupContent": { "docs": "The Content of a Group.", + "inline": undefined, "properties": { "description": { "docs": "The description of the collection. Only available for collections.", @@ -6133,6 +6209,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "GroupTranslatedContent": { "docs": "The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.", + "inline": undefined, "properties": { "ar": { "docs": "The content of the group in Arabic", @@ -6293,6 +6370,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "LinkedObject": { "docs": "A linked conversation or ticket.", + "inline": undefined, "properties": { "category": { "docs": "Category of the Linked Ticket Object.", @@ -6313,6 +6391,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "LinkedObjectList": { "docs": "An object containing metadata about linked conversations and linked tickets. Up to 1000 can be returned.", + "inline": undefined, "properties": { "data": { "docs": "An array containing the linked conversations and linked tickets.", @@ -6347,6 +6426,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "MultipleFilterSearchRequest": { "docs": "Search using Intercoms Search APIs with more than one filter.", + "inline": undefined, "properties": { "operator": { "docs": "An operator to allow boolean inspection between multiple fields.", @@ -6374,6 +6454,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -6390,6 +6471,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "NewsItemRequest": { "docs": "A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.", + "inline": undefined, "properties": { "body": { "docs": "The news item body, which may contain HTML.", @@ -6440,6 +6522,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "NoteList": { "docs": "A paginated list of notes associated with a contact.", + "inline": undefined, "properties": { "data": { "docs": "An array of notes.", @@ -6463,6 +6546,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "OpenConversationRequest": { "docs": "Payload of the request to open a conversation", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is performing the action.", @@ -6478,6 +6562,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows. ", + "inline": undefined, "properties": { "next": { "docs": "A link to the next page of results. A response that does not contain a next link does not have further data to fetch.", @@ -6508,6 +6593,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "PaginatedResponse": { "docs": "Paginated Response", + "inline": undefined, "properties": { "data": { "docs": "An array of Objects", @@ -6562,6 +6648,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "PartAttachment": { "docs": "The file attached to a part", + "inline": undefined, "properties": { "content_type": { "docs": "The content type of the attachment", @@ -6598,6 +6685,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "PhoneSwitch": { "docs": "Phone Switch Response", + "inline": undefined, "properties": { "phone": { "docs": "Phone number in E.164 format, that has received the SMS to continue the conversation in the Messenger.", @@ -6634,6 +6722,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "RedactConversationRequestConversationPart": { "docs": "Payload of the request to redact a conversation part", + "inline": true, "properties": { "conversation_id": { "docs": "The id of the conversation.", @@ -6650,6 +6739,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "RedactConversationRequestSource": { "docs": "Payload of the request to redact a conversation source", + "inline": true, "properties": { "conversation_id": { "docs": "The id of the conversation.", @@ -6666,6 +6756,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "Reference": { "docs": "reference to another object", + "inline": undefined, "properties": { "id": { "docs": "", @@ -6684,6 +6775,7 @@ Their responses are likely to contain a pages object that hosts pagination links "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -6698,6 +6790,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "SearchRequest": { "docs": "Search using Intercoms Search APIs.", + "inline": undefined, "properties": { "pagination": { "type": "optional", @@ -6712,6 +6805,7 @@ Their responses are likely to contain a pages object that hosts pagination links "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -6726,6 +6820,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "SegmentList": { "docs": "This will return a list of Segment Objects. The result may also have a pages object if the response is paginated.", + "inline": undefined, "properties": { "pages": { "docs": "A pagination object, which may be empty, indicating no further pages to fetch.", @@ -6746,6 +6841,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "Segments": { "docs": "A list of segments objects attached to a specific contact.", + "inline": undefined, "properties": { "data": { "docs": "Segment objects associated with the contact.", @@ -6762,6 +6858,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "SingleFilterSearchRequest": { "docs": "Search using Intercoms Search APIs with a single filter.", + "inline": undefined, "properties": { "field": { "docs": "The accepted field that you want to search on.", @@ -6814,6 +6911,7 @@ Their responses are likely to contain a pages object that hosts pagination links "docs": "The SLA Applied object contains the details for which SLA has been applied to this conversation. Important: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null. ", + "inline": undefined, "properties": { "sla_name": { "docs": "The name of the SLA as given by the teammate when it was created.", @@ -6852,6 +6950,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "SnoozeConversationRequest": { "docs": "Payload of the request to snooze a conversation", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is performing the action.", @@ -6868,6 +6967,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "SocialProfile": { "docs": "A Social Profile allows you to label your contacts, companies, and conversations and list them using that Social Profile.", + "inline": undefined, "properties": { "name": { "docs": "The name of the Social media profile", @@ -6894,6 +6994,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "StartingAfterPaging": { "docs": undefined, + "inline": undefined, "properties": { "per_page": { "docs": "The number of results to fetch per page.", @@ -6910,6 +7011,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "SubscriptionTypeList": { "docs": "A list of subscription type objects.", + "inline": undefined, "properties": { "data": { "docs": "A list of subscription type objects associated with the workspace .", @@ -6926,6 +7028,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TagCompanyRequest": { "docs": "You can tag a single company or a list of companies.", + "inline": undefined, "properties": { "companies": { "docs": "The id or company_id of the company can be passed as input parameters.", @@ -6942,6 +7045,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TagCompanyRequestCompaniesItem": { "docs": undefined, + "inline": true, "properties": { "company_id": { "docs": "The company id you have defined for the company.", @@ -6958,6 +7062,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TagMultipleUsersRequest": { "docs": "You can tag a list of users.", + "inline": undefined, "properties": { "name": { "docs": "The name of the tag, which will be created if not found.", @@ -6971,6 +7076,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TagMultipleUsersRequestUsersItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The Intercom defined id representing the user.", @@ -6983,6 +7089,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "Tags": { "docs": "A list of tags objects associated with a conversation", + "inline": undefined, "properties": { "tags": { "docs": "A list of tags objects associated with the conversation.", @@ -6999,6 +7106,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TeamList": { "docs": "This will return a list of team objects for the App.", + "inline": undefined, "properties": { "teams": { "docs": "A list of team objects", @@ -7015,6 +7123,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TeamPriorityLevel": { "docs": "Admin priority levels for teams", + "inline": undefined, "properties": { "primary_team_ids": { "docs": "The primary team ids for the team", @@ -7037,6 +7146,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -7052,6 +7162,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketList": { "docs": "Tickets are how you track requests from your users.", + "inline": undefined, "properties": { "pages": { "type": "optional", @@ -7075,6 +7186,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketPartAuthor": { "docs": "The author that wrote or triggered the part. Can be a bot, admin, team or user.", + "inline": undefined, "properties": { "email": { "docs": "The email of the author", @@ -7117,6 +7229,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketParts": { "docs": "A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts.", + "inline": undefined, "properties": { "ticket_parts": { "docs": "A list of Ticket Part objects for each ticket. There is a limit of 500 parts.", @@ -7137,6 +7250,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketReply": { "docs": "A Ticket Part representing a note, comment, or quick_reply on a ticket", + "inline": undefined, "properties": { "attachments": { "docs": "A list of attachments for the part.", @@ -7197,6 +7311,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -7209,6 +7324,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketTypeAttribute": { "docs": "Ticket type attribute, used to define each data field to be captured in a ticket.", + "inline": undefined, "properties": { "archived": { "docs": "Whether the ticket type attribute is archived or not.", @@ -7289,6 +7405,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketTypeAttributeList": { "docs": "A list of attributes associated with a given ticket type.", + "inline": undefined, "properties": { "ticket_type_attributes": { "docs": "A list of ticket type attributes associated with a given ticket type.", @@ -7305,6 +7422,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketTypeList": { "docs": "A list of ticket types associated with a given workspace.", + "inline": undefined, "properties": { "ticket_types": { "docs": "A list of ticket_types associated with a given workspace.", @@ -7321,6 +7439,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "Translation": { "docs": "A translation object contains the localised details of a subscription type.", + "inline": undefined, "properties": { "description": { "docs": "The localised description of the subscription type.", @@ -7341,6 +7460,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "UntagCompanyRequest": { "docs": "You can tag a single company or a list of companies.", + "inline": undefined, "properties": { "companies": { "docs": "The id or company_id of the company can be passed as input parameters.", @@ -7357,6 +7477,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "UntagCompanyRequestCompaniesItem": { "docs": undefined, + "inline": true, "properties": { "company_id": { "docs": "The company id you have defined for the company.", @@ -7377,6 +7498,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "UpdateArticleRequest": { "docs": "You can Update an Article", + "inline": undefined, "properties": { "author_id": { "docs": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", @@ -7428,6 +7550,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a "docs": "The request payload for updating a ticket type. You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) ", + "inline": undefined, "properties": { "archived": { "docs": "The archived status of the ticket type.", @@ -7477,6 +7600,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( "UpdateVisitorRequestOne": "unknown", "Visitor": { "docs": "Visitors are useful for representing anonymous people that have not yet been identified. They usually represent website visitors. Visitors are not visible in Intercom platform. The Visitors resource provides methods to fetch, update, convert and delete.", + "inline": undefined, "properties": { "anonymous": { "docs": "Identifies if this visitor is anonymous.", @@ -7618,6 +7742,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorAvatar": { "docs": undefined, + "inline": true, "properties": { "image_url": { "docs": "This object represents the avatar associated with the visitor.", @@ -7641,6 +7766,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorCompanies": { "docs": undefined, + "inline": true, "properties": { "companies": "optional>", "type": { @@ -7654,6 +7780,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorLocationData": { "docs": undefined, + "inline": true, "properties": { "city_name": { "docs": "The city name of the visitor.", @@ -7695,6 +7822,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorSegments": { "docs": undefined, + "inline": true, "properties": { "segments": "optional>", "type": { @@ -7708,6 +7836,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorSocialProfiles": { "docs": undefined, + "inline": true, "properties": { "social_profiles": "optional>", "type": { @@ -7721,6 +7850,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorTags": { "docs": undefined, + "inline": true, "properties": { "tags": "optional>", "type": { @@ -7734,6 +7864,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorTagsTagsItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The id of the tag.", @@ -10003,6 +10134,7 @@ types: docs: The IP address of the admin. source: openapi: ../openapi.yml + inline: true ActivityLogActivityType: enum: - admin_assignment_limit_change @@ -10246,6 +10378,7 @@ types: format: uuid source: openapi: ../openapi.yml + inline: true AdminReplyTicketRequest: docs: Payload of the request to reply on behalf of an admin properties: @@ -10292,6 +10425,7 @@ types: format: uri source: openapi: ../openapi.yml + inline: true Admin: docs: Admins are the teammate accounts that have access to a workspace properties: @@ -10875,6 +11009,7 @@ types: participant. source: openapi: ../openapi.yml + inline: true ContactReplyIntercomUserIdRequest: docs: >- Payload of the request to reply on behalf of a contact using their @@ -11525,6 +11660,7 @@ types: docs: The identifier for the contact as given by Intercom. source: openapi: ../openapi.yml + inline: true CustomerRequestUserId: properties: user_id: @@ -11534,6 +11670,7 @@ types: a participant. source: openapi: ../openapi.yml + inline: true CustomerRequest: discriminated: false union: @@ -11670,6 +11807,7 @@ types: was in error. source: openapi: ../openapi.yml + inline: true Error: docs: >- The API will return an Error List for a failed request, which will contain @@ -11906,6 +12044,7 @@ types: type: list source: openapi: ../openapi.yml + inline: true MultipleFilterSearchRequest: docs: Search using Intercoms Search APIs with more than one filter. properties: @@ -12100,6 +12239,7 @@ types: docs: The id of the conversation_part. source: openapi: ../openapi.yml + inline: true RedactConversationRequestSource: docs: Payload of the request to redact a conversation source properties: @@ -12111,6 +12251,7 @@ types: docs: The id of the source. source: openapi: ../openapi.yml + inline: true RedactConversationRequest: discriminant: type base-properties: {} @@ -12148,6 +12289,7 @@ types: - type: MultipleFilterSearchRequest source: openapi: ../openapi.yml + inline: true SearchRequest: docs: Search using Intercoms Search APIs. properties: @@ -12306,6 +12448,7 @@ types: docs: The company id you have defined for the company. source: openapi: ../openapi.yml + inline: true TagCompanyRequest: docs: You can tag a single company or a list of companies. properties: @@ -12335,6 +12478,7 @@ types: docs: The Intercom defined id representing the user. source: openapi: ../openapi.yml + inline: true TagMultipleUsersRequest: docs: You can tag a list of users. properties: @@ -12629,6 +12773,7 @@ types: docs: Always set to true source: openapi: ../openapi.yml + inline: true UntagCompanyRequest: docs: You can tag a single company or a list of companies. properties: @@ -12747,6 +12892,7 @@ types: format: uri source: openapi: ../openapi.yml + inline: true VisitorCompanies: properties: type: @@ -12755,6 +12901,7 @@ types: companies: optional> source: openapi: ../openapi.yml + inline: true VisitorLocationData: properties: type: @@ -12784,6 +12931,7 @@ types: docs: The timezone of the visitor. source: openapi: ../openapi.yml + inline: true VisitorSocialProfiles: properties: type: @@ -12792,6 +12940,7 @@ types: social_profiles: optional> source: openapi: ../openapi.yml + inline: true VisitorTagsTagsItem: properties: type: @@ -12805,6 +12954,7 @@ types: docs: The name of the tag. source: openapi: ../openapi.yml + inline: true VisitorTags: properties: type: @@ -12813,6 +12963,7 @@ types: tags: optional> source: openapi: ../openapi.yml + inline: true VisitorSegments: properties: type: @@ -12821,6 +12972,7 @@ types: segments: optional> source: openapi: ../openapi.yml + inline: true Visitor: docs: >- Visitors are useful for representing anonymous people that have not yet @@ -13352,6 +13504,7 @@ You can view the currently authorised admin along with the embedded app object ( "types": { "Admin": { "docs": "Admins are teammate accounts that have access to a workspace.", + "inline": undefined, "properties": { "avatar": { "docs": "Image for the associated team or teammate", @@ -13764,6 +13917,7 @@ types: "types": { "AiAgent": { "docs": "Data related to AI Agent involvement in the conversation.", + "inline": undefined, "properties": { "content_sources": { "type": "optional", @@ -13869,6 +14023,7 @@ imports: "types": { "ContentSource": { "docs": "The content source used by AI Agent in the conversation.", + "inline": undefined, "properties": { "content_type": { "docs": "The type of the content source.", @@ -16504,6 +16659,7 @@ imports: "extends": [ "Articles", ], + "inline": undefined, "properties": { "statistics": { "type": "optional", @@ -16526,6 +16682,7 @@ imports: }, "ArticleSearchHighlights": { "docs": "The highlighted results of an Article search. In the examples provided my search query is always "my query".", + "inline": undefined, "properties": { "article_id": { "docs": "The ID of the corresponding article.", @@ -16546,6 +16703,7 @@ imports: }, "ArticleSearchHighlightsHighlightedSummaryItemItem": { "docs": "An instance of highlighted summary text.", + "inline": true, "properties": { "text": { "docs": "The text of the title.", @@ -16572,6 +16730,7 @@ imports: }, "ArticleSearchHighlightsHighlightedTitleItem": { "docs": "A highlighted article title.", + "inline": true, "properties": { "text": { "docs": "The text of the title.", @@ -16598,6 +16757,7 @@ imports: }, "ArticleSearchResponse": { "docs": "The results of an Article search", + "inline": undefined, "properties": { "data": { "docs": "An object containing the results of the search.", @@ -16621,6 +16781,7 @@ imports: }, "ArticleSearchResponseData": { "docs": "An object containing the results of the search.", + "inline": true, "properties": { "articles": { "docs": "An array of Article objects", @@ -16637,6 +16798,7 @@ imports: }, "Articles": { "docs": "The data returned about your articles when you list them.", + "inline": undefined, "properties": { "author_id": { "docs": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", @@ -19098,6 +19260,7 @@ types: docs: The text of the title. source: openapi: ../openapi.yml + inline: true ArticleSearchHighlightsHighlightedSummaryItemItemType: enum: - highlight @@ -19116,6 +19279,7 @@ types: docs: The text of the title. source: openapi: ../openapi.yml + inline: true ArticleSearchHighlights: docs: >- The highlighted results of an Article search. In the examples provided my @@ -19144,6 +19308,7 @@ types: docs: A corresponding array of highlighted Article content source: openapi: ../openapi.yml + inline: true ArticleSearchResponse: docs: The results of an Article search properties: @@ -20273,6 +20438,7 @@ You can fetch all companies and filter by `segment_id` or `tag_id` as a query pa "types": { "Company": { "docs": "Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.", + "inline": undefined, "properties": { "app_id": { "docs": "The Intercom defined code of the workspace the company is associated to.", @@ -20356,6 +20522,7 @@ You can fetch all companies and filter by `segment_id` or `tag_id` as a query pa }, "CompanyPlan": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The id of the plan", @@ -20376,6 +20543,7 @@ You can fetch all companies and filter by `segment_id` or `tag_id` as a query pa }, "CompanySegments": { "docs": "The list of segments associated with the company", + "inline": true, "properties": { "segments": "optional>", "type": { @@ -20389,6 +20557,7 @@ You can fetch all companies and filter by `segment_id` or `tag_id` as a query pa }, "CompanyTags": { "docs": "The list of tags associated with the company", + "inline": true, "properties": { "tags": "optional>", "type": { @@ -21250,6 +21419,7 @@ types: docs: The name of the plan source: openapi: ../openapi.yml + inline: true CompanyTags: docs: The list of tags associated with the company properties: @@ -21259,6 +21429,7 @@ types: tags: optional> source: openapi: ../openapi.yml + inline: true CompanySegments: docs: The list of segments associated with the company properties: @@ -21268,6 +21439,7 @@ types: segments: optional> source: openapi: ../openapi.yml + inline: true Company: docs: >- Companies allow you to represent organizations using your product. Each @@ -22639,6 +22811,7 @@ The data property will show a combined list of: "types": { "Contact": { "docs": "Contact are the objects that represent your leads and users in Intercom.", + "inline": undefined, "properties": { "android_app_name": { "docs": "The name of the Android app which the contact is using.", @@ -22825,6 +22998,7 @@ The data property will show a combined list of: }, "ContactAvatar": { "docs": undefined, + "inline": true, "properties": { "image_url": { "docs": "An image URL containing the avatar of a contact.", @@ -23983,6 +24157,7 @@ types: format: uri source: openapi: ../openapi.yml + inline: true Contact: docs: Contact are the objects that represent your leads and users in Intercom. properties: @@ -29241,6 +29416,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -29258,6 +29434,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, }, "AttachContactToConversationRequestCustomerIntercomUserId": { "docs": undefined, + "inline": true, "properties": { "customer": { "type": "optional", @@ -29273,6 +29450,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, }, "AttachContactToConversationRequestCustomerUserId": { "docs": undefined, + "inline": true, "properties": { "customer": { "type": "optional", @@ -29288,6 +29466,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, }, "Conversation": { "docs": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.", + "inline": undefined, "properties": { "admin_assignee_id": { "docs": "The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null.", @@ -29409,6 +29588,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, }, "CreateConversationRequestFrom": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The identifier for the contact which is given by Intercom.", @@ -29442,6 +29622,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, }, "Email": { "docs": undefined, + "inline": true, "properties": { "customer": { "type": "optional", @@ -33649,6 +33830,7 @@ types: maxLength: 24 source: openapi: ../openapi.yml + inline: true ManageConversationRequestBody: discriminant: message_type base-properties: {} @@ -33672,6 +33854,7 @@ types: type: optional source: openapi: ../openapi.yml + inline: true AttachContactToConversationRequestCustomerUserId: properties: user_id: @@ -33683,6 +33866,7 @@ types: type: optional source: openapi: ../openapi.yml + inline: true Email: properties: email: @@ -33694,6 +33878,7 @@ types: type: optional source: openapi: ../openapi.yml + inline: true AttachContactToConversationRequestCustomer: discriminated: false union: @@ -33702,6 +33887,7 @@ types: - type: Email source: openapi: ../openapi.yml + inline: true ConversationState: enum: - open @@ -33809,6 +33995,7 @@ types: "types": { "CustomObjectInstance": { "docs": "A Custom Object Instance represents an instance of a custom object type. This allows you to create and set custom attributes to store data about your customers that is not already captured by Intercom. The parent object includes recommended default attributes and you can add your own custom attributes.", + "inline": undefined, "properties": { "custom_attributes": { "docs": "The custom attributes you have set on the custom object instance.", @@ -34783,6 +34970,7 @@ You can update a data attribute. }, "DataAttribute": { "docs": "Data Attributes are metadata used to describe your contact, company and conversation models. These include standard and custom attributes. By using the data attributes endpoint, you can get the global list of attributes for your workspace, as well as create and archive custom attributes.", + "inline": undefined, "properties": { "admin_id": { "docs": "Teammate who created the attribute. Only applicable to CDAs", @@ -35917,6 +36105,7 @@ You can optionally define the result page size as well with the `per_page` param "types": { "CreateDataEventSummariesRequestEventSummaries": { "docs": "A list of event summaries for the user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.", + "inline": true, "properties": { "count": { "docs": "The number of times the event occurred.", @@ -35943,6 +36132,7 @@ You can optionally define the result page size as well with the `per_page` param "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -35960,6 +36150,7 @@ You can optionally define the result page size as well with the `per_page` param }, "LisDataEventsRequestFilterEmail": { "docs": undefined, + "inline": true, "properties": { "email": "string", }, @@ -35969,6 +36160,7 @@ You can optionally define the result page size as well with the `per_page` param }, "LisDataEventsRequestFilterIntercomUserId": { "docs": undefined, + "inline": true, "properties": { "intercom_user_id": "string", }, @@ -35978,6 +36170,7 @@ You can optionally define the result page size as well with the `per_page` param }, "LisDataEventsRequestFilterUserId": { "docs": undefined, + "inline": true, "properties": { "user_id": "string", }, @@ -35993,16 +36186,19 @@ You can optionally define the result page size as well with the `per_page` param user_id: string source: openapi: ../openapi.yml + inline: true LisDataEventsRequestFilterIntercomUserId: properties: intercom_user_id: string source: openapi: ../openapi.yml + inline: true LisDataEventsRequestFilterEmail: properties: email: string source: openapi: ../openapi.yml + inline: true LisDataEventsRequestFilter: discriminated: false union: @@ -36035,6 +36231,7 @@ You can optionally define the result page size as well with the `per_page` param docs: The last time the event was sent source: openapi: ../openapi.yml + inline: true imports: root: __package__.yml service: @@ -36472,6 +36669,7 @@ Your exported message data will be streamed continuously back down to you in a g "types": { "DataExport": { "docs": "The data export api is used to view all message sent & viewed in a given timeframe.", + "inline": undefined, "properties": { "download_expires_at": { "docs": "The time after which you will not be able to access the data.", @@ -38121,6 +38319,7 @@ Collections will be returned in descending order on the `updated_at` attribute. "types": { "Collection": { "docs": "Collections are top level containers for Articles within the Help Center.", + "inline": undefined, "properties": { "created_at": { "docs": "The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.", @@ -38180,6 +38379,7 @@ Collections will be returned in descending order on the `updated_at` attribute. }, "HelpCenter": { "docs": "Help Centers contain collections", + "inline": undefined, "properties": { "created_at": { "docs": "The time when the Help Center was created.", @@ -38216,6 +38416,7 @@ Collections will be returned in descending order on the `updated_at` attribute. }, "HelpCenterList": { "docs": "A list of Help Centers belonging to the App", + "inline": undefined, "properties": { "data": { "docs": "An array of Help Center objects", @@ -39651,6 +39852,7 @@ This will return the Message model that has been created. "types": { "Message": { "docs": "Message are how you reach out to contacts in Intercom. They are created when an admin sends an outbound message to a contact.", + "inline": undefined, "properties": { "body": { "docs": "The message body, which may contain HTML.", @@ -40430,6 +40632,7 @@ types: "types": { "NewsItem": { "docs": "A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.", + "inline": undefined, "properties": { "body": { "docs": "The news item body, which may contain HTML.", @@ -40509,6 +40712,7 @@ types: Newsfeeds currently cannot be edited through the API, please refer to [this article](https://www.intercom.com/help/en/articles/6362267-getting-started-with-news) to set up your newsfeeds in Intercom. ", + "inline": undefined, "properties": { "created_at": { "docs": "Timestamp for when the newsfeed was created.", @@ -40533,6 +40737,7 @@ Newsfeeds currently cannot be edited through the API, please refer to [this arti }, "NewsfeedAssignment": { "docs": "Assigns a news item to a newsfeed.", + "inline": undefined, "properties": { "newsfeed_id": { "docs": "The unique identifier for the newsfeed which is given by Intercom. Publish dates cannot be in the future, to schedule news items use the dedicated feature in app (see this article).", @@ -41409,6 +41614,7 @@ types: "types": { "Note": { "docs": "Notes allow you to annotate and comment on your contacts.", + "inline": undefined, "properties": { "author": { "docs": "Optional. Represents the Admin that created the note.", @@ -41441,6 +41647,7 @@ types: }, "NoteContact": { "docs": "Represents the contact that the note was created about.", + "inline": true, "properties": { "id": { "docs": "The id of the contact.", @@ -41741,6 +41948,7 @@ types: docs: The id of the contact. source: openapi: ../openapi.yml + inline: true Note: docs: Notes allow you to annotate and comment on your contacts. properties: @@ -41890,6 +42098,7 @@ types: "types": { "Segment": { "docs": "A segment is a group of your contacts defined by the rules that you set.", + "inline": undefined, "properties": { "count": { "docs": "The number of items in the user segment. It's returned when `include_count=true` is included in the request.", @@ -42340,6 +42549,7 @@ This will return a subscription type model for the subscription type that was ad "types": { "SubscriptionType": { "docs": "A subscription type lets customers easily opt out of non-essential communications without missing what's important to them.", + "inline": undefined, "properties": { "consent_type": { "docs": "Describes the type of consent.", @@ -43674,6 +43884,7 @@ This will return a tag object. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -43694,6 +43905,7 @@ This will return a tag object. }, "Tag": { "docs": "A tag allows you to label your contacts, companies, and conversations and list them using that tag.", + "inline": undefined, "properties": { "applied_at": { "docs": "The time when the tag was applied to the object", @@ -44424,6 +44636,7 @@ types: "types": { "Team": { "docs": "Teams are groups of admins in Intercom.", + "inline": undefined, "properties": { "admin_ids": { "docs": "The list of admin IDs that are a part of the team.", @@ -47087,6 +47300,7 @@ The table below shows the operators you can use to define how you want to search "types": { "Contacts": { "docs": "The list of contacts affected by a ticket.", + "inline": undefined, "properties": { "contacts": { "docs": "The list of contacts affected by this ticket.", @@ -47105,6 +47319,7 @@ The table below shows the operators you can use to define how you want to search "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -47122,6 +47337,7 @@ The table below shows the operators you can use to define how you want to search }, "CreateTicketRequestContactsItemExternalId": { "docs": undefined, + "inline": true, "properties": { "external_id": { "docs": "The external_id you have defined for the contact who is being added as a participant.", @@ -47134,6 +47350,7 @@ The table below shows the operators you can use to define how you want to search }, "Email": { "docs": undefined, + "inline": true, "properties": { "email": { "docs": "The email you have defined for the contact who is being added as a participant. If a contact with this email does not exist, one will be created.", @@ -47146,6 +47363,7 @@ The table below shows the operators you can use to define how you want to search }, "ID": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The identifier for the contact as given by Intercom.", @@ -47160,6 +47378,7 @@ The table below shows the operators you can use to define how you want to search "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -47174,6 +47393,7 @@ The table below shows the operators you can use to define how you want to search }, "Ticket": { "docs": "Tickets are how you track requests from your users.", + "inline": undefined, "properties": { "admin_assignee_id": { "docs": "The id representing the admin assigned to the ticket.", @@ -47267,6 +47487,7 @@ The table below shows the operators you can use to define how you want to search }, "TicketPart": { "docs": "A Ticket Part represents a message in the ticket.", + "inline": undefined, "properties": { "assigned_to": { "docs": "The id of the admin that was assigned the ticket by this ticket_part (null if there has been no change in assignment.)", @@ -47362,6 +47583,7 @@ The table below shows the operators you can use to define how you want to search }, "TicketType": { "docs": "A ticket type, used to define the data fields to be captured in a ticket.", + "inline": undefined, "properties": { "archived": { "docs": "Whether the ticket type is archived or not.", @@ -47427,6 +47649,7 @@ The table below shows the operators you can use to define how you want to search }, "UpdateTicketRequestAssignment": { "docs": undefined, + "inline": true, "properties": { "admin_id": { "docs": "The ID of the admin performing the action.", @@ -47471,6 +47694,7 @@ types: docs: The identifier for the contact as given by Intercom. source: openapi: ../openapi.yml + inline: true CreateTicketRequestContactsItemExternalId: properties: external_id: @@ -47480,6 +47704,7 @@ types: a participant. source: openapi: ../openapi.yml + inline: true Email: properties: email: @@ -47490,6 +47715,7 @@ types: created. source: openapi: ../openapi.yml + inline: true CreateTicketRequestContactsItem: discriminated: false union: @@ -47498,6 +47724,7 @@ types: - type: Email source: openapi: ../openapi.yml + inline: true UpdateTicketRequestState: enum: - in_progress @@ -47518,6 +47745,7 @@ types: 0 to unassign it. source: openapi: ../openapi.yml + inline: true TicketCategory: enum: - Customer diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/permit.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/permit.json index a3fa41b127e..5afedc6c120 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/permit.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/permit.json @@ -1234,6 +1234,7 @@ "types": { "ActionBlockEditable": { "docs": undefined, + "inline": undefined, "properties": { "attributes": { "type": "optional>", @@ -1253,6 +1254,7 @@ }, "ActionBlockRead": { "docs": undefined, + "inline": undefined, "properties": { "attributes": { "type": "optional>", @@ -1286,6 +1288,7 @@ }, "AddRolePermissions": { "docs": undefined, + "inline": undefined, "properties": { "permissions": { "docs": "List of permissions to assign to the role. If a permission is already granted to the role it is skipped. Each permission can be either a resource action id, or `{resource_key}:{action_key}`, i.e: the "permission name".", @@ -1298,6 +1301,7 @@ }, "AttributeBlockEditable": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "optional description string explaining what data this attribute will store", @@ -1314,6 +1318,7 @@ }, "AttributeBlockRead": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "optional description string explaining what data this attribute will store", @@ -1358,6 +1363,7 @@ }, "BulkRoleAssignmentReport": { "docs": undefined, + "inline": undefined, "properties": { "assignments_created": { "default": 0, @@ -1370,6 +1376,7 @@ }, "BulkRoleUnAssignmentReport": { "docs": undefined, + "inline": undefined, "properties": { "assignments_removed": { "default": 0, @@ -1382,6 +1389,7 @@ }, "ConditionSetRead": { "docs": undefined, + "inline": undefined, "properties": { "autogenerated": { "default": false, @@ -1484,6 +1492,7 @@ }, "ConditionSetRuleRead": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Date and time when the condition set rule was created (ISO_8601 format).", @@ -1566,6 +1575,7 @@ }, "EnvironmentCopyScope": { "docs": undefined, + "inline": undefined, "properties": { "resource_sets": { "docs": "Resource sets to copy", @@ -1590,6 +1600,7 @@ }, "EnvironmentCopyScopeFilters": { "docs": undefined, + "inline": undefined, "properties": { "exclude": { "docs": "Object to exclude (use * as wildcard)", @@ -1606,6 +1617,7 @@ }, "EnvironmentCopyTarget": { "docs": undefined, + "inline": undefined, "properties": { "existing": { "docs": "Identifier of an existing environment to copy into", @@ -1622,6 +1634,7 @@ }, "EnvironmentCreate": { "docs": undefined, + "inline": undefined, "properties": { "custom_branch_name": { "docs": "when using gitops feature, an optional branch name for the environment", @@ -1660,6 +1673,7 @@ }, "EnvironmentRead": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Date and time when the environment was created (ISO_8601 format).", @@ -1730,6 +1744,7 @@ }, "EnvironmentStats": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Date and time when the environment was created (ISO_8601 format).", @@ -1806,6 +1821,7 @@ }, "HTTPValidationError": { "docs": undefined, + "inline": undefined, "properties": { "detail": { "type": "optional>", @@ -1817,6 +1833,7 @@ }, "IdentityRead": { "docs": undefined, + "inline": undefined, "properties": { "auth0_info": { "docs": "Raw user info json coming from our identity provider and matching a specific account identity", @@ -1855,6 +1872,7 @@ }, "InviteRead": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Date and time when the invite was created (ISO_8601 format).", @@ -1941,6 +1959,7 @@ }, "JwksObj": { "docs": undefined, + "inline": undefined, "properties": { "keys": { "docs": "The keys to match against the request headers", @@ -1992,6 +2011,7 @@ }, "OrgMemberReadWithGrants": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Date and time when the account member was created (ISO_8601 format).", @@ -2083,6 +2103,7 @@ }, "OrganizationRead": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Date and time when the organization was created (ISO_8601 format).", @@ -2125,6 +2146,7 @@ }, "OrganizationReadWithAPIKey": { "docs": undefined, + "inline": undefined, "properties": { "api_key_id": { "type": "optional", @@ -2179,6 +2201,7 @@ }, "PDPConfigRead": { "docs": undefined, + "inline": undefined, "properties": { "client_secret": "string", "environment_id": { @@ -2230,6 +2253,7 @@ }, "PaginatedResultConditionSetRead": { "docs": undefined, + "inline": undefined, "properties": { "data": { "docs": "List of Condition Sets", @@ -2263,6 +2287,7 @@ }, "PaginatedResultResourceRead": { "docs": undefined, + "inline": undefined, "properties": { "data": { "docs": "List of Resources", @@ -2296,6 +2321,7 @@ }, "PaginatedResultResourceRoleRead": { "docs": undefined, + "inline": undefined, "properties": { "data": { "docs": "List of Resource Roles", @@ -2329,6 +2355,7 @@ }, "PaginatedResultRoleRead": { "docs": undefined, + "inline": undefined, "properties": { "data": { "docs": "List of Roles", @@ -2362,6 +2389,7 @@ }, "PaginatedResultTenantRead": { "docs": undefined, + "inline": undefined, "properties": { "data": { "docs": "List of Tenants", @@ -2395,6 +2423,7 @@ }, "PaginatedResultUserRead": { "docs": undefined, + "inline": undefined, "properties": { "data": { "docs": "List of Users", @@ -2428,6 +2457,7 @@ }, "Permission": { "docs": undefined, + "inline": undefined, "properties": { "access_level": { "type": "MemberAccessLevel", @@ -2487,6 +2517,7 @@ }, "ProjectRead": { "docs": undefined, + "inline": undefined, "properties": { "active_policy_repo_id": { "docs": "the id of the policy repo to use for this project", @@ -2564,6 +2595,7 @@ The actions represents the ways you can interact with a protected resource.", }, "RemoveRolePermissions": { "docs": undefined, + "inline": undefined, "properties": { "permissions": { "docs": "List of permissions to remove from the role. If a permission is not found it is skipped. Each permission can be either a resource action id, or `{resource_key}:{action_key}`,i.e: the "permission name".", @@ -2576,6 +2608,7 @@ The actions represents the ways you can interact with a protected resource.", }, "ResourceActionGroupRead": { "docs": undefined, + "inline": undefined, "properties": { "actions": { "type": "optional>", @@ -2667,6 +2700,7 @@ The actions represents the ways you can interact with a protected resource.", }, "ResourceActionRead": { "docs": undefined, + "inline": undefined, "properties": { "attributes": { "docs": "optional dictionary of key-value pairs that can be used to store arbitrary metadata about this action. This metadata can be used to filter actions using query parameters with attr_ prefix", @@ -2753,6 +2787,7 @@ The actions represents the ways you can interact with a protected resource.", }, "ResourceAttributeCreate": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "An optional longer description of what this attribute respresents in your system", @@ -2779,6 +2814,7 @@ The actions represents the ways you can interact with a protected resource.", }, "ResourceAttributeRead": { "docs": undefined, + "inline": undefined, "properties": { "built_in": { "docs": "Whether the attribute is built-in, and managed by the Permit system.", @@ -2865,6 +2901,7 @@ The actions represents the ways you can interact with a protected resource.", }, "ResourceAttributeUpdate": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "An optional longer description of what this attribute respresents in your system", @@ -2881,6 +2918,7 @@ The actions represents the ways you can interact with a protected resource.", }, "ResourceInstanceRead": { "docs": undefined, + "inline": undefined, "properties": { "attributes": { "docs": "Arbitraty resource attributes that will be used to enforce attribute-based access control policies.", @@ -2973,6 +3011,7 @@ The actions represents the ways you can interact with a protected resource.", }, "ResourceRead": { "docs": undefined, + "inline": undefined, "properties": { "action_groups": { "type": "optional>>", @@ -3059,6 +3098,7 @@ The actions represents the ways you can interact with a protected resource.", }, "ResourceRoleList": { "docs": undefined, + "inline": undefined, "properties": { "roles": { "display-name": "Roles", @@ -3071,6 +3111,7 @@ The actions represents the ways you can interact with a protected resource.", }, "ResourceRoleRead": { "docs": undefined, + "inline": undefined, "properties": { "attributes": { "docs": "optional dictionary of key-value pairs that can be used to store arbitrary metadata about this role. This metadata can be used to filter role using query parameters with attr_ prefix, currently supports only 'equals' operator", @@ -3161,6 +3202,7 @@ The actions represents the ways you can interact with a protected resource.", }, "RoleAssignmentCreate": { "docs": undefined, + "inline": undefined, "properties": { "role": { "docs": "the role that will be assigned (accepts either the role id or the role key)", @@ -3181,6 +3223,7 @@ The actions represents the ways you can interact with a protected resource.", }, "RoleAssignmentRead": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Date and time when the role assignment was created (ISO_8601 format).", @@ -3275,6 +3318,7 @@ The actions represents the ways you can interact with a protected resource.", }, "RoleAssignmentRemove": { "docs": undefined, + "inline": undefined, "properties": { "role": { "docs": "the role that will be unassigned (accepts either the role id or the role key)", @@ -3295,6 +3339,7 @@ The actions represents the ways you can interact with a protected resource.", }, "RoleBlock": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "optional description string explaining what this role represents, or what permissions are granted to it.", @@ -3311,6 +3356,7 @@ The actions represents the ways you can interact with a protected resource.", }, "RoleList": { "docs": undefined, + "inline": undefined, "properties": { "roles": { "display-name": "Roles", @@ -3323,6 +3369,7 @@ The actions represents the ways you can interact with a protected resource.", }, "RoleRead": { "docs": undefined, + "inline": undefined, "properties": { "attributes": { "docs": "optional dictionary of key-value pairs that can be used to store arbitrary metadata about this role. This metadata can be used to filter role using query parameters with attr_ prefix, currently supports only 'equals' operator", @@ -3405,6 +3452,7 @@ The actions represents the ways you can interact with a protected resource.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -3421,6 +3469,7 @@ The actions represents the ways you can interact with a protected resource.", }, "Statistics": { "docs": undefined, + "inline": undefined, "properties": { "has_decision_logs": "boolean", "members": { @@ -3483,6 +3532,7 @@ The actions represents the ways you can interact with a protected resource.", }, "TenantCreate": { "docs": undefined, + "inline": undefined, "properties": { "attributes": { "docs": "Arbitraty tenant attributes that will be used to enforce attribute-based access control policies.", @@ -3513,6 +3563,7 @@ The actions represents the ways you can interact with a protected resource.", }, "TenantCreateBulkOperationResult": { "docs": undefined, + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.json", @@ -3520,6 +3571,7 @@ The actions represents the ways you can interact with a protected resource.", }, "TenantDeleteBulkOperationResult": { "docs": undefined, + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.json", @@ -3527,6 +3579,7 @@ The actions represents the ways you can interact with a protected resource.", }, "TenantRead": { "docs": undefined, + "inline": undefined, "properties": { "attributes": { "docs": "Arbitraty tenant attributes that will be used to enforce attribute-based access control policies.", @@ -3603,6 +3656,7 @@ The actions represents the ways you can interact with a protected resource.", }, "UserCreate": { "docs": undefined, + "inline": undefined, "properties": { "attributes": { "docs": "Arbitrary user attributes that will be used to enforce attribute-based access control policies.", @@ -3643,6 +3697,7 @@ The actions represents the ways you can interact with a protected resource.", }, "UserCreateBulkOperationResult": { "docs": undefined, + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.json", @@ -3650,6 +3705,7 @@ The actions represents the ways you can interact with a protected resource.", }, "UserDeleteBulkOperationResult": { "docs": undefined, + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.json", @@ -3657,6 +3713,7 @@ The actions represents the ways you can interact with a protected resource.", }, "UserInTenant": { "docs": undefined, + "inline": undefined, "properties": { "roles": { "docs": "List of roles assigned to the user in that tenant", @@ -3677,6 +3734,7 @@ The actions represents the ways you can interact with a protected resource.", }, "UserRead": { "docs": undefined, + "inline": undefined, "properties": { "associated_tenants": { "type": "optional>", @@ -3758,6 +3816,7 @@ The actions represents the ways you can interact with a protected resource.", }, "UserReplaceBulkOperationResult": { "docs": undefined, + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.json", @@ -3765,6 +3824,7 @@ The actions represents the ways you can interact with a protected resource.", }, "UserRole": { "docs": undefined, + "inline": undefined, "properties": { "role": { "docs": "the role that is assigned", @@ -3791,6 +3851,7 @@ The actions represents the ways you can interact with a protected resource.", }, "ValidationError": { "docs": undefined, + "inline": undefined, "properties": { "loc": { "type": "list", @@ -3806,6 +3867,7 @@ The actions represents the ways you can interact with a protected resource.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -5671,6 +5733,7 @@ types: - type: PaginatedResultRoleRead source: openapi: ../openapi.json + inline: true ResourceRoleList: properties: roles: @@ -6163,6 +6226,7 @@ types: - integer source: openapi: ../openapi.json + inline: true ValidationError: properties: loc: @@ -8273,6 +8337,7 @@ Fields that will be provided will be completely overwritten.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -16344,6 +16409,7 @@ Fields that will be provided will be completely overwritten.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -18313,6 +18379,7 @@ Fields that will be provided will be completely overwritten.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -19476,6 +19543,7 @@ Fields that will be provided will be completely overwritten.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/query-params.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/query-params.json index 8106b4ca053..7805574f7b8 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/query-params.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/query-params.json @@ -54,6 +54,7 @@ "types": { "SearchRequestFilter": { "docs": undefined, + "inline": undefined, "properties": { "age": "optional", "location": "optional", @@ -65,6 +66,7 @@ }, "SearchRequestFilterLocation": { "docs": undefined, + "inline": true, "properties": { "city": "optional", "coordinates": "optional", @@ -76,6 +78,7 @@ }, "SearchRequestFilterLocationCoordinates": { "docs": undefined, + "inline": true, "properties": { "latitude": "optional", "longitude": "optional", @@ -95,6 +98,7 @@ }, "SearchResponse": { "docs": undefined, + "inline": undefined, "properties": { "results": "optional>", }, @@ -111,6 +115,7 @@ longitude: optional source: openapi: ../openapi.yml + inline: true SearchRequestFilterLocation: properties: city: optional @@ -118,6 +123,7 @@ coordinates: optional source: openapi: ../openapi.yml + inline: true SearchRequestFilter: properties: name: optional diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/readonly.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/readonly.json index f674df642c1..82e436f7c5a 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/readonly.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/readonly.json @@ -112,6 +112,7 @@ "types": { "UserRead": { "docs": undefined, + "inline": undefined, "properties": { "createdAt": "optional", "email": "optional", @@ -126,6 +127,7 @@ }, "UserSettingsRead": { "docs": undefined, + "inline": undefined, "properties": { "lastModified": "optional", "notifications": "optional", @@ -147,6 +149,7 @@ }, "UserStatsRead": { "docs": undefined, + "inline": undefined, "properties": { "accountStatus": "optional", "lastLoginTime": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/request-response-description.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/request-response-description.json index 42a5c8e8d06..6026fd7fecf 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/request-response-description.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/request-response-description.json @@ -42,6 +42,7 @@ "types": { "Schema1": { "docs": "Schema 1 description", + "inline": undefined, "properties": { "id": "optional", "name": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/rightbrain.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/rightbrain.json index be2c6d41b94..e3c61c58e6b 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/rightbrain.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/rightbrain.json @@ -5392,6 +5392,7 @@ "types": { "AsyncJobResult": { "docs": undefined, + "inline": undefined, "properties": { "status": "string", "task_id": { @@ -5656,6 +5657,7 @@ }, "BodyFetchOrgOrgIdProjectProjectIdDatasourceBoxConnectionIdFetchPost": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "list", @@ -5667,6 +5669,7 @@ }, "BodyFetchOrgOrgIdProjectProjectIdDatasourceConfluenceConnectionIdFetchPost": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "list", @@ -5678,6 +5681,7 @@ }, "BodyFetchOrgOrgIdProjectProjectIdDatasourceDropboxConnectionIdFetchPost": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "list", @@ -5689,6 +5693,7 @@ }, "BodyFetchOrgOrgIdProjectProjectIdDatasourceGdriveConnectionIdFetchPost": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "list", @@ -5700,6 +5705,7 @@ }, "BodyFetchOrgOrgIdProjectProjectIdDatasourceNotionConnectionIdFetchPost": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "list", @@ -5711,6 +5717,7 @@ }, "BodyFetchOrgOrgIdProjectProjectIdDatasourceOnedriveConnectionIdFetchPost": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "list", @@ -5722,6 +5729,7 @@ }, "BodyFetchOrgOrgIdProjectProjectIdDatasourceSharepointConnectionIdFetchPost": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "list", @@ -5733,6 +5741,7 @@ }, "Chat": { "docs": undefined, + "inline": undefined, "properties": { "collection_id": { "type": "string", @@ -5787,6 +5796,7 @@ }, "ChatConfig": { "docs": undefined, + "inline": undefined, "properties": { "chat_guardrails": { "docs": "Conversational Guardrails can be defined to run against Chat `input` (i.e. the users query) or on Chat `output` (i.e. the LLM output)", @@ -5826,6 +5836,7 @@ }, "ChatDocument": { "docs": undefined, + "inline": undefined, "properties": { "chunks": "integer", "connection_id": { @@ -5875,6 +5886,7 @@ }, "ChatDocumentEmbeddingInstance": { "docs": undefined, + "inline": undefined, "properties": { "chat_document_id": { "type": "string", @@ -5905,6 +5917,7 @@ }, "ChatDocumentEmbeddingRecord": { "docs": undefined, + "inline": undefined, "properties": { "document": "string", "id": { @@ -5923,6 +5936,7 @@ }, "ChatDocumentQueryResult": { "docs": undefined, + "inline": undefined, "properties": { "chat_document_id": { "type": "string", @@ -5976,6 +5990,7 @@ }, "ChatGuardrail": { "docs": undefined, + "inline": undefined, "properties": { "description": "string", "id": { @@ -6097,6 +6112,7 @@ }, "ChatModel": { "docs": undefined, + "inline": undefined, "properties": { "alias": { "docs": "Human readable name for the LLM.", @@ -6252,6 +6268,7 @@ }, "Collection": { "docs": undefined, + "inline": undefined, "properties": { "created": { "type": "datetime", @@ -6336,6 +6353,7 @@ }, "CollectionEmbeddingUpdate": { "docs": undefined, + "inline": undefined, "properties": { "embedding_instance_ids": { "type": "list", @@ -6506,6 +6524,7 @@ }, "CollectionStatsResponse": { "docs": undefined, + "inline": undefined, "properties": { "documents_by_source": { "type": "list", @@ -6518,6 +6537,7 @@ }, "ComposeContent": { "docs": undefined, + "inline": undefined, "properties": { "existing_content": "string", }, @@ -6527,6 +6547,7 @@ }, "ComposeGenerate": { "docs": undefined, + "inline": undefined, "properties": { "structure": { "type": "list", @@ -6538,6 +6559,7 @@ }, "ComposeInit": { "docs": undefined, + "inline": undefined, "properties": { "audience": { "type": "optional", @@ -6590,6 +6612,7 @@ }, "ComposeSectionTalkingPoint": { "docs": undefined, + "inline": undefined, "properties": { "section_heading": "string", }, @@ -6599,6 +6622,7 @@ }, "ComposeSectionUpdate": { "docs": undefined, + "inline": undefined, "properties": { "instructions": { "type": "list", @@ -6615,6 +6639,7 @@ }, "ConversationalGuardrails": { "docs": undefined, + "inline": undefined, "properties": { "input": { "docs": "List of valid Input Conversational Guardrails to enable", @@ -6721,6 +6746,7 @@ }, "Datasource": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "string", @@ -6739,6 +6765,7 @@ }, "DatasourceConfiguration": { "docs": undefined, + "inline": undefined, "properties": { "name": "string", "private": "boolean", @@ -6750,6 +6777,7 @@ }, "DatasourceConnection": { "docs": undefined, + "inline": undefined, "properties": { "config": { "type": "optional>", @@ -6804,6 +6832,7 @@ }, "DatasourceConnectionPublic": { "docs": undefined, + "inline": undefined, "properties": { "config": { "type": "optional>", @@ -6853,6 +6882,7 @@ }, "DatasourceSyncRun": { "docs": undefined, + "inline": undefined, "properties": { "created": { "type": "datetime", @@ -7033,6 +7063,7 @@ }, "DocumentCreateTask": { "docs": undefined, + "inline": undefined, "properties": { "info": { "type": "optional>", @@ -7261,6 +7292,7 @@ }, "DocumentStatusResponse": { "docs": undefined, + "inline": undefined, "properties": { "group_id": "string", "task_count": "integer", @@ -7328,6 +7360,7 @@ }, "EmptyErrorDetails": { "docs": undefined, + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -7677,6 +7710,7 @@ }, "HTTPValidationError": { "docs": undefined, + "inline": undefined, "properties": { "detail": { "type": "optional>", @@ -7688,6 +7722,7 @@ }, "HydraWebhookTokenHookSession": { "docs": undefined, + "inline": undefined, "properties": { "client_id": "string", "id_token": { @@ -7700,6 +7735,7 @@ }, "HydraWebhookTokenHookSessionIDTokenClaims": { "docs": undefined, + "inline": undefined, "properties": { "id_token_claims": { "type": "map", @@ -7711,6 +7747,7 @@ }, "IAMMember": { "docs": undefined, + "inline": undefined, "properties": { "avatar_url": { "docs": "If avatar of the member, if it is supported by their subject type.", @@ -7742,6 +7779,7 @@ Some entities, such as Organizations, may contain members that exist without any }, "IAMObjectErrorDetails": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", @@ -7754,6 +7792,7 @@ Some entities, such as Organizations, may contain members that exist without any }, "IAMPermissionTest": { "docs": undefined, + "inline": undefined, "properties": { "member": { "type": "optional", @@ -7780,6 +7819,7 @@ Some entities, such as Organizations, may contain members that exist without any "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -7792,6 +7832,7 @@ Some entities, such as Organizations, may contain members that exist without any }, "InitialComposeSection": { "docs": undefined, + "inline": undefined, "properties": { "ideas": { "type": "optional>", @@ -7823,6 +7864,7 @@ Some entities, such as Organizations, may contain members that exist without any }, "InputConversationalGuardrailDefinition": { "docs": undefined, + "inline": undefined, "properties": { "name": { "type": "Name", @@ -7834,6 +7876,7 @@ Some entities, such as Organizations, may contain members that exist without any }, "InvalidMemberErrorDetails": { "docs": undefined, + "inline": undefined, "properties": { "resource": { "type": "optional", @@ -7848,6 +7891,7 @@ Some entities, such as Organizations, may contain members that exist without any }, "InvalidMemberErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "invalidMemberError": { "docs": "Metadata detailing more information about the error.", @@ -7864,6 +7908,7 @@ Some entities, such as Organizations, may contain members that exist without any }, "InvalidRoleErrorDetails": { "docs": undefined, + "inline": undefined, "properties": { "resource": { "type": "optional", @@ -7876,6 +7921,7 @@ Some entities, such as Organizations, may contain members that exist without any }, "InvalidRoleErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "invalidRoleError": { "docs": "Metadata detailing more information about the error.", @@ -7892,6 +7938,7 @@ Some entities, such as Organizations, may contain members that exist without any }, "InvalidSubjectTypeErrorDetails": { "docs": undefined, + "inline": undefined, "properties": { "subject": { "type": "optional", @@ -7903,6 +7950,7 @@ Some entities, such as Organizations, may contain members that exist without any }, "InvalidSubjectTypeErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "invalidSubjectTypeError": { "docs": "Metadata detailing more information about the error.", @@ -7920,6 +7968,7 @@ Some entities, such as Organizations, may contain members that exist without any "KratosIdentity": { "docs": undefined, "extra-properties": true, + "inline": undefined, "properties": { "id": { "type": "string", @@ -7939,6 +7988,7 @@ Some entities, such as Organizations, may contain members that exist without any "KratosIdentityTraits": { "docs": undefined, "extra-properties": true, + "inline": undefined, "properties": { "avatar_url": { "type": "optional", @@ -7983,6 +8033,7 @@ Some entities, such as Organizations, may contain members that exist without any }, "KratosWebhook": { "docs": undefined, + "inline": undefined, "properties": { "bio": { "type": "optional", @@ -8031,6 +8082,7 @@ Some entities, such as Organizations, may contain members that exist without any "KratosWebhookDetailedMessage": { "docs": "Sourced from detailedMessage in: https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", + "inline": undefined, "properties": { "context": { "type": "optional", @@ -8048,6 +8100,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", "KratosWebhookErrorMessage": { "docs": "Sourced from errorMessage in: https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", + "inline": undefined, "properties": { "instance_ptr": "string", "messages": { @@ -8061,6 +8114,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", "KratosWebhookResponse": { "docs": "Sourced from rawHookResponse in: https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", + "inline": undefined, "properties": { "identity": { "type": "optional", @@ -8327,6 +8381,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "MalformedResourceIdentifierErrorDetails": { "docs": undefined, + "inline": undefined, "properties": { "expected_format": "string", "field": "string", @@ -8338,6 +8393,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "MalformedResourceIdentifierErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "malformedResourceIdentifierError": { "docs": "Metadata detailing more information about the error.", @@ -8354,6 +8410,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "MissingAuthenticationErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "message": { "docs": "Human readable representation of the error", @@ -8370,6 +8427,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "MultipleRolesNotAllowedErrorDetails": { "docs": undefined, + "inline": undefined, "properties": { "resource": { "type": "optional", @@ -8384,6 +8442,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "MultipleRolesNotAllowedErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "message": { "docs": "Human readable representation of the error", @@ -8409,6 +8468,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "OAuthClientCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "client_id": { "type": "string", @@ -8446,6 +8506,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "Object": { "docs": undefined, + "inline": undefined, "properties": { "createdTime": { "type": "optional", @@ -8497,6 +8558,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "Org": { "docs": undefined, + "inline": undefined, "properties": { "avatar_url": { "type": "optional", @@ -8749,6 +8811,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "OrganizationDomain": { "docs": undefined, + "inline": undefined, "properties": { "domain": "string", "id": { @@ -8893,6 +8956,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "OrganizationInvite": { "docs": undefined, + "inline": undefined, "properties": { "email_address": { "type": "string", @@ -8922,6 +8986,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "OrganizationInviteAlreadyExistsErrorDetails": { "docs": undefined, + "inline": undefined, "properties": { "email_address": "string", "organization_id": "string", @@ -8932,6 +8997,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "OrganizationInviteAlreadyExistsErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "message": { "docs": "Human readable representation of the error", @@ -8948,6 +9014,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "OrganizationMemberAlreadyExistsErrorDetails": { "docs": undefined, + "inline": undefined, "properties": { "member_id": "string", "organization_id": "string", @@ -8958,6 +9025,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "OrganizationMemberAlreadyExistsErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "message": { "docs": "Human readable representation of the error", @@ -8974,6 +9042,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "OutputConversationalGuardrailDefinition": { "docs": undefined, + "inline": undefined, "properties": { "name": { "type": "literal<"source_validation">", @@ -8985,6 +9054,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetChat": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -9001,6 +9071,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetChatDocument": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -9017,6 +9088,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetChatDocumentEmbeddingRecord": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -9033,6 +9105,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetCollection": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -9049,6 +9122,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetDatasourceSyncRun": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -9065,6 +9139,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetIamMember": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -9081,6 +9156,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetOrganizationDomain": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -9097,6 +9173,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetOrganizationInvite": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -9113,6 +9190,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetProject": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -9129,6 +9207,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetTask": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -9145,6 +9224,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetTaskForwarder": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -9161,6 +9241,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetTaskRun": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -9177,6 +9258,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginationDetails": { "docs": undefined, + "inline": undefined, "properties": { "has_next": { "docs": "Indicates whether there are more results available in the next page.", @@ -9197,6 +9279,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PermissionCheckFailedErrorDetails": { "docs": undefined, + "inline": undefined, "properties": { "permission": "string", "resource": { @@ -9212,6 +9295,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PermissionCheckFailedErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "message": { "docs": "Human readable representation of the error", @@ -9228,6 +9312,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "Project": { "docs": undefined, + "inline": undefined, "properties": { "avatar_url": { "type": "optional", @@ -9267,6 +9352,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "ProjectConfig": { "docs": undefined, + "inline": undefined, "properties": { "chat_guardrails": { "type": "optional", @@ -9446,6 +9532,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "ProjectWithDatasources": { "docs": undefined, + "inline": undefined, "properties": { "avatar_url": { "type": "optional", @@ -9756,6 +9843,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "SourceRow": { "docs": undefined, + "inline": undefined, "properties": { "count": "integer", "source": { @@ -9790,6 +9878,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "Task": { "docs": undefined, + "inline": undefined, "properties": { "created": { "docs": "When the Task was created.", @@ -9842,6 +9931,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "TaskForwarder": { "docs": undefined, + "inline": undefined, "properties": { "config": { "docs": "Configuration parameters for the Task Forwarder such as a `destination` URL.", @@ -9894,6 +9984,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "TaskForwarderConfig": { "docs": undefined, + "inline": undefined, "properties": { "destination_url": { "docs": "The URL where Task Run result will be forwarded. Must be a valid HTTPS URL.", @@ -9906,6 +9997,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "TaskForwarderSensitiveConfig": { "docs": undefined, + "inline": undefined, "properties": { "signing_key": { "docs": "A secret key used to sign the forwarded data for verification purposes.", @@ -10041,6 +10133,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "TaskLLMConfig": { "docs": undefined, + "inline": undefined, "properties": { "temperature": { "default": 0.2, @@ -10061,6 +10154,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "TaskRAG": { "docs": undefined, + "inline": undefined, "properties": { "collection_id": { "type": "string", @@ -10079,6 +10173,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "TaskRevision": { "docs": undefined, + "inline": undefined, "properties": { "active": { "default": false, @@ -10217,6 +10312,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "TaskRun": { "docs": undefined, + "inline": undefined, "properties": { "created": { "docs": "The timestamp when the Task Run was created.", @@ -10394,6 +10490,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "User": { "docs": undefined, + "inline": undefined, "properties": { "avatar_url": { "type": "optional", @@ -10427,6 +10524,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "ValidationError": { "docs": undefined, + "inline": undefined, "properties": { "loc": { "type": "list", @@ -10442,6 +10540,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -15796,6 +15895,7 @@ types: - type: KratosIdentity source: openapi: ../openapi.yml + inline: true KratosWebhookResponse: docs: |- Sourced from rawHookResponse in: @@ -16505,6 +16605,7 @@ types: - integer source: openapi: ../openapi.yml + inline: true ValidationError: properties: loc: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/rules.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/rules.json index 3cafaa6db95..082e1bbf8ef 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/rules.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/rules.json @@ -46,6 +46,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -56,6 +57,7 @@ }, "GetExampleResponseMessage": { "docs": undefined, + "inline": true, "properties": { "message": "optional", }, @@ -65,6 +67,7 @@ }, "Schema": { "docs": undefined, + "inline": undefined, "properties": { "age": { "default": 50, @@ -135,6 +138,7 @@ message: optional source: openapi: ../openapi.yml + inline: true GetExampleResponse: discriminated: false union: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/seam.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/seam.json index 6390c88dce5..2e4e18fb434 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/seam.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/seam.json @@ -1280,6 +1280,7 @@ "types": { "AccessCode": { "docs": undefined, + "inline": undefined, "properties": { "access_code_id": { "docs": "Unique identifier for the access code.", @@ -1411,6 +1412,7 @@ }, "AcsAccessGroup": { "docs": undefined, + "inline": undefined, "properties": { "access_group_type": { "docs": " @@ -1494,6 +1496,7 @@ }, "AcsCredential": { "docs": undefined, + "inline": undefined, "properties": { "access_method": "AcsCredentialAccessMethod", "acs_credential_id": { @@ -1588,6 +1591,7 @@ }, "AcsCredentialErrorsItem": { "docs": undefined, + "inline": true, "properties": { "error_code": "string", "message": "string", @@ -1609,6 +1613,7 @@ }, "AcsCredentialPool": { "docs": undefined, + "inline": undefined, "properties": { "acs_credential_pool_id": { "type": "string", @@ -1656,6 +1661,7 @@ }, "AcsCredentialProvisioningAutomation": { "docs": undefined, + "inline": undefined, "properties": { "acs_credential_provisioning_automation_id": { "type": "string", @@ -1701,6 +1707,7 @@ }, "AcsCredentialVisionlineMetadata": { "docs": undefined, + "inline": true, "properties": { "card_function_type": "AcsCredentialVisionlineMetadataCardFunctionType", "common_acs_entrance_ids": "optional>", @@ -1722,6 +1729,7 @@ }, "AcsCredentialWarningsItem": { "docs": undefined, + "inline": true, "properties": { "message": "string", "warning_code": "string", @@ -1732,6 +1740,7 @@ }, "AcsEntrance": { "docs": undefined, + "inline": undefined, "properties": { "acs_entrance_id": { "type": "string", @@ -1763,6 +1772,7 @@ }, "AcsEntranceErrorsItem": { "docs": undefined, + "inline": true, "properties": { "error_code": "string", "message": "string", @@ -1773,6 +1783,7 @@ }, "AcsEntranceLatchMetadata": { "docs": undefined, + "inline": true, "properties": { "accessibility_type": "string", "door_name": "string", @@ -1785,6 +1796,7 @@ }, "AcsEntranceVisionlineMetadata": { "docs": undefined, + "inline": true, "properties": { "door_category": "AcsEntranceVisionlineMetadataDoorCategory", "door_name": "string", @@ -1814,6 +1826,7 @@ }, "AcsEntranceVisionlineMetadataProfilesItem": { "docs": undefined, + "inline": true, "properties": { "visionline_door_profile_id": "string", "visionline_door_profile_type": "AcsEntranceVisionlineMetadataProfilesItemVisionlineDoorProfileType", @@ -1834,6 +1847,7 @@ }, "AcsSystem": { "docs": undefined, + "inline": undefined, "properties": { "acs_system_id": { "type": "string", @@ -1903,6 +1917,7 @@ }, "AcsSystemErrorsItemSeamBridgeDisconnected": { "docs": undefined, + "inline": true, "properties": { "created_at": "datetime", "message": "string", @@ -1913,6 +1928,7 @@ }, "AcsSystemErrorsItemVisionlineInstanceUnreachable": { "docs": undefined, + "inline": true, "properties": { "created_at": "datetime", "message": "string", @@ -1958,6 +1974,7 @@ }, "AcsSystemWarningsItem": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.json", @@ -1965,6 +1982,7 @@ }, "AcsUser": { "docs": undefined, + "inline": undefined, "properties": { "access_schedule": "optional", "acs_system_id": { @@ -2044,6 +2062,7 @@ }, "AcsUserAccessSchedule": { "docs": undefined, + "inline": true, "properties": { "ends_at": "datetime", "starts_at": "datetime", @@ -2068,6 +2087,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -2193,6 +2213,7 @@ }, "ActionAttemptActionAttemptId": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2220,6 +2241,7 @@ }, "ActionAttemptActionAttemptIdError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -2230,6 +2252,7 @@ }, "ActionAttemptEight": { "docs": "Resetting sandbox workspace failed.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2257,6 +2280,7 @@ }, "ActionAttemptEightError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -2267,6 +2291,7 @@ }, "ActionAttemptEighteen": { "docs": "Setting fan mode.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2294,6 +2319,7 @@ }, "ActionAttemptEleven": { "docs": "Setting HVAC to cool failed.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2321,6 +2347,7 @@ }, "ActionAttemptElevenError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -2331,6 +2358,7 @@ }, "ActionAttemptFifteen": { "docs": "Setting HVAC to heat-cool mode.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2358,6 +2386,7 @@ }, "ActionAttemptFive": { "docs": "Unlocking door failed.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2385,6 +2414,7 @@ }, "ActionAttemptFiveError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -2395,6 +2425,7 @@ }, "ActionAttemptForty": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2422,6 +2453,7 @@ }, "ActionAttemptFortyOne": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2449,6 +2481,7 @@ }, "ActionAttemptFortyOneError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -2459,6 +2492,7 @@ }, "ActionAttemptFortyThree": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2486,6 +2520,7 @@ }, "ActionAttemptFortyTwo": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2513,6 +2548,7 @@ }, "ActionAttemptFour": { "docs": "Unlocking door succeeded.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2540,6 +2576,7 @@ }, "ActionAttemptFourResult": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.json", @@ -2547,6 +2584,7 @@ }, "ActionAttemptFourteen": { "docs": "Setting HVAC to heat mode failed.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2574,6 +2612,7 @@ }, "ActionAttemptFourteenError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -2584,6 +2623,7 @@ }, "ActionAttemptNine": { "docs": "Setting HVAC to cool.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2611,6 +2651,7 @@ }, "ActionAttemptNineteen": { "docs": "Setting fan mode succeeded.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2638,6 +2679,7 @@ }, "ActionAttemptNineteenResult": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.json", @@ -2645,6 +2687,7 @@ }, "ActionAttemptOne": { "docs": "Locking door succeeded.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2672,6 +2715,7 @@ }, "ActionAttemptOneResult": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.json", @@ -2679,6 +2723,7 @@ }, "ActionAttemptSeven": { "docs": "Resetting sandbox workspace succeeded.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2706,6 +2751,7 @@ }, "ActionAttemptSevenResult": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.json", @@ -2713,6 +2759,7 @@ }, "ActionAttemptSeventeen": { "docs": "Setting heat-cool mode failed.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2740,6 +2787,7 @@ }, "ActionAttemptSeventeenError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -2750,6 +2798,7 @@ }, "ActionAttemptSix": { "docs": "Resetting sandbox workspace.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2777,6 +2826,7 @@ }, "ActionAttemptSixteen": { "docs": "Setting HVAC to heat-cool mode succeeded.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2804,6 +2854,7 @@ }, "ActionAttemptSixteenResult": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.json", @@ -2811,6 +2862,7 @@ }, "ActionAttemptTen": { "docs": "Setting HVAC to cool succeeded.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2838,6 +2890,7 @@ }, "ActionAttemptTenResult": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.json", @@ -2845,6 +2898,7 @@ }, "ActionAttemptThirteen": { "docs": "Setting HVAC to heat mode succeeded.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2872,6 +2926,7 @@ }, "ActionAttemptThirteenResult": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.json", @@ -2879,6 +2934,7 @@ }, "ActionAttemptThirty": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2906,6 +2962,7 @@ }, "ActionAttemptThirtyEight": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2933,6 +2990,7 @@ }, "ActionAttemptThirtyEightError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -2943,6 +3001,7 @@ }, "ActionAttemptThirtyFive": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2970,6 +3029,7 @@ }, "ActionAttemptThirtyFiveError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -2980,6 +3040,7 @@ }, "ActionAttemptThirtyFour": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -3007,6 +3068,7 @@ }, "ActionAttemptThirtyNine": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -3034,6 +3096,7 @@ }, "ActionAttemptThirtyOne": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -3061,6 +3124,7 @@ }, "ActionAttemptThirtySeven": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -3088,6 +3152,7 @@ }, "ActionAttemptThirtySix": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -3115,6 +3180,7 @@ }, "ActionAttemptThirtyThree": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -3142,6 +3208,7 @@ }, "ActionAttemptThirtyTwo": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -3169,6 +3236,7 @@ }, "ActionAttemptThirtyTwoError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -3179,6 +3247,7 @@ }, "ActionAttemptThree": { "docs": "Unlocking door.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -3206,6 +3275,7 @@ }, "ActionAttemptTwelve": { "docs": "Setting HVAC to heat mode.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -3233,6 +3303,7 @@ }, "ActionAttemptTwenty": { "docs": "Setting fan mode failed.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -3260,6 +3331,7 @@ }, "ActionAttemptTwentyEight": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -3287,6 +3359,7 @@ }, "ActionAttemptTwentyError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -3297,6 +3370,7 @@ }, "ActionAttemptTwentyFive": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -3324,6 +3398,7 @@ }, "ActionAttemptTwentyFour": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -3351,6 +3426,7 @@ }, "ActionAttemptTwentyNine": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -3378,6 +3454,7 @@ }, "ActionAttemptTwentyNineError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -3388,6 +3465,7 @@ }, "ActionAttemptTwentyOne": { "docs": "Turning HVAC off.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -3415,6 +3493,7 @@ }, "ActionAttemptTwentySeven": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -3442,6 +3521,7 @@ }, "ActionAttemptTwentySix": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -3469,6 +3549,7 @@ }, "ActionAttemptTwentySixError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -3479,6 +3560,7 @@ }, "ActionAttemptTwentyThree": { "docs": "Turning HVAC off failed.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -3506,6 +3588,7 @@ }, "ActionAttemptTwentyThreeError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -3516,6 +3599,7 @@ }, "ActionAttemptTwentyTwo": { "docs": "Turning HVAC off succeeded.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -3543,6 +3627,7 @@ }, "ActionAttemptTwentyTwoResult": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.json", @@ -3550,6 +3635,7 @@ }, "ActionAttemptTwo": { "docs": "Locking door failed.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -3577,6 +3663,7 @@ }, "ActionAttemptTwoError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -3587,6 +3674,7 @@ }, "ActionAttemptZero": { "docs": "Locking door.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -3614,6 +3702,7 @@ }, "ClientSession": { "docs": undefined, + "inline": undefined, "properties": { "client_session_id": { "type": "string", @@ -3647,6 +3736,7 @@ }, "ClimateSettingSchedule": { "docs": undefined, + "inline": undefined, "properties": { "automatic_cooling_enabled": "optional", "automatic_heating_enabled": "optional", @@ -3698,6 +3788,7 @@ }, "ConnectWebview": { "docs": undefined, + "inline": undefined, "properties": { "accepted_devices": { "docs": " @@ -3789,6 +3880,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -3819,6 +3911,7 @@ }, "ConnectedAccount": { "docs": undefined, + "inline": undefined, "properties": { "account_type": "optional", "account_type_display_name": "string", @@ -3846,6 +3939,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -3856,6 +3950,7 @@ }, "ConnectedAccountUserIdentifier": { "docs": undefined, + "inline": true, "properties": { "api_url": "optional", "email": "optional", @@ -3869,6 +3964,7 @@ }, "Device": { "docs": undefined, + "inline": undefined, "properties": { "can_program_offline_access_codes": "optional", "can_program_online_access_codes": "optional", @@ -3970,6 +4066,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -4021,6 +4118,7 @@ }, "DeviceErrorsItem": { "docs": undefined, + "inline": true, "properties": { "error_code": "string", "message": "string", @@ -4031,6 +4129,7 @@ }, "DeviceLocation": { "docs": "Location information for the device.", + "inline": true, "properties": { "location_name": { "docs": "Name of the device location.", @@ -4047,6 +4146,7 @@ }, "DeviceProperties": { "docs": "Properties of the device.", + "inline": true, "properties": { "_experimental_supported_code_from_access_codes_lengths": "optional>", "accessory_keypad": { @@ -4183,6 +4283,7 @@ }, "DevicePropertiesAccessoryKeypad": { "docs": "Represents the accessory keypad state.", + "inline": true, "properties": { "battery": { "docs": "Indicates if the keypad battery properties.", @@ -4199,6 +4300,7 @@ }, "DevicePropertiesAccessoryKeypadBattery": { "docs": "Indicates if the keypad battery properties.", + "inline": true, "properties": { "level": { "type": "double", @@ -4217,6 +4319,7 @@ }, "DevicePropertiesAppearance": { "docs": undefined, + "inline": true, "properties": { "name": { "docs": "Name of the device as seen from the provider API and application, not settable through Seam.", @@ -4229,6 +4332,7 @@ }, "DevicePropertiesAssaAbloyCredentialServiceMetadata": { "docs": undefined, + "inline": true, "properties": { "endpoints": "list", "has_active_endpoint": "boolean", @@ -4239,6 +4343,7 @@ }, "DevicePropertiesAssaAbloyCredentialServiceMetadataEndpointsItem": { "docs": undefined, + "inline": true, "properties": { "endpoint_id": "string", "is_active": "boolean", @@ -4249,6 +4354,7 @@ }, "DevicePropertiesAugustMetadata": { "docs": undefined, + "inline": true, "properties": { "has_keypad": "boolean", "house_id": "optional", @@ -4264,6 +4370,7 @@ }, "DevicePropertiesAvigilonAltaMetadata": { "docs": undefined, + "inline": true, "properties": { "entry_name": "string", "entry_relays_total_count": "double", @@ -4279,6 +4386,7 @@ }, "DevicePropertiesBattery": { "docs": "Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage.", + "inline": true, "properties": { "level": { "type": "double", @@ -4309,6 +4417,7 @@ }, "DevicePropertiesBrivoMetadata": { "docs": undefined, + "inline": true, "properties": { "device_name": "string", }, @@ -4320,6 +4429,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -4330,6 +4440,7 @@ }, "DevicePropertiesCodeConstraintsItemMaxLength": { "docs": undefined, + "inline": true, "properties": { "constraint_type": "DevicePropertiesCodeConstraintsItemMaxLengthConstraintType", "max_length": "optional", @@ -4350,6 +4461,7 @@ }, "DevicePropertiesCodeConstraintsItemZero": { "docs": undefined, + "inline": true, "properties": { "constraint_type": "DevicePropertiesCodeConstraintsItemZeroConstraintType", }, @@ -4375,6 +4487,7 @@ }, "DevicePropertiesControlbywebMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "string", "device_name": "string", @@ -4386,6 +4499,7 @@ }, "DevicePropertiesDormakabaOracodeMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "optional", "door_id": "double", @@ -4402,6 +4516,7 @@ }, "DevicePropertiesDormakabaOracodeMetadataPredefinedTimeSlotsItem": { "docs": undefined, + "inline": true, "properties": { "check_in_time": "string", "check_out_time": "string", @@ -4428,6 +4543,7 @@ }, "DevicePropertiesEcobeeMetadata": { "docs": undefined, + "inline": true, "properties": { "device_name": "string", "ecobee_device_id": "string", @@ -4438,6 +4554,7 @@ }, "DevicePropertiesFourSuitesMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "double", "device_name": "string", @@ -4449,6 +4566,7 @@ }, "DevicePropertiesGenieMetadata": { "docs": undefined, + "inline": true, "properties": { "device_name": "string", "door_name": "string", @@ -4459,6 +4577,7 @@ }, "DevicePropertiesHoneywellResideoMetadata": { "docs": undefined, + "inline": true, "properties": { "device_name": "string", "honeywell_resideo_device_id": "string", @@ -4469,6 +4588,7 @@ }, "DevicePropertiesHubitatMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "string", "device_label": "string", @@ -4480,6 +4600,7 @@ }, "DevicePropertiesIglooMetadata": { "docs": undefined, + "inline": true, "properties": { "bridge_id": "string", "device_id": "string", @@ -4491,6 +4612,7 @@ }, "DevicePropertiesIgloohomeMetadata": { "docs": undefined, + "inline": true, "properties": { "bridge_id": "optional", "bridge_name": "optional", @@ -4504,6 +4626,7 @@ }, "DevicePropertiesKeypadBattery": { "docs": undefined, + "inline": true, "properties": { "level": "double", }, @@ -4513,6 +4636,7 @@ }, "DevicePropertiesKwiksetMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "string", "device_name": "string", @@ -4524,6 +4648,7 @@ }, "DevicePropertiesLocklyMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "string", "device_name": "string", @@ -4535,6 +4660,7 @@ }, "DevicePropertiesMinutMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "string", "device_name": "string", @@ -4546,6 +4672,7 @@ }, "DevicePropertiesMinutMetadataLatestSensorValues": { "docs": undefined, + "inline": true, "properties": { "accelerometer_z": "DevicePropertiesMinutMetadataLatestSensorValuesAccelerometerZ", "humidity": "DevicePropertiesMinutMetadataLatestSensorValuesHumidity", @@ -4559,6 +4686,7 @@ }, "DevicePropertiesMinutMetadataLatestSensorValuesAccelerometerZ": { "docs": undefined, + "inline": true, "properties": { "time": "string", "value": "double", @@ -4569,6 +4697,7 @@ }, "DevicePropertiesMinutMetadataLatestSensorValuesHumidity": { "docs": undefined, + "inline": true, "properties": { "time": "string", "value": "double", @@ -4579,6 +4708,7 @@ }, "DevicePropertiesMinutMetadataLatestSensorValuesPressure": { "docs": undefined, + "inline": true, "properties": { "time": "string", "value": "double", @@ -4589,6 +4719,7 @@ }, "DevicePropertiesMinutMetadataLatestSensorValuesSound": { "docs": undefined, + "inline": true, "properties": { "time": "string", "value": "double", @@ -4599,6 +4730,7 @@ }, "DevicePropertiesMinutMetadataLatestSensorValuesTemperature": { "docs": undefined, + "inline": true, "properties": { "time": "string", "value": "double", @@ -4609,6 +4741,7 @@ }, "DevicePropertiesModel": { "docs": undefined, + "inline": true, "properties": { "accessory_keypad_supported": { "docs": " @@ -4649,6 +4782,7 @@ }, "DevicePropertiesNestMetadata": { "docs": undefined, + "inline": true, "properties": { "custom_name": "string", "device_name": "string", @@ -4660,6 +4794,7 @@ }, "DevicePropertiesNoiseawareMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "string", "device_model": "DevicePropertiesNoiseawareMetadataDeviceModel", @@ -4682,6 +4817,7 @@ }, "DevicePropertiesNukiMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "string", "device_name": "string", @@ -4695,6 +4831,7 @@ }, "DevicePropertiesSaltoMetadata": { "docs": undefined, + "inline": true, "properties": { "battery_level": "string", "customer_reference": "string", @@ -4709,6 +4846,7 @@ }, "DevicePropertiesSchlageMetadata": { "docs": undefined, + "inline": true, "properties": { "access_code_length": "optional", "device_id": "string", @@ -4721,6 +4859,7 @@ }, "DevicePropertiesSeamBridgeMetadata": { "docs": undefined, + "inline": true, "properties": { "device_num": "double", "name": "string", @@ -4741,6 +4880,7 @@ }, "DevicePropertiesSmartthingsMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "string", "device_name": "string", @@ -4753,6 +4893,7 @@ }, "DevicePropertiesTedeeMetadata": { "docs": undefined, + "inline": true, "properties": { "bridge_id": "double", "bridge_name": "string", @@ -4768,6 +4909,7 @@ }, "DevicePropertiesTtlockMetadata": { "docs": undefined, + "inline": true, "properties": { "feature_value": "string", "lock_alias": "string", @@ -4779,6 +4921,7 @@ }, "DevicePropertiesTwoNMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "double", "device_name": "string", @@ -4789,6 +4932,7 @@ }, "DevicePropertiesWyzeMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "string", "device_info_model": "string", @@ -4805,6 +4949,7 @@ }, "DeviceProvider": { "docs": undefined, + "inline": undefined, "properties": { "device_provider_name": "DeviceProviderDeviceProviderName", "display_name": "string", @@ -4873,6 +5018,7 @@ }, "DeviceWarningsItem": { "docs": undefined, + "inline": true, "properties": { "message": "string", "warning_code": "string", @@ -4883,6 +5029,7 @@ }, "EnrollmentAutomation": { "docs": undefined, + "inline": undefined, "properties": { "created_at": "datetime", "credential_manager_acs_system_id": { @@ -4928,6 +5075,7 @@ }, "Event": { "docs": undefined, + "inline": undefined, "properties": { "acs_credential_id": { "type": "optional", @@ -5020,6 +5168,7 @@ }, "Network": { "docs": undefined, + "inline": undefined, "properties": { "created_at": "datetime", "display_name": "string", @@ -5048,6 +5197,7 @@ }, "NoiseThreshold": { "docs": undefined, + "inline": undefined, "properties": { "device_id": { "type": "string", @@ -5079,6 +5229,7 @@ }, "Phone": { "docs": undefined, + "inline": undefined, "properties": { "can_program_offline_access_codes": "optional", "can_program_online_access_codes": "optional", @@ -5164,6 +5315,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -5183,6 +5335,7 @@ }, "PhoneErrorsItem": { "docs": undefined, + "inline": true, "properties": { "error_code": "string", "message": "string", @@ -5193,6 +5346,7 @@ }, "PhoneLocation": { "docs": "Location information for the device.", + "inline": true, "properties": { "location_name": { "docs": "Name of the device location.", @@ -5209,6 +5363,7 @@ }, "PhoneProperties": { "docs": undefined, + "inline": true, "properties": { "assa_abloy_credential_service_metadata": "optional", }, @@ -5218,6 +5373,7 @@ }, "PhonePropertiesAssaAbloyCredentialServiceMetadata": { "docs": undefined, + "inline": true, "properties": { "endpoints": "list", "has_active_endpoint": "boolean", @@ -5228,6 +5384,7 @@ }, "PhonePropertiesAssaAbloyCredentialServiceMetadataEndpointsItem": { "docs": undefined, + "inline": true, "properties": { "endpoint_id": "string", "is_active": "boolean", @@ -5238,6 +5395,7 @@ }, "PhoneWarningsItem": { "docs": undefined, + "inline": true, "properties": { "message": "string", "warning_code": "string", @@ -5248,6 +5406,7 @@ }, "ServiceHealth": { "docs": undefined, + "inline": undefined, "properties": { "description": "string", "service": "string", @@ -5269,6 +5428,7 @@ }, "UnmanagedAccessCode": { "docs": undefined, + "inline": undefined, "properties": { "access_code_id": { "docs": "Unique identifier for the access code.", @@ -5335,6 +5495,7 @@ }, "UnmanagedDevice": { "docs": undefined, + "inline": undefined, "properties": { "can_program_offline_access_codes": "optional", "can_program_online_access_codes": "optional", @@ -5456,6 +5617,7 @@ }, "UnmanagedDeviceErrorsItem": { "docs": undefined, + "inline": true, "properties": { "error_code": "string", "message": "string", @@ -5466,6 +5628,7 @@ }, "UnmanagedDeviceProperties": { "docs": undefined, + "inline": true, "properties": { "accessory_keypad": { "docs": "Represents the accessory keypad state.", @@ -5533,6 +5696,7 @@ }, "UnmanagedDevicePropertiesAccessoryKeypad": { "docs": "Represents the accessory keypad state.", + "inline": true, "properties": { "battery": { "docs": "Indicates if the keypad battery properties.", @@ -5549,6 +5713,7 @@ }, "UnmanagedDevicePropertiesAccessoryKeypadBattery": { "docs": "Indicates if the keypad battery properties.", + "inline": true, "properties": { "level": { "type": "double", @@ -5567,6 +5732,7 @@ }, "UnmanagedDevicePropertiesBattery": { "docs": "Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage.", + "inline": true, "properties": { "level": { "type": "double", @@ -5597,6 +5763,7 @@ }, "UnmanagedDevicePropertiesModel": { "docs": undefined, + "inline": true, "properties": { "accessory_keypad_supported": { "docs": " @@ -5637,6 +5804,7 @@ }, "UnmanagedDeviceWarningsItem": { "docs": undefined, + "inline": true, "properties": { "message": "string", "warning_code": "string", @@ -5647,6 +5815,7 @@ }, "UserIdentity": { "docs": undefined, + "inline": undefined, "properties": { "created_at": "datetime", "display_name": { @@ -5711,6 +5880,7 @@ }, "Webhook": { "docs": undefined, + "inline": undefined, "properties": { "event_types": "optional>", "secret": "optional", @@ -5723,6 +5893,7 @@ }, "Workspace": { "docs": undefined, + "inline": undefined, "properties": { "company_name": "string", "connect_partner_name": { @@ -6957,10 +7128,12 @@ types: action_type: literal<"LOCK_DOOR"> source: openapi: ../openapi.json + inline: true ActionAttemptOneResult: properties: {} source: openapi: ../openapi.json + inline: true ActionAttemptOne: docs: Locking door succeeded. properties: @@ -6981,12 +7154,14 @@ types: result: ActionAttemptOneResult source: openapi: ../openapi.json + inline: true ActionAttemptTwoError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptTwo: docs: Locking door failed. properties: @@ -7007,6 +7182,7 @@ types: error: ActionAttemptTwoError source: openapi: ../openapi.json + inline: true ActionAttemptThree: docs: Unlocking door. properties: @@ -7027,10 +7203,12 @@ types: action_type: literal<"UNLOCK_DOOR"> source: openapi: ../openapi.json + inline: true ActionAttemptFourResult: properties: {} source: openapi: ../openapi.json + inline: true ActionAttemptFour: docs: Unlocking door succeeded. properties: @@ -7051,12 +7229,14 @@ types: result: ActionAttemptFourResult source: openapi: ../openapi.json + inline: true ActionAttemptFiveError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptFive: docs: Unlocking door failed. properties: @@ -7077,6 +7257,7 @@ types: error: ActionAttemptFiveError source: openapi: ../openapi.json + inline: true ActionAttemptSix: docs: Resetting sandbox workspace. properties: @@ -7097,10 +7278,12 @@ types: action_type: literal<"RESET_SANDBOX_WORKSPACE"> source: openapi: ../openapi.json + inline: true ActionAttemptSevenResult: properties: {} source: openapi: ../openapi.json + inline: true ActionAttemptSeven: docs: Resetting sandbox workspace succeeded. properties: @@ -7121,12 +7304,14 @@ types: result: ActionAttemptSevenResult source: openapi: ../openapi.json + inline: true ActionAttemptEightError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptEight: docs: Resetting sandbox workspace failed. properties: @@ -7147,6 +7332,7 @@ types: error: ActionAttemptEightError source: openapi: ../openapi.json + inline: true ActionAttemptNine: docs: Setting HVAC to cool. properties: @@ -7167,10 +7353,12 @@ types: action_type: literal<"SET_COOL"> source: openapi: ../openapi.json + inline: true ActionAttemptTenResult: properties: {} source: openapi: ../openapi.json + inline: true ActionAttemptTen: docs: Setting HVAC to cool succeeded. properties: @@ -7191,12 +7379,14 @@ types: result: ActionAttemptTenResult source: openapi: ../openapi.json + inline: true ActionAttemptElevenError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptEleven: docs: Setting HVAC to cool failed. properties: @@ -7217,6 +7407,7 @@ types: error: ActionAttemptElevenError source: openapi: ../openapi.json + inline: true ActionAttemptTwelve: docs: Setting HVAC to heat mode. properties: @@ -7237,10 +7428,12 @@ types: action_type: literal<"SET_HEAT"> source: openapi: ../openapi.json + inline: true ActionAttemptThirteenResult: properties: {} source: openapi: ../openapi.json + inline: true ActionAttemptThirteen: docs: Setting HVAC to heat mode succeeded. properties: @@ -7261,12 +7454,14 @@ types: result: ActionAttemptThirteenResult source: openapi: ../openapi.json + inline: true ActionAttemptFourteenError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptFourteen: docs: Setting HVAC to heat mode failed. properties: @@ -7287,6 +7482,7 @@ types: error: ActionAttemptFourteenError source: openapi: ../openapi.json + inline: true ActionAttemptFifteen: docs: Setting HVAC to heat-cool mode. properties: @@ -7307,10 +7503,12 @@ types: action_type: literal<"SET_HEAT_COOL"> source: openapi: ../openapi.json + inline: true ActionAttemptSixteenResult: properties: {} source: openapi: ../openapi.json + inline: true ActionAttemptSixteen: docs: Setting HVAC to heat-cool mode succeeded. properties: @@ -7331,12 +7529,14 @@ types: result: ActionAttemptSixteenResult source: openapi: ../openapi.json + inline: true ActionAttemptSeventeenError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptSeventeen: docs: Setting heat-cool mode failed. properties: @@ -7357,6 +7557,7 @@ types: error: ActionAttemptSeventeenError source: openapi: ../openapi.json + inline: true ActionAttemptEighteen: docs: Setting fan mode. properties: @@ -7377,10 +7578,12 @@ types: action_type: literal<"SET_FAN_MODE"> source: openapi: ../openapi.json + inline: true ActionAttemptNineteenResult: properties: {} source: openapi: ../openapi.json + inline: true ActionAttemptNineteen: docs: Setting fan mode succeeded. properties: @@ -7401,12 +7604,14 @@ types: result: ActionAttemptNineteenResult source: openapi: ../openapi.json + inline: true ActionAttemptTwentyError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptTwenty: docs: Setting fan mode failed. properties: @@ -7427,6 +7632,7 @@ types: error: ActionAttemptTwentyError source: openapi: ../openapi.json + inline: true ActionAttemptTwentyOne: docs: Turning HVAC off. properties: @@ -7447,10 +7653,12 @@ types: action_type: literal<"SET_THERMOSTAT_OFF"> source: openapi: ../openapi.json + inline: true ActionAttemptTwentyTwoResult: properties: {} source: openapi: ../openapi.json + inline: true ActionAttemptTwentyTwo: docs: Turning HVAC off succeeded. properties: @@ -7471,12 +7679,14 @@ types: result: ActionAttemptTwentyTwoResult source: openapi: ../openapi.json + inline: true ActionAttemptTwentyThreeError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptTwentyThree: docs: Turning HVAC off failed. properties: @@ -7497,6 +7707,7 @@ types: error: ActionAttemptTwentyThreeError source: openapi: ../openapi.json + inline: true ActionAttemptTwentyFour: properties: action_attempt_id: @@ -7516,6 +7727,7 @@ types: action_type: literal<"SYNC_ACCESS_CODES"> source: openapi: ../openapi.json + inline: true ActionAttemptTwentyFive: properties: action_attempt_id: @@ -7535,12 +7747,14 @@ types: result: optional source: openapi: ../openapi.json + inline: true ActionAttemptTwentySixError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptTwentySix: properties: action_attempt_id: @@ -7560,6 +7774,7 @@ types: error: ActionAttemptTwentySixError source: openapi: ../openapi.json + inline: true ActionAttemptTwentySeven: properties: action_attempt_id: @@ -7579,6 +7794,7 @@ types: action_type: literal<"CREATE_ACCESS_CODE"> source: openapi: ../openapi.json + inline: true ActionAttemptTwentyEight: properties: action_attempt_id: @@ -7598,12 +7814,14 @@ types: result: optional source: openapi: ../openapi.json + inline: true ActionAttemptTwentyNineError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptTwentyNine: properties: action_attempt_id: @@ -7623,6 +7841,7 @@ types: error: ActionAttemptTwentyNineError source: openapi: ../openapi.json + inline: true ActionAttemptThirty: properties: action_attempt_id: @@ -7642,6 +7861,7 @@ types: action_type: literal<"DELETE_ACCESS_CODE"> source: openapi: ../openapi.json + inline: true ActionAttemptThirtyOne: properties: action_attempt_id: @@ -7661,12 +7881,14 @@ types: result: optional source: openapi: ../openapi.json + inline: true ActionAttemptThirtyTwoError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptThirtyTwo: properties: action_attempt_id: @@ -7686,6 +7908,7 @@ types: error: ActionAttemptThirtyTwoError source: openapi: ../openapi.json + inline: true ActionAttemptThirtyThree: properties: action_attempt_id: @@ -7705,6 +7928,7 @@ types: action_type: literal<"UPDATE_ACCESS_CODE"> source: openapi: ../openapi.json + inline: true ActionAttemptThirtyFour: properties: action_attempt_id: @@ -7724,12 +7948,14 @@ types: result: optional source: openapi: ../openapi.json + inline: true ActionAttemptThirtyFiveError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptThirtyFive: properties: action_attempt_id: @@ -7749,6 +7975,7 @@ types: error: ActionAttemptThirtyFiveError source: openapi: ../openapi.json + inline: true ActionAttemptThirtySix: properties: action_attempt_id: @@ -7768,6 +7995,7 @@ types: action_type: literal<"CREATE_NOISE_THRESHOLD"> source: openapi: ../openapi.json + inline: true ActionAttemptThirtySeven: properties: action_attempt_id: @@ -7787,12 +8015,14 @@ types: result: optional source: openapi: ../openapi.json + inline: true ActionAttemptThirtyEightError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptThirtyEight: properties: action_attempt_id: @@ -7812,6 +8042,7 @@ types: error: ActionAttemptThirtyEightError source: openapi: ../openapi.json + inline: true ActionAttemptThirtyNine: properties: action_attempt_id: @@ -7831,6 +8062,7 @@ types: action_type: literal<"DELETE_NOISE_THRESHOLD"> source: openapi: ../openapi.json + inline: true ActionAttemptForty: properties: action_attempt_id: @@ -7850,12 +8082,14 @@ types: result: optional source: openapi: ../openapi.json + inline: true ActionAttemptFortyOneError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptFortyOne: properties: action_attempt_id: @@ -7875,6 +8109,7 @@ types: error: ActionAttemptFortyOneError source: openapi: ../openapi.json + inline: true ActionAttemptFortyTwo: properties: action_attempt_id: @@ -7894,6 +8129,7 @@ types: action_type: literal<"UPDATE_NOISE_THRESHOLD"> source: openapi: ../openapi.json + inline: true ActionAttemptFortyThree: properties: action_attempt_id: @@ -7913,12 +8149,14 @@ types: result: optional source: openapi: ../openapi.json + inline: true ActionAttemptActionAttemptIdError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptActionAttemptId: properties: action_attempt_id: @@ -7938,6 +8176,7 @@ types: error: ActionAttemptActionAttemptIdError source: openapi: ../openapi.json + inline: true ActionAttempt: discriminated: false union: @@ -8086,6 +8325,7 @@ types: - boolean source: openapi: ../openapi.json + inline: true ConnectWebview: properties: connect_webview_id: @@ -8150,6 +8390,7 @@ types: exclusive: optional source: openapi: ../openapi.json + inline: true ConnectedAccountCustomMetadataValue: discriminated: false union: @@ -8157,6 +8398,7 @@ types: - boolean source: openapi: ../openapi.json + inline: true ConnectedAccount: properties: connected_account_id: @@ -8231,6 +8473,7 @@ types: max: 1 source: openapi: ../openapi.json + inline: true DevicePropertiesAccessoryKeypad: docs: Represents the accessory keypad state. properties: @@ -8242,6 +8485,7 @@ types: docs: Indicates if the keypad battery properties. source: openapi: ../openapi.json + inline: true DevicePropertiesAppearance: properties: name: @@ -8251,6 +8495,7 @@ types: settable through Seam. source: openapi: ../openapi.json + inline: true DevicePropertiesModel: properties: can_connect_accessory_keypad: @@ -8283,6 +8528,7 @@ types: source: openapi: ../openapi.json + inline: true DevicePropertiesBatteryStatus: enum: - critical @@ -8309,18 +8555,21 @@ types: status: DevicePropertiesBatteryStatus source: openapi: ../openapi.json + inline: true DevicePropertiesAssaAbloyCredentialServiceMetadataEndpointsItem: properties: endpoint_id: string is_active: boolean source: openapi: ../openapi.json + inline: true DevicePropertiesAssaAbloyCredentialServiceMetadata: properties: has_active_endpoint: boolean endpoints: list source: openapi: ../openapi.json + inline: true DevicePropertiesAugustMetadata: properties: lock_id: string @@ -8332,6 +8581,7 @@ types: house_id: optional source: openapi: ../openapi.json + inline: true DevicePropertiesAvigilonAltaMetadata: properties: entry_name: string @@ -8343,6 +8593,7 @@ types: entry_relays_total_count: double source: openapi: ../openapi.json + inline: true DevicePropertiesSchlageMetadata: properties: device_id: string @@ -8351,6 +8602,7 @@ types: model: optional source: openapi: ../openapi.json + inline: true DevicePropertiesSmartthingsMetadata: properties: device_id: string @@ -8359,6 +8611,7 @@ types: location_id: optional source: openapi: ../openapi.json + inline: true DevicePropertiesLocklyMetadata: properties: device_id: string @@ -8366,6 +8619,7 @@ types: model: optional source: openapi: ../openapi.json + inline: true DevicePropertiesNukiMetadata: properties: device_id: string @@ -8375,6 +8629,7 @@ types: keypad_2_paired: optional source: openapi: ../openapi.json + inline: true DevicePropertiesKwiksetMetadata: properties: device_id: string @@ -8382,6 +8637,7 @@ types: model_number: string source: openapi: ../openapi.json + inline: true DevicePropertiesSaltoMetadata: properties: lock_id: string @@ -8392,17 +8648,20 @@ types: model: optional source: openapi: ../openapi.json + inline: true DevicePropertiesGenieMetadata: properties: device_name: string door_name: string source: openapi: ../openapi.json + inline: true DevicePropertiesBrivoMetadata: properties: device_name: string source: openapi: ../openapi.json + inline: true DevicePropertiesIglooMetadata: properties: device_id: string @@ -8410,6 +8669,7 @@ types: model: optional source: openapi: ../openapi.json + inline: true DevicePropertiesNoiseawareMetadataDeviceModel: enum: - indoor @@ -8425,36 +8685,42 @@ types: device_id: string source: openapi: ../openapi.json + inline: true DevicePropertiesMinutMetadataLatestSensorValuesTemperature: properties: time: string value: double source: openapi: ../openapi.json + inline: true DevicePropertiesMinutMetadataLatestSensorValuesSound: properties: time: string value: double source: openapi: ../openapi.json + inline: true DevicePropertiesMinutMetadataLatestSensorValuesHumidity: properties: time: string value: double source: openapi: ../openapi.json + inline: true DevicePropertiesMinutMetadataLatestSensorValuesPressure: properties: time: string value: double source: openapi: ../openapi.json + inline: true DevicePropertiesMinutMetadataLatestSensorValuesAccelerometerZ: properties: time: string value: double source: openapi: ../openapi.json + inline: true DevicePropertiesMinutMetadataLatestSensorValues: properties: temperature: DevicePropertiesMinutMetadataLatestSensorValuesTemperature @@ -8464,6 +8730,7 @@ types: accelerometer_z: DevicePropertiesMinutMetadataLatestSensorValuesAccelerometerZ source: openapi: ../openapi.json + inline: true DevicePropertiesMinutMetadata: properties: device_id: string @@ -8471,6 +8738,7 @@ types: latest_sensor_values: DevicePropertiesMinutMetadataLatestSensorValues source: openapi: ../openapi.json + inline: true DevicePropertiesFourSuitesMetadata: properties: device_id: double @@ -8478,12 +8746,14 @@ types: reclose_delay_in_seconds: double source: openapi: ../openapi.json + inline: true DevicePropertiesTwoNMetadata: properties: device_id: double device_name: string source: openapi: ../openapi.json + inline: true DevicePropertiesControlbywebMetadata: properties: device_id: string @@ -8491,6 +8761,7 @@ types: relay_name: optional source: openapi: ../openapi.json + inline: true DevicePropertiesTtlockMetadata: properties: lock_id: double @@ -8498,6 +8769,7 @@ types: feature_value: string source: openapi: ../openapi.json + inline: true DevicePropertiesSeamBridgeMetadataUnlockMethod: enum: - bridge @@ -8511,6 +8783,7 @@ types: name: string source: openapi: ../openapi.json + inline: true DevicePropertiesIgloohomeMetadata: properties: device_id: string @@ -8520,6 +8793,7 @@ types: keypad_id: optional source: openapi: ../openapi.json + inline: true DevicePropertiesNestMetadata: properties: nest_device_id: string @@ -8527,18 +8801,21 @@ types: custom_name: string source: openapi: ../openapi.json + inline: true DevicePropertiesEcobeeMetadata: properties: ecobee_device_id: string device_name: string source: openapi: ../openapi.json + inline: true DevicePropertiesHoneywellResideoMetadata: properties: honeywell_resideo_device_id: string device_name: string source: openapi: ../openapi.json + inline: true DevicePropertiesHubitatMetadata: properties: device_id: string @@ -8546,6 +8823,7 @@ types: device_label: string source: openapi: ../openapi.json + inline: true DevicePropertiesDormakabaOracodeMetadataPredefinedTimeSlotsItem: properties: name: string @@ -8563,6 +8841,7 @@ types: format: uuid source: openapi: ../openapi.json + inline: true DevicePropertiesDormakabaOracodeMetadata: properties: door_id: double @@ -8576,6 +8855,7 @@ types: optional> source: openapi: ../openapi.json + inline: true DevicePropertiesWyzeMetadata: properties: device_id: string @@ -8588,6 +8868,7 @@ types: locker_status_hardlock: optional source: openapi: ../openapi.json + inline: true DevicePropertiesTedeeMetadata: properties: device_id: double @@ -8599,6 +8880,7 @@ types: keypad_id: optional source: openapi: ../openapi.json + inline: true DevicePropertiesCodeConstraintsItemZeroConstraintType: enum: - no_zeros @@ -8617,6 +8899,7 @@ types: constraint_type: DevicePropertiesCodeConstraintsItemZeroConstraintType source: openapi: ../openapi.json + inline: true DevicePropertiesCodeConstraintsItemMaxLengthConstraintType: enum: - name_length @@ -8630,6 +8913,7 @@ types: max_length: optional source: openapi: ../openapi.json + inline: true DevicePropertiesCodeConstraintsItem: discriminated: false union: @@ -8637,11 +8921,13 @@ types: - DevicePropertiesCodeConstraintsItemMaxLength source: openapi: ../openapi.json + inline: true DevicePropertiesKeypadBattery: properties: level: double source: openapi: ../openapi.json + inline: true DeviceProperties: docs: Properties of the device. properties: @@ -8770,6 +9056,7 @@ types: door_open: optional source: openapi: ../openapi.json + inline: true DeviceLocation: docs: Location information for the device. properties: @@ -8781,18 +9068,21 @@ types: docs: Time zone of the device location. source: openapi: ../openapi.json + inline: true DeviceErrorsItem: properties: error_code: string message: string source: openapi: ../openapi.json + inline: true DeviceWarningsItem: properties: warning_code: string message: string source: openapi: ../openapi.json + inline: true DeviceCustomMetadataValue: discriminated: false union: @@ -8800,6 +9090,7 @@ types: - boolean source: openapi: ../openapi.json + inline: true Device: properties: device_id: @@ -8937,12 +9228,14 @@ types: message: string source: openapi: ../openapi.json + inline: true UnmanagedDeviceWarningsItem: properties: warning_code: string message: string source: openapi: ../openapi.json + inline: true UnmanagedDevicePropertiesAccessoryKeypadBattery: docs: Indicates if the keypad battery properties. properties: @@ -8953,6 +9246,7 @@ types: max: 1 source: openapi: ../openapi.json + inline: true UnmanagedDevicePropertiesAccessoryKeypad: docs: Represents the accessory keypad state. properties: @@ -8964,6 +9258,7 @@ types: docs: Indicates if the keypad battery properties. source: openapi: ../openapi.json + inline: true UnmanagedDevicePropertiesBatteryStatus: enum: - critical @@ -8990,6 +9285,7 @@ types: status: UnmanagedDevicePropertiesBatteryStatus source: openapi: ../openapi.json + inline: true UnmanagedDevicePropertiesModel: properties: can_connect_accessory_keypad: @@ -9022,6 +9318,7 @@ types: source: openapi: ../openapi.json + inline: true UnmanagedDeviceProperties: properties: accessory_keypad: @@ -9082,6 +9379,7 @@ types: model: UnmanagedDevicePropertiesModel source: openapi: ../openapi.json + inline: true UnmanagedDevice: properties: device_id: @@ -9342,12 +9640,14 @@ types: message: string source: openapi: ../openapi.json + inline: true AcsSystemErrorsItemVisionlineInstanceUnreachable: properties: created_at: datetime message: string source: openapi: ../openapi.json + inline: true AcsSystemErrorsItem: discriminant: error_code base-properties: {} @@ -9360,6 +9660,7 @@ types: properties: {} source: openapi: ../openapi.json + inline: true AcsSystem: properties: acs_system_id: @@ -9475,6 +9776,7 @@ types: ends_at: datetime source: openapi: ../openapi.json + inline: true AcsUser: properties: acs_user_id: @@ -9527,6 +9829,7 @@ types: message: string source: openapi: ../openapi.json + inline: true AcsEntranceLatchMetadata: properties: accessibility_type: string @@ -9535,6 +9838,7 @@ types: is_connected: boolean source: openapi: ../openapi.json + inline: true AcsEntranceVisionlineMetadataDoorCategory: enum: - entrance @@ -9559,6 +9863,7 @@ types: visionline_door_profile_type: AcsEntranceVisionlineMetadataProfilesItemVisionlineDoorProfileType source: openapi: ../openapi.json + inline: true AcsEntranceVisionlineMetadata: properties: door_name: string @@ -9566,6 +9871,7 @@ types: profiles: optional> source: openapi: ../openapi.json + inline: true AcsEntrance: properties: acs_system_id: @@ -9648,12 +9954,14 @@ types: message: string source: openapi: ../openapi.json + inline: true AcsCredentialWarningsItem: properties: warning_code: string message: string source: openapi: ../openapi.json + inline: true AcsCredentialVisionlineMetadataCardFunctionType: enum: - guest @@ -9668,6 +9976,7 @@ types: common_acs_entrance_ids: optional> source: openapi: ../openapi.json + inline: true AcsCredential: properties: acs_credential_id: @@ -9756,17 +10065,20 @@ types: is_active: boolean source: openapi: ../openapi.json + inline: true PhonePropertiesAssaAbloyCredentialServiceMetadata: properties: has_active_endpoint: boolean endpoints: list source: openapi: ../openapi.json + inline: true PhoneProperties: properties: assa_abloy_credential_service_metadata: optional source: openapi: ../openapi.json + inline: true PhoneLocation: docs: Location information for the device. properties: @@ -9778,18 +10090,21 @@ types: docs: Time zone of the device location. source: openapi: ../openapi.json + inline: true PhoneErrorsItem: properties: error_code: string message: string source: openapi: ../openapi.json + inline: true PhoneWarningsItem: properties: warning_code: string message: string source: openapi: ../openapi.json + inline: true PhoneCustomMetadataValue: discriminated: false union: @@ -9797,6 +10112,7 @@ types: - boolean source: openapi: ../openapi.json + inline: true Phone: properties: device_id: @@ -10691,6 +11007,7 @@ types: }, "AccessCodesCreateMultipleResponse": { "docs": undefined, + "inline": undefined, "properties": { "access_codes": "list", "ok": "boolean", @@ -10725,6 +11042,7 @@ types: }, "AccessCodesCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "access_code": "root.AccessCode", "action_attempt": "root.ActionAttempt", @@ -10736,6 +11054,7 @@ types: }, "AccessCodesDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -10746,6 +11065,7 @@ types: }, "AccessCodesGenerateCodeResponse": { "docs": undefined, + "inline": undefined, "properties": { "generated_code": "root.AccessCode", "ok": "boolean", @@ -10756,6 +11076,7 @@ types: }, "AccessCodesGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "access_code": "root.AccessCode", "ok": "boolean", @@ -10766,6 +11087,7 @@ types: }, "AccessCodesListResponse": { "docs": undefined, + "inline": undefined, "properties": { "access_codes": "list", "ok": "boolean", @@ -10776,6 +11098,7 @@ types: }, "AccessCodesPullBackupAccessCodeResponse": { "docs": undefined, + "inline": undefined, "properties": { "backup_access_code": "root.AccessCode", "ok": "boolean", @@ -10819,6 +11142,7 @@ types: }, "AccessCodesUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -11527,6 +11851,7 @@ service: "types": { "SimulateCreateUnmanagedAccessCodeResponse": { "docs": undefined, + "inline": undefined, "properties": { "access_code": "root.UnmanagedAccessCode", "ok": "boolean", @@ -11952,6 +12277,7 @@ service: "types": { "UnmanagedConvertToManagedResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -11961,6 +12287,7 @@ service: }, "UnmanagedDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -11971,6 +12298,7 @@ service: }, "UnmanagedGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "access_code": "root.UnmanagedAccessCode", "ok": "boolean", @@ -11981,6 +12309,7 @@ service: }, "UnmanagedListResponse": { "docs": undefined, + "inline": undefined, "properties": { "access_codes": "list", "ok": "boolean", @@ -11991,6 +12320,7 @@ service: }, "UnmanagedUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -12590,6 +12920,7 @@ service: "types": { "AccessGroupsAddUserResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -12599,6 +12930,7 @@ service: }, "AccessGroupsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_access_group": "root.AcsAccessGroup", "ok": "boolean", @@ -12609,6 +12941,7 @@ service: }, "AccessGroupsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_access_groups": "list", "ok": "boolean", @@ -12619,6 +12952,7 @@ service: }, "AccessGroupsListUsersResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_users": "list", "ok": "boolean", @@ -12629,6 +12963,7 @@ service: }, "AccessGroupsRemoveUserResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -12957,6 +13292,7 @@ service: "types": { "CredentialPoolsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_credential_pools": "list", "ok": "boolean", @@ -13127,6 +13463,7 @@ service: "types": { "CredentialProvisioningAutomationsLaunchResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_credential_provisioning_automation": "root.AcsCredentialProvisioningAutomation", "ok": "boolean", @@ -13948,6 +14285,7 @@ service: "types": { "CredentialsAssignResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_credential": "root.AcsCredential", "ok": "boolean", @@ -13968,6 +14306,7 @@ service: }, "CredentialsCreateRequestVisionlineMetadata": { "docs": undefined, + "inline": true, "properties": { "assa_abloy_credential_service_mobile_endpoint_id": { "type": "optional", @@ -14019,6 +14358,7 @@ service: }, "CredentialsCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_credential": "root.AcsCredential", "ok": "boolean", @@ -14029,6 +14369,7 @@ service: }, "CredentialsDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -14038,6 +14379,7 @@ service: }, "CredentialsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_credential": "root.AcsCredential", "ok": "boolean", @@ -14048,6 +14390,7 @@ service: }, "CredentialsListAccessibleEntrancesResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_entrances": "list", "ok": "boolean", @@ -14058,6 +14401,7 @@ service: }, "CredentialsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_credentials": "list", "ok": "boolean", @@ -14068,6 +14412,7 @@ service: }, "CredentialsUnassignResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_credential": "root.AcsCredential", "ok": "boolean", @@ -14078,6 +14423,7 @@ service: }, "CredentialsUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_credential": "root.AcsCredential", "ok": "boolean", @@ -14139,6 +14485,7 @@ types: joiner_acs_credential_ids: optional> source: openapi: ../openapi.json + inline: true CredentialsCreateResponse: properties: acs_credential: root.AcsCredential @@ -14974,6 +15321,7 @@ service: "types": { "EntrancesGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_entrance": "root.AcsEntrance", "ok": "boolean", @@ -14984,6 +15332,7 @@ service: }, "EntrancesGrantAccessResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -14993,6 +15342,7 @@ service: }, "EntrancesListCredentialsWithAccessResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_credentials": "list", "ok": "boolean", @@ -15003,6 +15353,7 @@ service: }, "EntrancesListResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_entrances": "list", "ok": "boolean", @@ -15495,6 +15846,7 @@ service: "types": { "SystemsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_system": "root.AcsSystem", "ok": "boolean", @@ -15505,6 +15857,7 @@ service: }, "SystemsListCompatibleCredentialManagerAcsSystemsResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_systems": "list", "ok": "boolean", @@ -15515,6 +15868,7 @@ service: }, "SystemsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_systems": "list", "ok": "boolean", @@ -16489,6 +16843,7 @@ service: "types": { "UsersAddToAccessGroupResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -16498,6 +16853,7 @@ service: }, "UsersCreateRequestAccessSchedule": { "docs": undefined, + "inline": true, "properties": { "ends_at": "datetime", "starts_at": "datetime", @@ -16508,6 +16864,7 @@ service: }, "UsersCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_user": "root.AcsUser", "ok": "boolean", @@ -16518,6 +16875,7 @@ service: }, "UsersDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -16527,6 +16885,7 @@ service: }, "UsersGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_user": "root.AcsUser", "ok": "boolean", @@ -16537,6 +16896,7 @@ service: }, "UsersListAccessibleEntrancesResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_entrances": "list", "ok": "boolean", @@ -16547,6 +16907,7 @@ service: }, "UsersListResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_users": "list", "ok": "boolean", @@ -16557,6 +16918,7 @@ service: }, "UsersRemoveFromAccessGroupResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -16566,6 +16928,7 @@ service: }, "UsersRevokeAccessToAllEntrancesResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -16575,6 +16938,7 @@ service: }, "UsersSuspendResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -16584,6 +16948,7 @@ service: }, "UsersUnsuspendResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -16593,6 +16958,7 @@ service: }, "UsersUpdateRequestAccessSchedule": { "docs": undefined, + "inline": true, "properties": { "ends_at": "datetime", "starts_at": "datetime", @@ -16603,6 +16969,7 @@ service: }, "UsersUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -16624,6 +16991,7 @@ service: ends_at: datetime source: openapi: ../openapi.json + inline: true UsersCreateResponse: properties: acs_user: root.AcsUser @@ -16679,6 +17047,7 @@ service: ends_at: datetime source: openapi: ../openapi.json + inline: true UsersUpdateResponse: properties: ok: boolean @@ -17275,6 +17644,7 @@ service: "types": { "ActionAttemptsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -17285,6 +17655,7 @@ service: }, "ActionAttemptsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempts": "list", "ok": "boolean", @@ -17835,6 +18206,7 @@ service: "types": { "ClientSessionsCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "client_session": "root.ClientSession", "ok": "boolean", @@ -17845,6 +18217,7 @@ service: }, "ClientSessionsDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -17854,6 +18227,7 @@ service: }, "ClientSessionsGetOrCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "client_session": "root.ClientSession", "ok": "boolean", @@ -17864,6 +18238,7 @@ service: }, "ClientSessionsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "client_session": "root.ClientSession", "ok": "boolean", @@ -17874,6 +18249,7 @@ service: }, "ClientSessionsGrantAccessResponse": { "docs": undefined, + "inline": undefined, "properties": { "client_session": "root.ClientSession", "ok": "boolean", @@ -17884,6 +18260,7 @@ service: }, "ClientSessionsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "client_sessions": "list", "ok": "boolean", @@ -17894,6 +18271,7 @@ service: }, "ClientSessionsRevokeResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -18580,6 +18958,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -18622,6 +19001,7 @@ service: }, "ConnectWebviewsCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "connect_webview": "root.ConnectWebview", "ok": "boolean", @@ -18632,6 +19012,7 @@ service: }, "ConnectWebviewsDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -18641,6 +19022,7 @@ service: }, "ConnectWebviewsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "connect_webview": "root.ConnectWebview", "ok": "boolean", @@ -18653,6 +19035,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -18663,6 +19046,7 @@ service: }, "ConnectWebviewsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "connect_webviews": "list", "ok": "boolean", @@ -18745,6 +19129,7 @@ service: - optional source: openapi: ../openapi.json + inline: true ConnectWebviewsCreateResponse: properties: connect_webview: root.ConnectWebview @@ -18769,6 +19154,7 @@ service: - boolean source: openapi: ../openapi.json + inline: true ConnectWebviewsListResponse: properties: connect_webviews: list @@ -19256,6 +19642,7 @@ service: "types": { "ConnectedAccountsDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -19267,6 +19654,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -19277,6 +19665,7 @@ service: }, "ConnectedAccountsGetRequestConnectedAccountId": { "docs": undefined, + "inline": true, "properties": { "connected_account_id": { "type": "string", @@ -19294,6 +19683,7 @@ service: }, "ConnectedAccountsGetRequestEmail": { "docs": undefined, + "inline": true, "properties": { "email": { "type": "string", @@ -19311,6 +19701,7 @@ service: }, "ConnectedAccountsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "connected_account": "root.ConnectedAccount", "ok": "boolean", @@ -19323,6 +19714,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -19333,6 +19725,7 @@ service: }, "ConnectedAccountsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "connected_accounts": "list", "ok": "boolean", @@ -19345,6 +19738,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -19364,6 +19758,7 @@ service: }, "ConnectedAccountsUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "connected_account": "root.ConnectedAccount", "ok": "boolean", @@ -19388,6 +19783,7 @@ service: format: uuid source: openapi: ../openapi.json + inline: true ConnectedAccountsGetRequestEmail: properties: email: @@ -19396,6 +19792,7 @@ service: format: email source: openapi: ../openapi.json + inline: true ConnectedAccountsGetRequest: discriminated: false union: @@ -19416,6 +19813,7 @@ service: - boolean source: openapi: ../openapi.json + inline: true ConnectedAccountsListResponse: properties: connected_accounts: list @@ -19432,6 +19830,7 @@ service: - optional source: openapi: ../openapi.json + inline: true ConnectedAccountsUpdateResponse: properties: connected_account: root.ConnectedAccount @@ -20219,6 +20618,7 @@ service: "types": { "DevicesDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -20228,6 +20628,7 @@ service: }, "DevicesGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "device": "root.Device", "ok": "boolean", @@ -20250,6 +20651,7 @@ service: }, "DevicesListDeviceProvidersResponse": { "docs": undefined, + "inline": undefined, "properties": { "device_providers": "list", "ok": "boolean", @@ -20262,6 +20664,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -20421,6 +20824,7 @@ service: }, "DevicesListResponse": { "docs": undefined, + "inline": undefined, "properties": { "devices": "list", "ok": "boolean", @@ -20433,6 +20837,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -20452,6 +20857,7 @@ service: }, "DevicesUpdateRequestProperties": { "docs": undefined, + "inline": true, "properties": { "name": "optional", }, @@ -20461,6 +20867,7 @@ service: }, "DevicesUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -20601,6 +21008,7 @@ service: - boolean source: openapi: ../openapi.json + inline: true DevicesListRequestIncludeIfItem: enum: - can_remotely_unlock @@ -20649,6 +21057,7 @@ service: name: optional source: openapi: ../openapi.json + inline: true DevicesUpdateRequestCustomMetadataValue: discriminated: false union: @@ -20659,6 +21068,7 @@ service: - optional source: openapi: ../openapi.json + inline: true DevicesUpdateResponse: properties: ok: boolean @@ -21244,6 +21654,7 @@ service: "types": { "SimulateConnectResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -21253,6 +21664,7 @@ service: }, "SimulateDisconnectResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -21262,6 +21674,7 @@ service: }, "SimulateRemoveResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -21668,6 +22081,7 @@ service: "types": { "UnmanagedGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "device": "root.UnmanagedDevice", "ok": "boolean", @@ -21680,6 +22094,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -21839,6 +22254,7 @@ service: }, "UnmanagedListResponse": { "docs": undefined, + "inline": undefined, "properties": { "devices": "list", "ok": "boolean", @@ -21849,6 +22265,7 @@ service: }, "UnmanagedUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -21986,6 +22403,7 @@ types: - boolean source: openapi: ../openapi.json + inline: true UnmanagedListRequestIncludeIfItem: enum: - can_remotely_unlock @@ -22386,6 +22804,7 @@ service: "types": { "EventsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "event": "optional", "message": "optional", @@ -22399,6 +22818,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -22887,6 +23307,7 @@ service: }, "EventsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "events": "list", "ok": "boolean", @@ -22914,6 +23335,7 @@ types: - datetime source: openapi: ../openapi.json + inline: true EventsListRequestEventType: enum: - value: device.accessory_keypad_connected @@ -24144,6 +24566,7 @@ service: "types": { "LocksGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "device": "root.Device", "lock": "root.Device", @@ -24157,6 +24580,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -24316,6 +24740,7 @@ service: }, "LocksListResponse": { "docs": undefined, + "inline": undefined, "properties": { "devices": "list", "locks": "list", @@ -24327,6 +24752,7 @@ service: }, "LocksLockDoorResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -24337,6 +24763,7 @@ service: }, "LocksUnlockDoorResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -24476,6 +24903,7 @@ types: - boolean source: openapi: ../openapi.json + inline: true LocksListRequestIncludeIfItem: enum: - can_remotely_unlock @@ -25258,6 +25686,7 @@ service: "types": { "NetworksGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "network": "root.Network", "ok": "boolean", @@ -25268,6 +25697,7 @@ service: }, "NetworksListResponse": { "docs": undefined, + "inline": undefined, "properties": { "networks": "list", "ok": "boolean", @@ -25735,6 +26165,7 @@ service: "types": { "NoiseThresholdsCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "noise_threshold": "root.NoiseThreshold", @@ -25746,6 +26177,7 @@ service: }, "NoiseThresholdsDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -25756,6 +26188,7 @@ service: }, "NoiseThresholdsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "noise_threshold": "root.NoiseThreshold", "ok": "boolean", @@ -25766,6 +26199,7 @@ service: }, "NoiseThresholdsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "noise_thresholds": "list", "ok": "boolean", @@ -25776,6 +26210,7 @@ service: }, "NoiseThresholdsUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -26114,6 +26549,7 @@ service: "types": { "SimulateTriggerNoiseThresholdResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -26315,6 +26751,7 @@ service: "types": { "PhonesDeactivateResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -26324,6 +26761,7 @@ service: }, "PhonesListResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "phones": "list", @@ -26557,6 +26995,7 @@ service: "types": { "SimulateCreateSandboxPhoneRequestAssaAbloyMetadata": { "docs": undefined, + "inline": true, "properties": { "application_version": { "default": "1.0.0", @@ -26589,6 +27028,7 @@ service: }, "SimulateCreateSandboxPhoneRequestPhoneMetadata": { "docs": undefined, + "inline": true, "properties": { "device_manufacturer": { "default": "Samsung", @@ -26623,6 +27063,7 @@ service: }, "SimulateCreateSandboxPhoneResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "phone": "root.Phone", @@ -26658,6 +27099,7 @@ service: default: Samsung Galaxy S10 source: openapi: ../openapi.json + inline: true SimulateCreateSandboxPhoneRequestAssaAbloyMetadata: properties: ble_capability: @@ -26680,6 +27122,7 @@ service: default: 1 source: openapi: ../openapi.json + inline: true SimulateCreateSandboxPhoneResponse: properties: phone: root.Phone @@ -27584,6 +28027,7 @@ service: "types": { "ThermostatsCoolResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -27594,6 +28038,7 @@ service: }, "ThermostatsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "thermostat": "root.Device", @@ -27604,6 +28049,7 @@ service: }, "ThermostatsHeatCoolResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -27614,6 +28060,7 @@ service: }, "ThermostatsHeatResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -27626,6 +28073,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -27785,6 +28233,7 @@ service: }, "ThermostatsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "thermostats": "list", @@ -27795,6 +28244,7 @@ service: }, "ThermostatsOffResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -27823,6 +28273,7 @@ service: }, "ThermostatsSetFanModeResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -27833,6 +28284,7 @@ service: }, "ThermostatsUpdateRequestDefaultClimateSetting": { "docs": undefined, + "inline": true, "properties": { "automatic_cooling_enabled": "optional", "automatic_heating_enabled": "optional", @@ -27860,6 +28312,7 @@ service: }, "ThermostatsUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -28015,6 +28468,7 @@ types: - boolean source: openapi: ../openapi.json + inline: true ThermostatsListRequestIncludeIfItem: enum: - can_remotely_unlock @@ -28087,6 +28541,7 @@ types: manual_override_allowed: optional source: openapi: ../openapi.json + inline: true ThermostatsUpdateResponse: properties: ok: boolean @@ -29031,6 +29486,7 @@ service: }, "ClimateSettingSchedulesCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "climate_setting_schedule": "root.ClimateSettingSchedule", "ok": "boolean", @@ -29041,6 +29497,7 @@ service: }, "ClimateSettingSchedulesDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -29050,6 +29507,7 @@ service: }, "ClimateSettingSchedulesGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "climate_setting_schedule": "root.ClimateSettingSchedule", "ok": "boolean", @@ -29060,6 +29518,7 @@ service: }, "ClimateSettingSchedulesListResponse": { "docs": undefined, + "inline": undefined, "properties": { "climate_setting_schedules": "list", "ok": "boolean", @@ -29081,6 +29540,7 @@ service: }, "ClimateSettingSchedulesUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "climate_setting_schedule": "root.ClimateSettingSchedule", "ok": "boolean", @@ -30276,6 +30736,7 @@ service: "types": { "UserIdentitiesAddAcsUserResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -30285,6 +30746,7 @@ service: }, "UserIdentitiesCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "user_identity": "root.UserIdentity", @@ -30295,6 +30757,7 @@ service: }, "UserIdentitiesDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -30306,6 +30769,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -30316,6 +30780,7 @@ service: }, "UserIdentitiesGetRequestUserIdentityId": { "docs": undefined, + "inline": true, "properties": { "user_identity_id": { "type": "string", @@ -30333,6 +30798,7 @@ service: }, "UserIdentitiesGetRequestUserIdentityKey": { "docs": undefined, + "inline": true, "properties": { "user_identity_key": "string", }, @@ -30342,6 +30808,7 @@ service: }, "UserIdentitiesGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "user_identity": "root.UserIdentity", @@ -30352,6 +30819,7 @@ service: }, "UserIdentitiesGrantAccessToDeviceResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -30361,6 +30829,7 @@ service: }, "UserIdentitiesListAccessibleDevicesResponse": { "docs": undefined, + "inline": undefined, "properties": { "accessible_devices": { "docs": " @@ -30379,6 +30848,7 @@ service: }, "UserIdentitiesListAcsSystemsResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_systems": "list", "ok": "boolean", @@ -30389,6 +30859,7 @@ service: }, "UserIdentitiesListAcsUsersResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_users": "list", "ok": "boolean", @@ -30399,6 +30870,7 @@ service: }, "UserIdentitiesListResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "user_identities": "list", @@ -30409,6 +30881,7 @@ service: }, "UserIdentitiesRemoveAcsUserResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -30418,6 +30891,7 @@ service: }, "UserIdentitiesRevokeAccessToDeviceResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -30427,6 +30901,7 @@ service: }, "UserIdentitiesUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -30461,11 +30936,13 @@ service: format: uuid source: openapi: ../openapi.json + inline: true UserIdentitiesGetRequestUserIdentityKey: properties: user_identity_key: string source: openapi: ../openapi.json + inline: true UserIdentitiesGetRequest: discriminated: false union: @@ -31334,6 +31811,7 @@ service: "types": { "EnrollmentAutomationsDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -31343,6 +31821,7 @@ service: }, "EnrollmentAutomationsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "enrollment_automation": "root.EnrollmentAutomation", "ok": "boolean", @@ -31353,6 +31832,7 @@ service: }, "EnrollmentAutomationsLaunchResponse": { "docs": undefined, + "inline": undefined, "properties": { "enrollment_automation": "EnrollmentAutomationsLaunchResponseEnrollmentAutomation", "ok": "boolean", @@ -31363,6 +31843,7 @@ service: }, "EnrollmentAutomationsLaunchResponseEnrollmentAutomation": { "docs": undefined, + "inline": true, "properties": { "acs_credential_provisioning_automation_id": { "type": "string", @@ -31417,6 +31898,7 @@ service: }, "EnrollmentAutomationsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "enrollment_automations": "list", "ok": "boolean", @@ -31464,6 +31946,7 @@ service: format: uuid source: openapi: ../openapi.json + inline: true EnrollmentAutomationsLaunchResponse: properties: enrollment_automation: EnrollmentAutomationsLaunchResponseEnrollmentAutomation @@ -31894,6 +32377,7 @@ service: "types": { "WebhooksCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "webhook": "root.Webhook", @@ -31904,6 +32388,7 @@ service: }, "WebhooksDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -31913,6 +32398,7 @@ service: }, "WebhooksGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "webhook": "root.Webhook", @@ -31923,6 +32409,7 @@ service: }, "WebhooksListResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "webhooks": "list", @@ -31933,6 +32420,7 @@ service: }, "WebhooksUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -32329,6 +32817,7 @@ service: }, "WorkspacesCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "workspace": "root.Workspace", @@ -32339,6 +32828,7 @@ service: }, "WorkspacesGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "workspace": "root.Workspace", @@ -32349,6 +32839,7 @@ service: }, "WorkspacesListResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "workspaces": "list", @@ -32359,6 +32850,7 @@ service: }, "WorkspacesResetSandboxResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/squidex.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/squidex.json index 33b57d2f7cc..a0153219d83 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/squidex.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/squidex.json @@ -5441,6 +5441,7 @@ }, "AddFieldDto": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "The name of the field. Must be unique within the schema.", @@ -5467,6 +5468,7 @@ }, "AlgoliaRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "apiKey": { "docs": "The API key to grant access to Squidex.", @@ -5513,6 +5515,7 @@ }, "AllContentsByPostDto": { "docs": undefined, + "inline": undefined, "properties": { "ids": { "docs": "The list of ids to query.", @@ -5549,6 +5552,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "canAccessApi": { "availability": "deprecated", @@ -5619,6 +5623,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "englishName": { "docs": "The english name of the language.", @@ -5650,6 +5655,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The languages.", @@ -5665,6 +5671,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "editors": { "docs": "The configured UI editors.", @@ -5693,6 +5700,7 @@ }, "ArrayFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "maxItems": { "docs": "The maximum allowed items for the field value.", @@ -5713,6 +5721,7 @@ }, "AssetChangedRuleTriggerDto": { "docs": undefined, + "inline": undefined, "properties": { "condition": { "docs": "Javascript condition when to trigger.", @@ -5728,6 +5737,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "_meta": { "docs": "The metadata.", @@ -5838,6 +5848,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "folderName": { "docs": "The folder name.", @@ -5876,6 +5887,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The assets folders.", @@ -5896,6 +5908,7 @@ }, "AssetMeta": { "docs": undefined, + "inline": undefined, "properties": { "isDuplicate": { "docs": "Indicates whether the asset is a duplicate.", @@ -5922,6 +5935,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "annotate": { "docs": "The script that is executed when annotating a content.", @@ -5977,6 +5991,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The assets.", @@ -5993,6 +6008,7 @@ }, "AssetsFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "allowDuplicates": { "docs": "True, if duplicate values are allowed.", @@ -6087,6 +6103,7 @@ }, "AssignContributorDto": { "docs": undefined, + "inline": undefined, "properties": { "contributorId": { "docs": "The id or email of the user to add to the app.", @@ -6113,6 +6130,7 @@ }, "AzureQueueRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "connectionString": { "docs": "The connection string to the storage account.", @@ -6148,6 +6166,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "handledAssets": { "docs": "The number of handled assets.", @@ -6183,6 +6202,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The backups.", @@ -6205,6 +6225,7 @@ }, "BooleanFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "defaultValue": { "docs": "The default value for the field value.", @@ -6229,6 +6250,7 @@ }, "BulkResultDto": { "docs": undefined, + "inline": undefined, "properties": { "contentId": { "availability": "deprecated", @@ -6265,6 +6287,7 @@ }, "BulkUpdateAssetsJobDto": { "docs": undefined, + "inline": undefined, "properties": { "expectedVersion": { "docs": "The expected version.", @@ -6328,6 +6351,7 @@ }, "BulkUpdateContentsJobDto": { "docs": undefined, + "inline": undefined, "properties": { "data": { "docs": "The data of the content when type is set to 'Upsert', 'Create', 'Update' or 'Patch.", @@ -6380,6 +6404,7 @@ }, "CallsUsageDtoDto": { "docs": undefined, + "inline": undefined, "properties": { "allowedBytes": { "docs": "The included API traffic.", @@ -6424,6 +6449,7 @@ }, "CallsUsagePerDateDto": { "docs": undefined, + "inline": undefined, "properties": { "averageElapsedMs": { "docs": "The average duration in milliseconds.", @@ -6454,6 +6480,7 @@ }, "ChangePlanDto": { "docs": undefined, + "inline": undefined, "properties": { "planId": { "docs": "The new plan id.", @@ -6475,6 +6502,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "allowAnonymous": { "docs": "True to allow anonymous access without an access token for this client.", @@ -6514,6 +6542,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The clients.", @@ -6526,6 +6555,7 @@ }, "CommentDto": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the comment.", @@ -6560,6 +6590,7 @@ }, "CommentRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "client": { "docs": "An optional client name.", @@ -6582,6 +6613,7 @@ }, "CommentRuleTriggerDto": { "docs": undefined, + "inline": undefined, "properties": { "condition": { "docs": "Javascript condition when to trigger.", @@ -6594,6 +6626,7 @@ }, "CommentsDto": { "docs": undefined, + "inline": undefined, "properties": { "createdComments": { "docs": "The created comments including the updates.", @@ -6618,6 +6651,7 @@ }, "ComponentFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "schemaIds": { "docs": "The ID of the embedded schemas.", @@ -6630,6 +6664,7 @@ }, "ComponentsFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "maxItems": { "docs": "The maximum allowed items for the field value.", @@ -6655,6 +6690,7 @@ "ConfigurePreviewUrlsDto": "map", "ContentChangedRuleTriggerDto": { "docs": undefined, + "inline": undefined, "properties": { "handleAll": { "docs": "Determines whether the trigger should handle all content changes events.", @@ -6679,6 +6715,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "created": { "docs": "The date and time when the content item has been created.", @@ -6764,6 +6801,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The content items.", @@ -6787,6 +6825,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "contributorEmail": { "docs": "The email address.", @@ -6814,6 +6853,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "_meta": { "docs": "The metadata to provide information about this request.", @@ -6834,6 +6874,7 @@ }, "ContributorsMetadata": { "docs": undefined, + "inline": undefined, "properties": { "isInvited": { "docs": "Indicates whether the user has been invited.", @@ -6846,6 +6887,7 @@ }, "CreateContentRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "client": { "docs": "An optional client name.", @@ -6882,6 +6924,7 @@ }, "CreateRuleDto": { "docs": undefined, + "inline": undefined, "properties": { "action": { "docs": "The action properties.", @@ -6898,6 +6941,7 @@ }, "CurrentStorageDto": { "docs": undefined, + "inline": undefined, "properties": { "maxAllowed": { "docs": "The maximum allowed asset size.", @@ -6934,6 +6978,7 @@ }, "DateTimeFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "calculatedDefaultValue": { "docs": "The calculated default value for the field value.", @@ -6970,6 +7015,7 @@ }, "DiscourseRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "apiKey": { "docs": "The api key to authenticate to your discourse server.", @@ -7030,6 +7076,7 @@ }, "EditorDto": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "The name of the editor.", @@ -7046,6 +7093,7 @@ }, "ElasticSearchRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "delete": { "docs": "The condition when to delete the document.", @@ -7090,6 +7138,7 @@ }, "EmailRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "messageBody": { "docs": "The message body.", @@ -7172,6 +7221,7 @@ }, "ErrorDto": { "docs": undefined, + "inline": undefined, "properties": { "details": { "docs": "Detailed error messages.", @@ -7213,6 +7263,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "count": { "docs": "The number of handled events.", @@ -7254,6 +7305,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The event consumers.", @@ -7267,6 +7319,7 @@ "ExposedValues": "map", "FastlyRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "apiKey": { "docs": "The API key to grant access to Squidex.", @@ -7295,6 +7348,7 @@ }, "FeatureDto": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "The name of the feature.", @@ -7311,6 +7365,7 @@ }, "FeaturesDto": { "docs": undefined, + "inline": undefined, "properties": { "features": { "docs": "The latest features.", @@ -7330,6 +7385,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "fieldId": { "docs": "The ID of the field.", @@ -7469,6 +7525,7 @@ }, "FieldRuleDto": { "docs": undefined, + "inline": undefined, "properties": { "action": { "docs": "The action to perform when the condition is met.", @@ -7499,6 +7556,7 @@ }, "GeolocationFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "editor": { "docs": "The editor that is used to manage this field.", @@ -7511,6 +7569,7 @@ }, "HistoryEventDto": { "docs": undefined, + "inline": undefined, "properties": { "actor": { "docs": "The user who called the action.", @@ -7571,6 +7630,7 @@ }, "JsonFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "graphQLSchema": { "docs": "The GraphQL schema.", @@ -7583,6 +7643,7 @@ }, "LanguageDto": { "docs": undefined, + "inline": undefined, "properties": { "englishName": { "docs": "The english name of the language.", @@ -7608,6 +7669,7 @@ "LocalizedValueOfString": "map", "LogDownloadDto": { "docs": undefined, + "inline": undefined, "properties": { "downloadUrl": { "docs": "The url to download the log.", @@ -7620,6 +7682,7 @@ }, "ManualRuleTriggerDto": { "docs": undefined, + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.json", @@ -7627,6 +7690,7 @@ }, "MediumRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "accessToken": { "docs": "The self issued access token.", @@ -7684,6 +7748,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "fieldId": { "docs": "The ID of the field.", @@ -7722,6 +7787,7 @@ }, "NotificationRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "client": { "docs": "An optional client name.", @@ -7770,6 +7836,7 @@ }, "NumberFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "allowedValues": { "docs": "The allowed values for the field value.", @@ -7810,6 +7877,7 @@ }, "OpenSearchRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "delete": { "docs": "The condition when to delete the document.", @@ -7854,6 +7922,7 @@ }, "PatternDto": { "docs": undefined, + "inline": undefined, "properties": { "message": { "docs": "The regex message.", @@ -7874,6 +7943,7 @@ }, "PlanChangedDto": { "docs": undefined, + "inline": undefined, "properties": { "redirectUri": { "docs": "Optional redirect uri.", @@ -7886,6 +7956,7 @@ }, "PlanDto": { "docs": undefined, + "inline": undefined, "properties": { "confirmText": { "docs": "An optional confirm text for the monthly subscription.", @@ -7938,6 +8009,7 @@ }, "PlansDto": { "docs": undefined, + "inline": undefined, "properties": { "currentPlanId": { "docs": "The current plan id.", @@ -7988,6 +8060,7 @@ }, "PrerenderRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "token": { "docs": "The prerender token from your account.", @@ -8017,6 +8090,7 @@ "PropertyPath": "list", "QueryDto": { "docs": undefined, + "inline": undefined, "properties": { "ids": { "docs": "The optional list of ids to query.", @@ -8038,6 +8112,7 @@ }, "QueryJsonDto": { "docs": undefined, + "inline": undefined, "properties": { "filter": "optional", "fullText": "optional", @@ -8066,6 +8141,7 @@ }, "ReferencesFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "allowDuplicates": { "docs": "True, if duplicate values are allowed.", @@ -8110,6 +8186,7 @@ }, "ReferralInfo": { "docs": undefined, + "inline": undefined, "properties": { "code": "string", "condition": "string", @@ -8121,6 +8198,7 @@ }, "ReorderFieldsDto": { "docs": undefined, + "inline": undefined, "properties": { "fieldIds": { "docs": "The field ids in the target order.", @@ -8148,6 +8226,7 @@ }, "Resource": { "docs": undefined, + "inline": undefined, "properties": { "_links": { "docs": "The links.", @@ -8160,6 +8239,7 @@ }, "ResourceLink": { "docs": undefined, + "inline": undefined, "properties": { "href": { "docs": "The link url.", @@ -8195,6 +8275,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.json", @@ -8202,6 +8283,7 @@ }, "RestoreJobDto": { "docs": undefined, + "inline": undefined, "properties": { "log": { "docs": "The status log.", @@ -8239,6 +8321,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "isDefaultRole": { "docs": "Indicates if the role is an builtin default role.", @@ -8274,6 +8357,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The roles.", @@ -8319,6 +8403,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "action": { "docs": "The action properties.", @@ -8380,6 +8465,7 @@ }, "RuleElementDto": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "Describes the action or trigger type.", @@ -8416,6 +8502,7 @@ }, "RuleElementPropertyDto": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "The optional description.", @@ -8455,6 +8542,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "created": { "docs": "The time when the event has been created.", @@ -8502,6 +8590,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The rule events.", @@ -8581,6 +8670,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The rules.", @@ -8597,6 +8687,7 @@ }, "ScheduleJobDto": { "docs": undefined, + "inline": undefined, "properties": { "color": { "docs": "The color of the scheduled status.", @@ -8625,6 +8716,7 @@ }, "SchemaChangedRuleTriggerDto": { "docs": undefined, + "inline": undefined, "properties": { "condition": { "docs": "Javascript condition when to trigger.", @@ -8637,6 +8729,7 @@ }, "SchemaCondition": { "docs": undefined, + "inline": undefined, "properties": { "condition": "optional", "schemaId": "string", @@ -8650,6 +8743,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "category": { "docs": "The name of the category.", @@ -8749,6 +8843,7 @@ }, "SchemaPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "contentEditorUrl": { "docs": "The url to the editor plugin.", @@ -8797,6 +8892,7 @@ }, "SchemaScriptsDto": { "docs": undefined, + "inline": undefined, "properties": { "change": { "docs": "The script that is executed when change a content status.", @@ -8843,6 +8939,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The schemas.", @@ -8855,6 +8952,7 @@ }, "ScriptRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "script": { "docs": "The script to render.", @@ -8876,6 +8974,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "label": { "docs": "An optional label.", @@ -8910,6 +9009,7 @@ }, "SignalRRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "action": { "docs": "* Broadcast = send to all users. @@ -8956,6 +9056,7 @@ }, "SimulatedRuleEventDto": { "docs": undefined, + "inline": undefined, "properties": { "actionData": { "docs": "The name of the action.", @@ -9015,6 +9116,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The simulated rule events.", @@ -9050,6 +9152,7 @@ }, "SlackRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "text": { "docs": "The text that is sent as message to slack.", @@ -9078,6 +9181,7 @@ }, "SortNode": { "docs": undefined, + "inline": undefined, "properties": { "order": "SortOrder", "path": "PropertyPath", @@ -9098,6 +9202,7 @@ }, "StatusInfoDto": { "docs": undefined, + "inline": undefined, "properties": { "color": { "docs": "The color of the status.", @@ -9114,6 +9219,7 @@ }, "StorageUsagePerDateDto": { "docs": undefined, + "inline": undefined, "properties": { "date": { "docs": "The date when the usage was tracked.", @@ -9169,6 +9275,7 @@ }, "StringFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "allowedValues": { "docs": "The allowed values for the field value.", @@ -9264,6 +9371,7 @@ }, "TagsFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "allowedValues": { "docs": "The allowed values for the field value.", @@ -9303,6 +9411,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "created": { "docs": "The timestamp when the team has been created.", @@ -9338,6 +9447,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "details": { "docs": "The details of the template.", @@ -9353,6 +9463,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "description": { "docs": "The description of the template.", @@ -9380,6 +9491,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The event consumers.", @@ -9392,6 +9504,7 @@ }, "TranslationDto": { "docs": undefined, + "inline": undefined, "properties": { "result": { "docs": "The result of the translation.", @@ -9422,6 +9535,7 @@ }, "TweetRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "accessSecret": { "docs": " The generated access secret.", @@ -9460,6 +9574,7 @@ }, "TypesenseRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "apiKey": { "docs": "The api key.", @@ -9510,6 +9625,7 @@ }, "UiFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "editor": { "docs": "The editor that is used to manage this field.", @@ -9522,6 +9638,7 @@ }, "UiSettingsDto": { "docs": undefined, + "inline": undefined, "properties": { "canCreateApps": { "docs": "True when the user can create apps.", @@ -9538,6 +9655,7 @@ }, "UpdateFieldDto": { "docs": undefined, + "inline": undefined, "properties": { "properties": { "docs": "The field properties.", @@ -9550,6 +9668,7 @@ }, "UpdateSettingDto": { "docs": undefined, + "inline": undefined, "properties": { "value": "unknown", }, @@ -9559,6 +9678,7 @@ }, "UpsertCommentDto": { "docs": undefined, + "inline": undefined, "properties": { "text": { "docs": "The comment text.", @@ -9587,6 +9707,7 @@ }, "UpsertSchemaDto": { "docs": undefined, + "inline": undefined, "properties": { "category": { "docs": "The category.", @@ -9631,6 +9752,7 @@ }, "UpsertSchemaFieldDto": { "docs": undefined, + "inline": undefined, "properties": { "isDisabled": { "docs": "Defines if the field is disabled.", @@ -9673,6 +9795,7 @@ }, "UpsertSchemaNestedFieldDto": { "docs": undefined, + "inline": undefined, "properties": { "isDisabled": { "docs": "Defines if the field is disabled.", @@ -9707,6 +9830,7 @@ }, "UsageRuleTriggerDto": { "docs": undefined, + "inline": undefined, "properties": { "limit": { "docs": "The number of monthly api calls.", @@ -9733,6 +9857,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "displayName": { "docs": "The display name (usually first name and last name) of the user.", @@ -9761,6 +9886,7 @@ }, "UserProperty": { "docs": undefined, + "inline": undefined, "properties": { "name": { "type": "string", @@ -9790,6 +9916,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The users.", @@ -9819,6 +9946,7 @@ }, "WebhookRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "headers": { "docs": "The message headers in the format '[Key]=[Value]', one entry per line.", @@ -9860,6 +9988,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "id": { "docs": "The workflow id.", @@ -9888,6 +10017,7 @@ }, "WorkflowStepDto": { "docs": undefined, + "inline": undefined, "properties": { "color": { "docs": "The optional color.", @@ -9920,6 +10050,7 @@ }, "WorkflowTransitionDto": { "docs": undefined, + "inline": undefined, "properties": { "expression": { "docs": "The optional expression.", @@ -9939,6 +10070,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "errors": { "docs": "The errros that should be fixed.", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/streaming.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/streaming.json index e5f60aaff72..db065712585 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/streaming.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/streaming.json @@ -285,6 +285,7 @@ "types": { "StreamUser": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", @@ -302,6 +303,7 @@ }, "StreamUser2": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", @@ -321,6 +323,7 @@ }, "User": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", @@ -338,6 +341,7 @@ }, "User2": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", @@ -357,6 +361,7 @@ }, "UserV3Response": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", @@ -375,6 +380,7 @@ }, "UserV3StreamResponse": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/suger.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/suger.json index 5d0bcf4c166..72124106e57 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/suger.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/suger.json @@ -471,6 +471,7 @@ "types": { "AzureAudience": { "docs": undefined, + "inline": undefined, "properties": { "description": "optional", "id": "optional", @@ -481,6 +482,7 @@ }, "AzureGovernmentCertification": { "docs": undefined, + "inline": undefined, "properties": { "title": "optional", "uri": "optional", @@ -492,6 +494,7 @@ }, "AzureIncludedBaseQuantity": { "docs": undefined, + "inline": undefined, "properties": { "isInfinite": "optional", "quantity": "optional", @@ -512,6 +515,7 @@ }, "AzureListingContact": { "docs": undefined, + "inline": undefined, "properties": { "email": "optional", "name": "optional", @@ -535,6 +539,7 @@ }, "AzureListingUri": { "docs": undefined, + "inline": undefined, "properties": { "displayText": "optional", "subtype": "optional", @@ -547,6 +552,7 @@ }, "AzureLocalizedDateTime": { "docs": undefined, + "inline": undefined, "properties": { "dateTimeInUtc": "optional", "localizePerMarket": "optional", @@ -557,6 +563,7 @@ }, "AzureLocalizedTimeRange": { "docs": undefined, + "inline": undefined, "properties": { "endAt": "optional", "startAt": "optional", @@ -567,6 +574,7 @@ }, "AzureMarket": { "docs": undefined, + "inline": undefined, "properties": { "friendlyName": "optional", "marketCode": { @@ -580,6 +588,7 @@ }, "AzureMarketState": { "docs": undefined, + "inline": undefined, "properties": { "marketCode": { "docs": "ISO Country Code", @@ -604,6 +613,7 @@ }, "AzureMarketplacePrice": { "docs": undefined, + "inline": undefined, "properties": { "currency": { "docs": "ISO 4217 currency code", @@ -622,6 +632,7 @@ }, "AzureMarketplacePrivateOffer": { "docs": undefined, + "inline": undefined, "properties": { "$schema": "optional", "acceptBy": { @@ -675,6 +686,7 @@ }, "AzureMarketplacePrivateOfferAcceptanceLink": { "docs": undefined, + "inline": undefined, "properties": { "beneficiaryId": { "docs": "The Customer Billing Account ID.", @@ -688,6 +700,7 @@ }, "AzureMarketplacePrivateOfferBeneficiary": { "docs": undefined, + "inline": undefined, "properties": { "beneficiaryRecipients": "optional>", "description": "optional", @@ -702,6 +715,7 @@ }, "AzureMarketplacePrivateOfferBeneficiaryRecipient": { "docs": undefined, + "inline": undefined, "properties": { "id": "optional", "recipientType": "optional", @@ -721,6 +735,7 @@ }, "AzureMarketplacePrivateOfferPricing": { "docs": undefined, + "inline": undefined, "properties": { "discountPercentage": { "docs": "between 0 and 100", @@ -785,6 +800,7 @@ }, "AzureMarketplacePrivateOfferPromotionReference": { "docs": undefined, + "inline": undefined, "properties": { "id": "optional", "name": "optional", @@ -815,6 +831,7 @@ }, "AzureMarketplaceTerm": { "docs": undefined, + "inline": undefined, "properties": { "type": "optional", "value": { @@ -839,6 +856,7 @@ }, "AzureMarketplaceValidation": { "docs": undefined, + "inline": undefined, "properties": { "$schema": "optional", "code": "optional", @@ -881,6 +899,7 @@ }, "AzurePendingUpdateInfo": { "docs": undefined, + "inline": undefined, "properties": { "status": "optional", "updateType": "optional", @@ -891,6 +910,7 @@ }, "AzurePrice": { "docs": undefined, + "inline": undefined, "properties": { "currencyCode": { "docs": "ISO currency code, Three characters", @@ -905,6 +925,7 @@ }, "AzurePriceAndAvailabilityPrivateOfferCustomMeters": { "docs": undefined, + "inline": undefined, "properties": { "meters": "optional", "priceInputOption": { @@ -928,6 +949,7 @@ }, "AzurePriceAndAvailabilityPrivateOfferPlan": { "docs": undefined, + "inline": undefined, "properties": { "$schema": "optional", "id": "optional", @@ -943,6 +965,7 @@ }, "AzurePriceAndAvailabilityPrivateOfferPrice": { "docs": undefined, + "inline": undefined, "properties": { "customMeters": "optional", "recurrentPrice": "optional", @@ -953,6 +976,7 @@ }, "AzurePriceAndAvailabilityRecurrentPrice": { "docs": undefined, + "inline": undefined, "properties": { "priceInputOption": { "docs": "default "usd"", @@ -966,6 +990,7 @@ }, "AzurePriceAndAvailabilityRecurrentPriceItem": { "docs": undefined, + "inline": undefined, "properties": { "billingTerm": "optional", "paymentOption": "optional", @@ -988,6 +1013,7 @@ }, "AzurePriceCadence": { "docs": undefined, + "inline": undefined, "properties": { "type": "optional", "value": "optional", @@ -1007,6 +1033,7 @@ }, "AzurePriceSchedule": { "docs": undefined, + "inline": undefined, "properties": { "priceCadence": "optional", "pricingModel": "optional", @@ -1029,6 +1056,7 @@ }, "AzurePricingUnit": { "docs": undefined, + "inline": undefined, "properties": { "isUnlimitedUnit": "optional", "lowerUnit": "optional", @@ -1051,6 +1079,7 @@ }, "AzureProduct": { "docs": undefined, + "inline": undefined, "properties": { "availabilities": "optional>", "branches": "optional>", @@ -1075,6 +1104,7 @@ }, "AzureProductAvailability": { "docs": undefined, + "inline": undefined, "properties": { "emailAudiences": "optional>", "enterpriseLicensing": "optional", @@ -1089,6 +1119,7 @@ }, "AzureProductBranch": { "docs": undefined, + "inline": undefined, "properties": { "currentDraftInstanceID": "optional", "friendlyName": "optional", @@ -1104,6 +1135,7 @@ }, "AzureProductFeatureAvailability": { "docs": undefined, + "inline": undefined, "properties": { "customMeters": "optional>", "id": "optional", @@ -1136,6 +1168,7 @@ }, "AzureProductListing": { "docs": undefined, + "inline": undefined, "properties": { "accessInformation": "optional", "assets": { @@ -1163,6 +1196,7 @@ }, "AzureProductListingAsset": { "docs": undefined, + "inline": undefined, "properties": { "description": "optional", "fileName": "optional", @@ -1203,6 +1237,7 @@ }, "AzureProductPackageConfiguration": { "docs": undefined, + "inline": undefined, "properties": { "azureActiveDirectoryApplicationID": "optional", "azureActiveDirectoryTenantID": "optional", @@ -1217,6 +1252,7 @@ }, "AzureProductProperty": { "docs": undefined, + "inline": undefined, "properties": { "additionalCategories": "optional>", "appVersion": "optional", @@ -1243,6 +1279,7 @@ }, "AzureProductSetup": { "docs": undefined, + "inline": undefined, "properties": { "callToAction": "optional", "channelStates": "optional>", @@ -1283,6 +1320,7 @@ }, "AzureProductSubmission": { "docs": undefined, + "inline": undefined, "properties": { "areResourcesReady": "optional", "friendlyName": "optional", @@ -1327,6 +1365,7 @@ }, "AzureProductVariant": { "docs": undefined, + "inline": undefined, "properties": { "azureGovernmentCertifications": "optional>", "cloudAvailabilities": "optional>", @@ -1350,6 +1389,7 @@ }, "AzureProductVariantCustomMeter": { "docs": undefined, + "inline": undefined, "properties": { "displayName": "optional", "id": "optional", @@ -1365,6 +1405,7 @@ }, "AzureProductVariantPriceSchedule": { "docs": undefined, + "inline": undefined, "properties": { "dateTimeRange": "optional", "friendlyName": "optional", @@ -1402,6 +1443,7 @@ }, "AzureProductVariantTrial": { "docs": undefined, + "inline": undefined, "properties": { "dateTimeRange": "optional", "duration": "optional", @@ -1435,6 +1477,7 @@ }, "AzureTypeValue": { "docs": undefined, + "inline": undefined, "properties": { "type": "optional", "value": "optional", @@ -1445,6 +1488,7 @@ }, "AzureValidationResult": { "docs": undefined, + "inline": undefined, "properties": { "errorMessage": "optional", "memberNames": "optional>", @@ -1455,6 +1499,7 @@ }, "AzureVariantResource": { "docs": undefined, + "inline": undefined, "properties": { "resources": "optional>", "variantID": "optional", @@ -1465,6 +1510,7 @@ }, "GithubComAwsAwsSdkGoV2ServiceMarketplacemeteringTypesTag": { "docs": undefined, + "inline": undefined, "properties": { "key": { "docs": "One part of a key-value pair that makes up a tag. A key is a label that acts @@ -1487,6 +1533,7 @@ This member is required.", }, "GithubComSugerioMarketplaceServiceAzureSdkMarketplacemeteringv1BatchUsageEventOkResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "result": "optional>", @@ -1497,6 +1544,7 @@ This member is required.", }, "GithubComSugerioMarketplaceServiceAzureSdkMarketplacemeteringv1UsageBatchEventOkMessage": { "docs": undefined, + "inline": undefined, "properties": { "dimension": { "docs": "Dimension identifier", @@ -1542,6 +1590,7 @@ This member is required.", }, "GithubComSugerioMarketplaceServiceAzureSdkMarketplacemeteringv1UsageEventConflictResponse": { "docs": undefined, + "inline": undefined, "properties": { "additionalInfo": "optional", "code": "optional", @@ -1553,6 +1602,7 @@ This member is required.", }, "GithubComSugerioMarketplaceServiceAzureSdkMarketplacemeteringv1UsageEventConflictResponseAdditionalInfo": { "docs": undefined, + "inline": undefined, "properties": { "acceptedMessage": "optional", }, @@ -1562,6 +1612,7 @@ This member is required.", }, "GithubComSugerioMarketplaceServiceAzureSdkMarketplacemeteringv1UsageEventOkResponse": { "docs": undefined, + "inline": undefined, "properties": { "dimension": { "docs": "Dimension identifier", @@ -1622,6 +1673,7 @@ This member is required.", }, "GithubComSugerioMarketplaceServiceRdsDbLibBillingAwsBillingEvent": { "docs": undefined, + "inline": undefined, "properties": { "action": "optional", "agreementID": "optional", @@ -1658,6 +1710,7 @@ This member is required.", }, "GithubComSugerioMarketplaceServiceRdsDbLibBillingAzureCmaRevenue": { "docs": undefined, + "inline": undefined, "properties": { "azureAssetID": "optional", "azureBillingAccountID": "optional", @@ -1683,6 +1736,7 @@ This member is required.", }, "GithubComSugerioMarketplaceServiceRdsDbLibBillingGcpChargeUsage": { "docs": undefined, + "inline": undefined, "properties": { "abandoned": "optional", "accountID": "optional", @@ -1718,6 +1772,7 @@ This member is required.", }, "MarketplacemeteringBatchMeterUsageOutput": { "docs": undefined, + "inline": undefined, "properties": { "resultMetadata": { "docs": "Metadata pertaining to the operation's result.", @@ -1743,6 +1798,7 @@ BatchMeterUsage call with this list as input in the BatchMeterUsageRequest.", "MiddlewareMetadata": "map", "ServicecontrolReportError": { "docs": undefined, + "inline": undefined, "properties": { "operationId": { "docs": "OperationId: The Operation.operation_id value from the request.", @@ -1759,6 +1815,7 @@ BatchMeterUsage call with this list as input in the BatchMeterUsageRequest.", }, "ServicecontrolReportResponse": { "docs": undefined, + "inline": undefined, "properties": { "reportErrors": { "docs": "ReportErrors: Partial failures, one for each `Operation` in the @@ -1791,6 +1848,7 @@ request.", }, "ServicecontrolStatus": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Code: The status code, which should be an enum value of @@ -1815,6 +1873,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAddEntitlementCreditResponse": { "docs": undefined, + "inline": undefined, "properties": { "creditAmountIncrement": { "docs": "The amount to be added to the credit amount.", @@ -1834,6 +1893,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedApiClientAccessToken": { "docs": undefined, + "inline": undefined, "properties": { "access_token": "optional", "expires_in": { @@ -1852,6 +1912,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsAccountIdentifier": { "docs": undefined, + "inline": undefined, "properties": { "awsAccountID": { "docs": "The AWS Account ID of the buyer in AWS Marketplace", @@ -1873,6 +1934,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsAceIntegration": { "docs": undefined, + "inline": undefined, "properties": { "credential": "optional", "partnerId": { @@ -1898,6 +1960,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsIntegrationCredential": { "docs": undefined, + "inline": undefined, "properties": { "accessKeyId": { "docs": "The access key ID of the IAM user for Suger service to access the client's AWS services.", @@ -1918,6 +1981,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsMarketplaceIntegration": { "docs": "The data struct to store integration info for Suger service to access the client's AWS services.", + "inline": undefined, "properties": { "externalID": { "docs": "The external ID for assuming IAM role. If empty, means no external ID set or needed. Otherwise, it should be auth_id in table identity.organization.", @@ -1974,6 +2038,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsSaasProduct": { "docs": undefined, + "inline": undefined, "properties": { "Description": "optional", "Dimensions": "optional>", @@ -1992,6 +2057,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsSaasProductAdditionalResource": { "docs": undefined, + "inline": undefined, "properties": { "Text": "optional", "Type": "optional", @@ -2003,6 +2069,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsSaasProductDeliveryOption": { "docs": undefined, + "inline": undefined, "properties": { "FulfillmentUrl": "optional", "Id": "optional", @@ -2014,6 +2081,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsSaasProductDescription": { "docs": undefined, + "inline": undefined, "properties": { "AssociatedProducts": "optional", "Categories": "optional>", @@ -2036,6 +2104,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsSaasProductDimension": { "docs": undefined, + "inline": undefined, "properties": { "Description": "optional", "Key": "optional", @@ -2049,6 +2118,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsSaasProductPromotionalResources": { "docs": undefined, + "inline": undefined, "properties": { "AdditionalResources": "optional>", "LogoUrl": "optional", @@ -2059,6 +2129,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsSaasProductSupportInformation": { "docs": undefined, + "inline": undefined, "properties": { "Description": "optional", }, @@ -2068,6 +2139,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsSaasProductVersion": { "docs": undefined, + "inline": undefined, "properties": { "DeliveryOptions": "optional>", "Id": "optional", @@ -2078,6 +2150,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsSnsSubscription": { "docs": undefined, + "inline": undefined, "properties": { "Endpoint": "optional", "Protocol": "optional", @@ -2101,6 +2174,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAzureAdIdentifier": { "docs": undefined, + "inline": undefined, "properties": { "buyerInfo": "optional", "companyInfo": "optional", @@ -2121,6 +2195,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAzureBuyerInfo": { "docs": undefined, + "inline": undefined, "properties": { "billingAccountId": "optional", "customerId": "optional", @@ -2133,6 +2208,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAzureIntegration": { "docs": undefined, + "inline": undefined, "properties": { "cmaFullSyncDone": { "docs": "Is Azure Commercial Marketplace Analytics (CMA) full-sync done.", @@ -2150,6 +2226,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAzureIntegrationCredential": { "docs": undefined, + "inline": undefined, "properties": { "accessToken": "optional", "clientID": "optional", @@ -2172,6 +2249,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAzureMarketplaceSubscription": { "docs": undefined, + "inline": undefined, "properties": { "allowedCustomerOperations": "optional>", "autoRenew": "optional", @@ -2241,6 +2319,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAzureTerm": { "docs": undefined, + "inline": undefined, "properties": { "chargeDuration": "optional", "endDate": "optional", @@ -2253,6 +2332,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedBuyerInfo": { "docs": undefined, + "inline": undefined, "properties": { "awsBuyer": { "docs": "Buyer from AWS Marketplace", @@ -2285,6 +2365,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedCommitDimension": { "docs": "The commit dimension. There may be one or more commit dimensions defined in single product, offer or entitlement.", + "inline": undefined, "properties": { "category": "optional", "description": "optional", @@ -2368,6 +2449,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedCompanyInfo": { "docs": undefined, + "inline": undefined, "properties": { "addressLine1": "optional", "addressLine2": "optional", @@ -2384,6 +2466,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedContact": { "docs": undefined, + "inline": undefined, "properties": { "company": "optional", "email": "optional", @@ -2395,6 +2478,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedEntitlementInfo": { "docs": undefined, + "inline": undefined, "properties": { "autoRenew": { "docs": "Is this Entitlement Auto Renew enabled.", @@ -2463,6 +2547,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedEntitlementTermInfo": { "docs": undefined, + "inline": undefined, "properties": { "type": "optional", }, @@ -2488,6 +2573,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedEntitlementUsageRecord": { "docs": undefined, + "inline": undefined, "properties": { "amounts": "optional>", "date": "optional", @@ -2529,6 +2615,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerExternalAccountSpec": { "docs": undefined, + "inline": undefined, "properties": { "loginUri": "optional", "signupUri": "optional", @@ -2540,6 +2627,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerListingSpec": { "docs": undefined, + "inline": undefined, "properties": { "externalAccountSpec": "optional", "listingType": "optional>", @@ -2552,6 +2640,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerMarketingSpec": { "docs": undefined, + "inline": undefined, "properties": { "description": "optional", "displayNames": { @@ -2580,6 +2669,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerPrice": { "docs": undefined, + "inline": undefined, "properties": { "currencyCode": { "docs": "ISO currency code, Three UPPER_CASE characters", @@ -2600,6 +2690,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerPriceInfo": { "docs": undefined, + "inline": undefined, "properties": { "description": "optional", "priceModel": "optional", @@ -2629,6 +2720,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerPriceSubscription": { "docs": undefined, + "inline": undefined, "properties": { "period": "optional>", "price": { @@ -2643,6 +2735,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerPriceTier": { "docs": undefined, + "inline": undefined, "properties": { "endUsageAmount": { "docs": "The usage amount below which this tier is effective.", @@ -2663,6 +2756,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerPriceUsage": { "docs": undefined, + "inline": undefined, "properties": { "displayQuantity": { "docs": "Default value is 1.", @@ -2681,6 +2775,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerPurchaseMetric": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "Description: A detailed description of the metric, which can be used in documentation.", @@ -2708,6 +2803,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerPurchaseSpec": { "docs": undefined, + "inline": undefined, "properties": { "metrics": "optional>", "purchaseOptionSpecs": "optional>", @@ -2718,6 +2814,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerServiceBilling": { "docs": undefined, + "inline": undefined, "properties": { "metrics": { "docs": "in format of ["{product-name}.endpoints.{provider-id}.cloud.goog/{plan_key}_{usage_dimension_key}"]", @@ -2730,6 +2827,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerServiceConfig": { "docs": undefined, + "inline": undefined, "properties": { "billing": "optional", "metrics": { @@ -2752,6 +2850,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerSupportSpec": { "docs": undefined, + "inline": undefined, "properties": { "description": "optional", "email": "optional", @@ -2763,6 +2862,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpIntegration": { "docs": undefined, + "inline": undefined, "properties": { "gcpProjectId": "optional", "gcpProjectNumber": "optional", @@ -2800,6 +2900,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpMarketplaceConsumer": { "docs": undefined, + "inline": undefined, "properties": { "project": { "docs": "The project name with format `projects/`.", @@ -2812,6 +2913,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpMarketplaceEntitlement": { "docs": undefined, + "inline": undefined, "properties": { "account": { "docs": "The resource name of the account that this entitlement is based on, if any, in format ""providers/{provider_id}/accounts/{account_id}"", @@ -2973,6 +3075,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedGcpMarketplaceUserAccount": { "docs": undefined, + "inline": undefined, "properties": { "approvals": { "docs": "The approvals for this account, that are permitted or have been completed.", @@ -3011,6 +3114,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedGcpMarketplaceUserAccountApproval": { "docs": undefined, + "inline": undefined, "properties": { "name": "optional", "reason": { @@ -3055,6 +3159,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedGcpProduct": { "docs": undefined, + "inline": undefined, "properties": { "createTime": "optional", "id": { @@ -3079,6 +3184,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedGcpPurchasePlan": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "The Plan key.", @@ -3097,6 +3203,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedGcpUserInfo": { "docs": undefined, + "inline": undefined, "properties": { "roles": { "docs": "An array of strings representing the user's roles. Right now, it can be either: ** account_admin, which indicates that the user is a Billing Account Administrator of the billing account that purchased the product, or ** project_editor, which indicates that the user is a Project Editor, but not a Billing Administrator, of the project under that billing account.", @@ -3113,6 +3220,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedHubspotCrmCredential": { "docs": undefined, + "inline": undefined, "properties": { "accessToken": "optional", "acquiredOn": { @@ -3128,6 +3236,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedHubspotCrmIntegration": { "docs": undefined, + "inline": undefined, "properties": { "credential": "optional", "portalId": { @@ -3142,6 +3251,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedIdentityBuyer": { "docs": undefined, + "inline": undefined, "properties": { "creationTime": "optional", "description": "optional", @@ -3169,6 +3279,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedIdentityIntegration": { "docs": undefined, + "inline": undefined, "properties": { "createdBy": "optional", "creationTime": "optional", @@ -3206,6 +3317,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedIntegrationInfo": { "docs": undefined, + "inline": undefined, "properties": { "awsAceIntegration": { "docs": "AWS ACE Integration", @@ -3239,6 +3351,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedListRevenueRecordDetailsResponse": { "docs": undefined, + "inline": undefined, "properties": { "nextOffset": "optional", "revenueRecordDetails": "optional>", @@ -3249,6 +3362,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedListRevenueRecordsResponse": { "docs": undefined, + "inline": undefined, "properties": { "nextOffset": "optional", "revenueRecords": "optional>", @@ -3259,6 +3373,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedListUsageRecordGroupsResponse": { "docs": undefined, + "inline": undefined, "properties": { "nextOffset": "optional", "usageRecordGroups": "optional>", @@ -3269,6 +3384,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedListUsageRecordReportsResponse": { "docs": undefined, + "inline": undefined, "properties": { "nextOffset": "optional", "usageRecordReports": "optional>", @@ -3279,6 +3395,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedMeteringDimension": { "docs": "The dimension to meter usage in entitlement.", + "inline": undefined, "properties": { "category": "optional", "description": "optional", @@ -3305,6 +3422,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedMeteringUsageRecordGroup": { "docs": undefined, + "inline": undefined, "properties": { "creationTime": "optional", "entitlementID": "optional", @@ -3323,6 +3441,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedMeteringUsageRecordGroupMetaInfo": { "docs": undefined, + "inline": undefined, "properties": { "originRecords": { "docs": "The original records reported by the customer before convertion. If no dimension mapping is applied, this field is the same as the records field.", @@ -3335,6 +3454,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedMeteringUsageRecordReport": { "docs": undefined, + "inline": undefined, "properties": { "creationTime": "optional", "entitlementID": "optional", @@ -3350,6 +3470,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedMeteringUsageRecordReportInfo": { "docs": undefined, + "inline": undefined, "properties": { "awsMeteringResponse": { "docs": "The raw response from AWS metering service.", @@ -3422,6 +3543,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedNotificationEvent": { "docs": undefined, + "inline": undefined, "properties": { "action": "optional", "entityID": "optional", @@ -3488,6 +3610,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedOfferInfo": { "docs": undefined, + "inline": undefined, "properties": { "azureOriginalPlan": { "docs": "The origin pricing of Azure plan. Only applicable for Azure Marketplace plans.", @@ -3554,6 +3677,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedOfferMetaInfo": { "docs": undefined, + "inline": undefined, "properties": { "baseAgreementId": { "docs": "Applicable for AWS Marketplace only, when the IsAgreementBasedOffer is true.", @@ -3582,6 +3706,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedOperation": { "docs": undefined, + "inline": undefined, "properties": { "endTime": "optional", "id": { @@ -3601,6 +3726,7 @@ This field is present only if the product has usage-based billing configured.", "SharedOperationType": "literal<"TemporalWorkflow">", "SharedPaymentInstallment": { "docs": undefined, + "inline": undefined, "properties": { "amount": "optional", "chargeOn": "optional", @@ -3611,6 +3737,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedProductInfo": { "docs": undefined, + "inline": undefined, "properties": { "attributes": "optional>", "awsSaasProduct": "optional", @@ -3630,6 +3757,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedRevenueRecord": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "The revenue amount for the revenue report", @@ -3671,6 +3799,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedRevenueRecordDetail": { "docs": undefined, + "inline": undefined, "properties": { "awsRevenueRecordDetail": { "docs": "For AWS Marketplace", @@ -3691,6 +3820,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedRevenueRecordInfo": { "docs": undefined, + "inline": undefined, "properties": { "awsRevenueRecords": { "docs": "For raw revenue records in AWS Marketplace", @@ -3711,6 +3841,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedRevenueReport": { "docs": undefined, + "inline": undefined, "properties": { "buyerID": "optional", "entitlementID": "optional", @@ -3738,6 +3869,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedSalesforceCrmCredential": { "docs": undefined, + "inline": undefined, "properties": { "access_token": "optional", "exp": "optional", @@ -3750,6 +3882,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedSalesforceCrmIntegration": { "docs": undefined, + "inline": undefined, "properties": { "credential": { "docs": "System created", @@ -3770,6 +3903,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedSalesforceSyncFilter": { "docs": undefined, + "inline": undefined, "properties": { "fieldName": "optional", "operator": "optional", @@ -3781,6 +3915,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedSlackIntegration": { "docs": undefined, + "inline": undefined, "properties": { "accessToken": "optional", "appId": "optional", @@ -3804,6 +3939,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedUsageCount": { "docs": undefined, + "inline": undefined, "properties": { "creditCount": { "docs": "The count of this dimension usage records that are handled as credit.", @@ -3824,6 +3960,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedUsageReport": { "docs": undefined, + "inline": undefined, "properties": { "entitlementID": "optional", "organizationID": "optional", @@ -3853,6 +3990,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedWorkloadEntitlement": { "docs": undefined, + "inline": undefined, "properties": { "buyerID": "optional", "creationTime": "optional", @@ -3905,6 +4043,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedWorkloadEntitlementTerm": { "docs": undefined, + "inline": undefined, "properties": { "buyerID": "optional", "commitAmount": "optional", @@ -3943,6 +4082,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedWorkloadOffer": { "docs": undefined, + "inline": undefined, "properties": { "createdBy": "optional", "creationTime": "optional", @@ -4016,6 +4156,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedWorkloadProduct": { "docs": undefined, + "inline": undefined, "properties": { "createdBy": "optional", "creationTime": "optional", @@ -4061,6 +4202,7 @@ This field is present only if the product has usage-based billing configured.", }, "SlackOAuthResponseIncomingWebhook": { "docs": undefined, + "inline": undefined, "properties": { "channel": "optional", "channel_id": "optional", @@ -4073,6 +4215,7 @@ This field is present only if the product has usage-based billing configured.", }, "SlackOAuthV2ResponseAuthedUser": { "docs": undefined, + "inline": undefined, "properties": { "access_token": "optional", "expires_in": "optional", @@ -4087,6 +4230,7 @@ This field is present only if the product has usage-based billing configured.", }, "SlackOAuthV2ResponseEnterprise": { "docs": undefined, + "inline": undefined, "properties": { "id": "optional", "name": "optional", @@ -4097,6 +4241,7 @@ This field is present only if the product has usage-based billing configured.", }, "SlackOAuthV2ResponseTeam": { "docs": undefined, + "inline": undefined, "properties": { "id": "optional", "name": "optional", @@ -4107,6 +4252,7 @@ This field is present only if the product has usage-based billing configured.", }, "SqlNullTime": { "docs": undefined, + "inline": undefined, "properties": { "time": "optional", "valid": { @@ -4120,6 +4266,7 @@ This field is present only if the product has usage-based billing configured.", }, "TypesEntitlement": { "docs": undefined, + "inline": undefined, "properties": { "customerIdentifier": { "docs": "The customer identifier is a handle to each unique customer in an application. @@ -4154,6 +4301,7 @@ provided by AWS Marketplace when the product listing is created.", }, "TypesUsageAllocation": { "docs": undefined, + "inline": undefined, "properties": { "allocatedUsageQuantity": { "docs": "The total quantity allocated to this bucket of usage. @@ -4173,6 +4321,7 @@ tags, this parameter can be left out.", }, "TypesUsageRecord": { "docs": undefined, + "inline": undefined, "properties": { "customerIdentifier": { "docs": "The CustomerIdentifier is obtained through the ResolveCustomer operation and @@ -4213,6 +4362,7 @@ must equal the Quantity of the UsageRecord.", }, "TypesUsageRecordResult": { "docs": undefined, + "inline": undefined, "properties": { "meteringRecordId": { "docs": "The MeteringRecordId is a unique identifier for this metering event.", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/superagent.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/superagent.json index 46f2bad87d8..44feacf2182 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/superagent.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/superagent.json @@ -262,6 +262,7 @@ "types": { "HTTPValidationError": { "docs": undefined, + "inline": undefined, "properties": { "detail": { "type": "optional>", @@ -273,6 +274,7 @@ }, "ValidationError": { "docs": undefined, + "inline": undefined, "properties": { "loc": { "type": "list", @@ -288,6 +290,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -439,6 +442,7 @@ types: - integer source: openapi: ../openapi.yml + inline: true ValidationError: properties: loc: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/switchboard.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/switchboard.json index 0695f1d3262..a1ceab6b0ca 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/switchboard.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/switchboard.json @@ -85,6 +85,7 @@ "types": { "ClientProvidedResponseMetadata": { "docs": undefined, + "inline": undefined, "properties": { "clientRequestId": "optional", "timeThresholdMs": "optional", @@ -95,6 +96,7 @@ }, "DefaultMetaWrapper": { "docs": undefined, + "inline": undefined, "properties": { "requestId": "optional", }, @@ -104,6 +106,7 @@ }, "ErrorEnvelope": { "docs": undefined, + "inline": undefined, "properties": { "HttpStatus": "long", "Message": "string", @@ -118,6 +121,7 @@ }, "ErrorMessage": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Error code", @@ -138,6 +142,7 @@ }, "ExtensionV1": { "docs": undefined, + "inline": undefined, "properties": { "date_created": { "docs": "Date the extension was created", @@ -168,6 +173,7 @@ }, "ExtensionV1EnvelopeDefaultMetaWrapper": { "docs": undefined, + "inline": undefined, "properties": { "data": "ExtensionV1", "errors": "optional>", @@ -180,6 +186,7 @@ }, "ExternalSessionAiResponseMetadata": { "docs": undefined, + "inline": undefined, "properties": { "clientProvided": "optional", "requestId": "optional", @@ -202,6 +209,7 @@ }, "ExternalSessionAiResponseMetadataUsage": { "docs": undefined, + "inline": undefined, "properties": { "credits": { "docs": "The credit usage for this request", @@ -218,6 +226,7 @@ }, "Issue": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Issue code", @@ -238,6 +247,7 @@ }, "ListExtensionV1EnvelopeDefaultMetaWrapper": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional>", "errors": "optional>", @@ -250,6 +260,7 @@ }, "ListProfileV1EnvelopeDefaultMetaWrapper": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional>", "errors": "optional>", @@ -262,6 +273,7 @@ }, "LiveViewConnectionInfo": { "docs": undefined, + "inline": undefined, "properties": { "airtop_browser_url": { "docs": "Websocket url to connect to the airtop browser", @@ -278,6 +290,7 @@ }, "ModelResponse": { "docs": undefined, + "inline": undefined, "properties": { "modelResponse": "string", }, @@ -287,6 +300,7 @@ }, "ModelResponseExternalSessionAiResponseMetadataWrapper": { "docs": undefined, + "inline": undefined, "properties": { "data": "ModelResponse", "errors": "optional>", @@ -299,6 +313,7 @@ }, "Pagination": { "docs": undefined, + "inline": undefined, "properties": { "currentLimit": "long", "currentPage": "long", @@ -315,6 +330,7 @@ }, "ProfileV1": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "Name of the profile", @@ -351,6 +367,7 @@ }, "ProfileV1EnvelopeDefaultMetaWrapper": { "docs": undefined, + "inline": undefined, "properties": { "data": "ProfileV1", "errors": "optional>", @@ -363,6 +380,7 @@ }, "ScrapeModelResponse": { "docs": undefined, + "inline": undefined, "properties": { "modelResponse": "ScrapeResponseOutput", }, @@ -372,6 +390,7 @@ }, "ScrapeModelResponseExternalSessionAiResponseMetadataWrapper": { "docs": undefined, + "inline": undefined, "properties": { "data": "ScrapeModelResponse", "errors": "optional>", @@ -384,6 +403,7 @@ }, "ScrapeResponseContent": { "docs": undefined, + "inline": undefined, "properties": { "contentType": { "docs": "The mime type of content extracted from the browser window", @@ -400,6 +420,7 @@ }, "ScrapeResponseOutput": { "docs": undefined, + "inline": undefined, "properties": { "scrapedContent": { "docs": "The scraped content of the browser window", @@ -420,6 +441,7 @@ }, "SessionConfig": { "docs": undefined, + "inline": undefined, "properties": { "persist_profile": { "docs": "Persist the profile", @@ -456,6 +478,7 @@ }, "SessionConfigV1": { "docs": undefined, + "inline": undefined, "properties": { "persist_profile": { "docs": "Persist the profile", @@ -492,6 +515,7 @@ }, "SessionWithConnectionInfo": { "docs": undefined, + "inline": undefined, "properties": { "cdp_url": { "docs": "Url to connect to chrome devtools protocol port on the airtop browser. Include the header 'Authorization: Bearer .'", @@ -550,6 +574,7 @@ }, "SessionWithConnectionInfoEnvelopeDefaultMetaWrapper": { "docs": undefined, + "inline": undefined, "properties": { "data": "SessionWithConnectionInfo", "errors": "optional>", @@ -562,6 +587,7 @@ }, "SessionsWithPagination": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Pagination info", @@ -578,6 +604,7 @@ }, "SessionsWithPaginationEnvelopeDefaultMetaWrapper": { "docs": undefined, + "inline": undefined, "properties": { "data": "SessionsWithPagination", "errors": "optional>", @@ -590,6 +617,7 @@ }, "StatusMessage": { "docs": undefined, + "inline": undefined, "properties": { "event": { "docs": "Event name", @@ -626,6 +654,7 @@ }, "Window": { "docs": undefined, + "inline": undefined, "properties": { "liveViewUrl": { "docs": "Url for live view session", @@ -646,6 +675,7 @@ }, "WindowEnvelopeDefaultMetaWrapper": { "docs": undefined, + "inline": undefined, "properties": { "data": "Window", "errors": "optional>", @@ -2412,6 +2442,7 @@ service: }, "SessionsEventsResponseError": { "docs": undefined, + "inline": true, "properties": { "data": "root.ErrorMessage", "id": { @@ -2429,6 +2460,7 @@ service: }, "SessionsEventsResponseStatus": { "docs": undefined, + "inline": true, "properties": { "data": "root.StatusMessage", "id": { @@ -2479,6 +2511,7 @@ service: docs: The retry time in milliseconds. source: openapi: ../openapi.yml + inline: true SessionsEventsResponseError: properties: data: root.ErrorMessage @@ -2490,6 +2523,7 @@ service: docs: The retry time in milliseconds. source: openapi: ../openapi.yml + inline: true SessionsEventsResponse: discriminant: event base-properties: {} diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/uint.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/uint.json index 9b212e39608..4f6a0945092 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/uint.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/uint.json @@ -56,6 +56,7 @@ "Response": { "docs": "A generic response type used throughout the API. ", + "inline": undefined, "properties": { "id": "optional", "value": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/union-extension.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/union-extension.json index 899a6b98447..2cd36da9bf4 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/union-extension.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/union-extension.json @@ -8,6 +8,7 @@ "types": { "CounterPartyAccount": { "docs": undefined, + "inline": undefined, "properties": { "currency": "optional", "iban": "optional", @@ -19,6 +20,7 @@ }, "IbanField": { "docs": undefined, + "inline": undefined, "properties": { "iban": "optional", }, @@ -28,6 +30,7 @@ }, "Other": { "docs": undefined, + "inline": undefined, "properties": { "identification": "optional", "schemeNameCone": "optional", @@ -38,6 +41,7 @@ }, "OtherField": { "docs": undefined, + "inline": undefined, "properties": { "other": "optional", }, @@ -49,6 +53,7 @@ "discriminated": false, "docs": "PartyAccount with excluded currency in response", "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/unions-v1.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/unions-v1.json index fe864f4bcbb..76bed63af51 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/unions-v1.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/unions-v1.json @@ -8,6 +8,7 @@ "types": { "EnticingTitle": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/uploadcare.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/uploadcare.json index bbb088c9c6a..5773676cd25 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/uploadcare.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/uploadcare.json @@ -878,6 +878,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -906,6 +907,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -924,6 +926,7 @@ }, "ContentInfo": { "docs": "Information about file content.", + "inline": undefined, "properties": { "image": "optional", "mime": { @@ -938,6 +941,7 @@ }, "ContentInfoMime": { "docs": "MIME type.", + "inline": true, "properties": { "mime": { "docs": "Full MIME type.", @@ -960,6 +964,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -979,6 +984,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -1045,6 +1051,7 @@ See [signed uploads](https://uploadcare.com/docs/security/secure-uploads/) for d }, "FileUploadInfo": { "docs": "Information about an uploaded file.", + "inline": undefined, "properties": { "content_info": "optional", "done": { @@ -1117,6 +1124,7 @@ See [signed uploads](https://uploadcare.com/docs/security/secure-uploads/) for d }, "FileUploadInfoErrorStatus": { "docs": undefined, + "inline": undefined, "properties": { "error": { "docs": "Human readable description of the issue with the fetch/upload task. @@ -1146,6 +1154,7 @@ page for a full list of all possible error codes. "extends": [ "FileUploadInfo", ], + "inline": undefined, "properties": { "type": "optional>", }, @@ -1155,6 +1164,7 @@ page for a full list of all possible error codes. }, "FileUploadInfoProgressStatus": { "docs": undefined, + "inline": undefined, "properties": { "done": { "docs": "How many bytes of the file have been fetched so far. @@ -1184,6 +1194,7 @@ example, [compressed form](https://developer.mozilla.org/en-US/docs/Web/HTTP/Hea "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -1197,6 +1208,7 @@ example, [compressed form](https://developer.mozilla.org/en-US/docs/Web/HTTP/Hea "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -1210,6 +1222,7 @@ example, [compressed form](https://developer.mozilla.org/en-US/docs/Web/HTTP/Hea "extends": [ "FileUploadInfo", ], + "inline": undefined, "properties": { "status": { "docs": "The file has been fetched/uploaded successfully.", @@ -1222,6 +1235,7 @@ example, [compressed form](https://developer.mozilla.org/en-US/docs/Web/HTTP/Hea }, "FileUploadInfoUnknownStatus": { "docs": undefined, + "inline": undefined, "properties": { "status": { "docs": "The system does not have information about the task. @@ -1239,6 +1253,7 @@ that are tool old (or that have not been created at all). }, "FileUploadInfoWaitingStatus": { "docs": undefined, + "inline": undefined, "properties": { "status": { "docs": "The system is preparing to handle the request. @@ -1254,6 +1269,7 @@ that are tool old (or that have not been created at all). "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -1266,6 +1282,7 @@ that are tool old (or that have not been created at all). "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -1281,6 +1298,7 @@ that are tool old (or that have not been created at all). "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -1314,6 +1332,7 @@ that are tool old (or that have not been created at all). "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -1332,6 +1351,7 @@ that are tool old (or that have not been created at all). }, "FromUrlUploadResponseSchema": { "docs": "`/from_url/` upload response.", + "inline": undefined, "properties": { "token": { "docs": "Token to identify a `/from_url/` request.", @@ -1363,6 +1383,7 @@ that are tool old (or that have not been created at all). }, "GroupInfo": { "docs": "File group information object.", + "inline": undefined, "properties": { "cdn_url": { "docs": "Group's CDN URL.", @@ -1419,6 +1440,7 @@ that are tool old (or that have not been created at all). }, "ImageInfo": { "docs": "Image metadata.", + "inline": undefined, "properties": { "color_mode": { "docs": "Image color mode.", @@ -1489,6 +1511,7 @@ that are tool old (or that have not been created at all). }, "ImageInfoGeoLocation": { "docs": "Geo-location of image from EXIF.", + "inline": true, "properties": { "latitude": { "docs": "Location latitude.", @@ -1505,6 +1528,7 @@ that are tool old (or that have not been created at all). }, "LegacyVideoInfo": { "docs": "Video metadata.", + "inline": undefined, "properties": { "audio": { "docs": "Audio stream's metadata.", @@ -1533,6 +1557,7 @@ that are tool old (or that have not been created at all). }, "LegacyVideoInfoAudio": { "docs": "Audio stream's metadata.", + "inline": true, "properties": { "bitrate": { "docs": "Audio stream's bitrate.", @@ -1557,6 +1582,7 @@ that are tool old (or that have not been created at all). }, "LegacyVideoInfoVideo": { "docs": "Video stream's metadata.", + "inline": true, "properties": { "bitrate": { "docs": "Video stream's bitrate.", @@ -1618,6 +1644,7 @@ See [docs](https://uploadcare.com/docs/file-metadata/) and [REST API v0.7](/api- "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -1639,6 +1666,7 @@ See [docs](https://uploadcare.com/docs/file-metadata/) and [REST API v0.7](/api- "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -1651,6 +1679,7 @@ See [docs](https://uploadcare.com/docs/file-metadata/) and [REST API v0.7](/api- "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -1682,6 +1711,7 @@ See [docs](https://uploadcare.com/docs/file-metadata/) and [REST API v0.7](/api- "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -1743,6 +1773,7 @@ See [docs](https://uploadcare.com/docs/file-metadata/) and [REST API v0.7](/api- }, "SchemasImageInfo": { "docs": "Image metadata.", + "inline": undefined, "properties": { "color_mode": { "docs": "Image color mode.", @@ -1813,6 +1844,7 @@ See [docs](https://uploadcare.com/docs/file-metadata/) and [REST API v0.7](/api- }, "SchemasImageInfoGeoLocation": { "docs": "Geo-location of image from EXIF.", + "inline": true, "properties": { "latitude": { "docs": "Location latitude.", @@ -1926,6 +1958,7 @@ change the value to `auto`. }, "VideoInfo": { "docs": "Video metadata.", + "inline": undefined, "properties": { "audio": "list", "bitrate": { @@ -1948,6 +1981,7 @@ change the value to `auto`. }, "VideoInfoAudioItem": { "docs": "Audio stream's metadata.", + "inline": true, "properties": { "bitrate": { "docs": "Audio stream's bitrate.", @@ -1972,6 +2006,7 @@ change the value to `auto`. }, "VideoInfoVideoItem": { "docs": "Video stream's metadata.", + "inline": true, "properties": { "bitrate": { "docs": "Video stream's bitrate.", @@ -2619,6 +2654,7 @@ change the value to `auto`. docs: Location longitude. source: openapi: ../openapi.json + inline: true ImageInfo: docs: Image metadata. properties: @@ -2673,6 +2709,7 @@ change the value to `auto`. docs: Audio stream's number of channels. source: openapi: ../openapi.json + inline: true LegacyVideoInfoVideo: docs: Video stream's metadata. properties: @@ -2693,6 +2730,7 @@ change the value to `auto`. docs: Video stream codec. source: openapi: ../openapi.json + inline: true LegacyVideoInfo: docs: Video metadata. properties: @@ -2740,6 +2778,7 @@ change the value to `auto`. docs: Location longitude. source: openapi: ../openapi.json + inline: true SchemasImageInfo: docs: Image metadata. properties: @@ -2794,6 +2833,7 @@ change the value to `auto`. docs: Audio stream's number of channels. source: openapi: ../openapi.json + inline: true VideoInfoVideoItem: docs: Video stream's metadata. properties: @@ -2814,6 +2854,7 @@ change the value to `auto`. docs: Video stream's codec. source: openapi: ../openapi.json + inline: true VideoInfo: docs: Video metadata. properties: @@ -2844,6 +2885,7 @@ change the value to `auto`. docs: Subtype of MIME type. source: openapi: ../openapi.json + inline: true ContentInfo: docs: Information about file content. properties: @@ -6107,6 +6149,7 @@ to us as a value of the `part_size` parameter (in bytes). "docs": "JSON object where the key is the file name of the uploaded file and the value is the unique ID of the file on our systems. ", + "inline": undefined, "properties": { "filename": { "type": "optional", @@ -6165,6 +6208,7 @@ to the value of the `check_URL_duplicates` parameter. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -6177,6 +6221,7 @@ to the value of the `check_URL_duplicates` parameter. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -6190,6 +6235,7 @@ to the value of the `check_URL_duplicates` parameter. }, "MultipartFileUploadStartResponse": { "docs": undefined, + "inline": undefined, "properties": { "parts": "list", "uuid": { diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/valtown.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/valtown.json index cb5e76975ef..89e122cf6a8 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/valtown.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/valtown.json @@ -86,6 +86,7 @@ "types": { "BasicVal": { "docs": "A Val", + "inline": undefined, "properties": { "author": { "docs": "The user who created this val", @@ -151,6 +152,7 @@ }, "BasicValAuthor": { "docs": "The user who created this val", + "inline": true, "properties": { "id": { "type": "string", @@ -169,6 +171,7 @@ }, "BasicValLinks": { "docs": undefined, + "inline": true, "properties": { "module": { "docs": "The URL of this Val’s source code as a module", @@ -233,6 +236,7 @@ }, "EmailsSendRequestInternalServerErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "error": "string", }, @@ -242,6 +246,7 @@ }, "EvalGetRequestBadRequestErrorBody": { "docs": "The function throw an error or had invalid syntax", + "inline": undefined, "properties": { "error": "string", "type": "literal<"error">", @@ -252,6 +257,7 @@ }, "EvalPostRequestBadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "error": "string", "type": "literal<"error">", @@ -262,6 +268,7 @@ }, "ExtendedVal": { "docs": "A Val", + "inline": undefined, "properties": { "author": { "docs": "The user who created this val", @@ -352,6 +359,7 @@ }, "ExtendedValAuthor": { "docs": "The user who created this val", + "inline": true, "properties": { "id": { "type": "string", @@ -370,6 +378,7 @@ }, "ExtendedValLinks": { "docs": undefined, + "inline": true, "properties": { "module": { "docs": "The URL of this Val’s source code as a module", @@ -434,6 +443,7 @@ }, "PaginationLinks": { "docs": "Links to use for pagination", + "inline": undefined, "properties": { "next": { "docs": "URL of the next page, if any", @@ -472,6 +482,7 @@ }, "ResultSet": { "docs": "Result of executing an SQL statement.", + "inline": undefined, "properties": { "columnTypes": { "docs": "Types of columns. @@ -516,6 +527,7 @@ This value is not specified for other SQL statements.", This value is not specified if the SQL statement was not an INSERT or if the table was not a ROWID table.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -526,6 +538,7 @@ This value is not specified if the SQL statement was not an INSERT or if the tab }, "User": { "docs": "User object", + "inline": undefined, "properties": { "bio": { "docs": "The user’s biography, if they have provided one", @@ -573,6 +586,7 @@ This value is not specified if the SQL statement was not an INSERT or if the tab }, "UserLinks": { "docs": undefined, + "inline": true, "properties": { "self": { "docs": "URL of this user on this API", @@ -619,6 +633,7 @@ This value is not specified if the SQL statement was not an INSERT or if the tab format: uri source: openapi: ../openapi.yml + inline: true User: docs: User object properties: @@ -661,6 +676,7 @@ This value is not specified if the SQL statement was not an INSERT or if the tab - double source: openapi: ../openapi.yml + inline: true ResultSet: docs: Result of executing an SQL statement. properties: @@ -748,6 +764,7 @@ This value is not specified if the SQL statement was not an INSERT or if the tab format: uri source: openapi: ../openapi.yml + inline: true ExtendedValAuthor: docs: The user who created this val properties: @@ -758,6 +775,7 @@ This value is not specified if the SQL statement was not an INSERT or if the tab username: optional source: openapi: ../openapi.yml + inline: true ExtendedVal: docs: A Val properties: @@ -859,6 +877,7 @@ This value is not specified if the SQL statement was not an INSERT or if the tab format: uri source: openapi: ../openapi.yml + inline: true BasicValAuthor: docs: The user who created this val properties: @@ -869,6 +888,7 @@ This value is not specified if the SQL statement was not an INSERT or if the tab username: optional source: openapi: ../openapi.yml + inline: true BasicVal: docs: A Val properties: @@ -1103,6 +1123,7 @@ API endpoints", "types": { "AliasValResponse": { "docs": "A Val", + "inline": undefined, "properties": { "author": { "docs": "The user who created this val", @@ -1193,6 +1214,7 @@ API endpoints", }, "AliasValResponseAuthor": { "docs": "The user who created this val", + "inline": true, "properties": { "id": { "type": "string", @@ -1211,6 +1233,7 @@ API endpoints", }, "AliasValResponseLinks": { "docs": undefined, + "inline": true, "properties": { "module": { "docs": "The URL of this Val’s source code as a module", @@ -1403,6 +1426,7 @@ types: format: uri source: openapi: ../openapi.yml + inline: true AliasValResponseAuthor: docs: The user who created this val properties: @@ -1413,6 +1437,7 @@ types: username: optional source: openapi: ../openapi.yml + inline: true AliasValResponse: docs: A Val properties: @@ -1605,6 +1630,7 @@ types: "types": { "BlobListingItem": { "docs": undefined, + "inline": undefined, "properties": { "key": "string", "lastModified": { @@ -1811,6 +1837,7 @@ docs: Blobs "types": { "AttachmentObject": { "docs": undefined, + "inline": true, "properties": { "content": "string", "contentId": { @@ -1832,6 +1859,7 @@ docs: Blobs "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1847,6 +1875,7 @@ docs: Blobs "discriminated": false, "docs": "A single email or list of emails for one of the address fields", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1862,6 +1891,7 @@ docs: Blobs }, "EmailNameAndAddress": { "docs": "An email address and name", + "inline": true, "properties": { "email": "string", "name": { @@ -1874,6 +1904,7 @@ docs: Blobs }, "EmailsSendResponse": { "docs": "Successfully sent email", + "inline": undefined, "properties": { "message": "string", }, @@ -1885,6 +1916,7 @@ docs: Blobs "discriminated": false, "docs": "A reply-to list of email addresses", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1909,6 +1941,7 @@ docs: Blobs email: string source: openapi: ../openapi.yml + inline: true EmailData: discriminated: false union: @@ -1917,6 +1950,7 @@ docs: Blobs docs: An email address and name source: openapi: ../openapi.yml + inline: true EmailDataInput: discriminated: false docs: A single email or list of emails for one of the address fields @@ -1926,6 +1960,7 @@ docs: Blobs - type: list source: openapi: ../openapi.yml + inline: true AttachmentObject: properties: content: string @@ -1938,6 +1973,7 @@ docs: Blobs type: optional source: openapi: ../openapi.yml + inline: true ReplyToList: discriminated: false docs: A reply-to list of email addresses @@ -1947,6 +1983,7 @@ docs: Blobs - type: list source: openapi: ../openapi.yml + inline: true EmailsSendResponse: docs: Successfully sent email properties: @@ -2327,6 +2364,7 @@ give access to details and data from the requesting user.", }, "MeCommentsResponse": { "docs": "A paginated result set", + "inline": undefined, "properties": { "data": "list", "links": "root.PaginationLinks", @@ -2337,6 +2375,7 @@ give access to details and data from the requesting user.", }, "MeCommentsResponseDataItem": { "docs": undefined, + "inline": true, "properties": { "author": "MeCommentsResponseDataItemAuthor", "comment": { @@ -2362,6 +2401,7 @@ give access to details and data from the requesting user.", }, "MeCommentsResponseDataItemAuthor": { "docs": undefined, + "inline": true, "properties": { "id": { "type": "string", @@ -2380,6 +2420,7 @@ give access to details and data from the requesting user.", }, "MeCommentsResponseDataItemVal": { "docs": undefined, + "inline": true, "properties": { "author": { "docs": "The user who created this val", @@ -2419,6 +2460,7 @@ give access to details and data from the requesting user.", }, "MeCommentsResponseDataItemValAuthor": { "docs": "The user who created this val", + "inline": true, "properties": { "id": { "type": "string", @@ -2448,6 +2490,7 @@ give access to details and data from the requesting user.", }, "MeGetResponse": { "docs": "Your user information, with tier and email included", + "inline": undefined, "properties": { "bio": { "docs": "The user’s biography, if they have provided one", @@ -2503,6 +2546,7 @@ give access to details and data from the requesting user.", }, "MeGetResponseLinks": { "docs": undefined, + "inline": true, "properties": { "self": { "docs": "URL of this user on this API", @@ -2531,6 +2575,7 @@ give access to details and data from the requesting user.", }, "MeLikesResponse": { "docs": "A paginated result set", + "inline": undefined, "properties": { "data": "list", "links": "root.PaginationLinks", @@ -2541,6 +2586,7 @@ give access to details and data from the requesting user.", }, "MeReferencesResponse": { "docs": "A paginated result set", + "inline": undefined, "properties": { "data": "list", "links": "root.PaginationLinks", @@ -2551,6 +2597,7 @@ give access to details and data from the requesting user.", }, "MeReferencesResponseDataItem": { "docs": "A description of a dependency from one val (reference) to another (dependsOn) that was introduced at a particular time.", + "inline": true, "properties": { "dependsOn": { "docs": "A val in a dependency relationship", @@ -2568,6 +2615,7 @@ give access to details and data from the requesting user.", }, "MeReferencesResponseDataItemDependsOn": { "docs": "A val in a dependency relationship", + "inline": true, "properties": { "author_id": { "docs": "The ID of the person who authored this val", @@ -2604,6 +2652,7 @@ give access to details and data from the requesting user.", }, "MeReferencesResponseDataItemReference": { "docs": "A val in a dependency relationship", + "inline": true, "properties": { "author_id": { "docs": "The ID of the person who authored this val", @@ -2650,6 +2699,7 @@ give access to details and data from the requesting user.", format: uri source: openapi: ../openapi.yml + inline: true MeGetResponseTier: enum: - free @@ -2716,6 +2766,7 @@ give access to details and data from the requesting user.", username: optional source: openapi: ../openapi.yml + inline: true MeCommentsResponseDataItemValPrivacy: enum: - public @@ -2736,6 +2787,7 @@ give access to details and data from the requesting user.", username: optional source: openapi: ../openapi.yml + inline: true MeCommentsResponseDataItemVal: properties: name: @@ -2759,6 +2811,7 @@ give access to details and data from the requesting user.", docs: The user who created this val source: openapi: ../openapi.yml + inline: true MeCommentsResponseDataItem: properties: comment: @@ -2774,6 +2827,7 @@ give access to details and data from the requesting user.", val: MeCommentsResponseDataItemVal source: openapi: ../openapi.yml + inline: true MeCommentsResponse: docs: A paginated result set properties: @@ -2802,6 +2856,7 @@ give access to details and data from the requesting user.", docs: The name of this val source: openapi: ../openapi.yml + inline: true MeReferencesResponseDataItemDependsOn: docs: A val in a dependency relationship properties: @@ -2823,6 +2878,7 @@ give access to details and data from the requesting user.", docs: The name of this val source: openapi: ../openapi.yml + inline: true MeReferencesResponseDataItem: docs: >- A description of a dependency from one val (reference) to another @@ -2837,6 +2893,7 @@ give access to details and data from the requesting user.", referencedAt: datetime source: openapi: ../openapi.yml + inline: true MeReferencesResponse: docs: A paginated result set properties: @@ -3145,6 +3202,7 @@ imports: "types": { "SearchValsResponse": { "docs": "A paginated result set", + "inline": undefined, "properties": { "data": "list", "links": "root.PaginationLinks", @@ -3392,6 +3450,7 @@ docs: Search "types": { "ParameterizedQuery": { "docs": "A parameterized SQL query. See https://docs.turso.tech/sdk/ts/reference#batch-transactions for reference", + "inline": true, "properties": { "args": { "display-name": "StatementArg", @@ -3421,6 +3480,7 @@ docs: Search "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3439,6 +3499,7 @@ docs: Search "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3457,6 +3518,7 @@ docs: Search "discriminated": false, "docs": "List of arguments to be used in the given statement", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3469,6 +3531,7 @@ docs: Search "discriminated": false, "docs": "A value to be used as a parameter", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3490,6 +3553,7 @@ docs: Search - boolean source: openapi: ../openapi.yml + inline: true StatementArg: discriminated: false docs: List of arguments to be used in the given statement @@ -3498,6 +3562,7 @@ docs: Search - map> source: openapi: ../openapi.yml + inline: true ParameterizedQuery: docs: >- A parameterized SQL query. See @@ -3512,6 +3577,7 @@ docs: Search docs: List of arguments to be used in the given statement source: openapi: ../openapi.yml + inline: true SqliteExecuteRequestStatement: discriminated: false union: @@ -3524,6 +3590,7 @@ docs: Search reference source: openapi: ../openapi.yml + inline: true SqliteBatchRequestStatementsItem: discriminated: false union: @@ -3536,6 +3603,7 @@ docs: Search reference source: openapi: ../openapi.yml + inline: true SqliteBatchRequestMode: enum: - write @@ -3781,6 +3849,7 @@ docs: SQLite "types": { "UsersValsResponse": { "docs": "A paginated result set", + "inline": undefined, "properties": { "data": "list", "links": "root.PaginationLinks", @@ -4740,6 +4809,7 @@ let you get, create, and run vals.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -4755,6 +4825,7 @@ let you get, create, and run vals.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -4768,6 +4839,7 @@ let you get, create, and run vals.", }, "ValsCancelResponse": { "docs": "The evaluation_id was successfully searched for and the evaluation was either already done or now has been cancelled", + "inline": undefined, "properties": { "found": { "docs": "True if the evaluation was found and cancelled", @@ -4826,6 +4898,7 @@ let you get, create, and run vals.", }, "ValsListResponse": { "docs": "A paginated result set", + "inline": undefined, "properties": { "data": "list", "links": "root.PaginationLinks", @@ -4836,6 +4909,7 @@ let you get, create, and run vals.", }, "ValsListResponseDataItem": { "docs": undefined, + "inline": true, "properties": { "createdAt": "datetime", "val_id": { @@ -4965,6 +5039,7 @@ let you get, create, and run vals.", createdAt: datetime source: openapi: ../openapi.yml + inline: true ValsListResponse: docs: A paginated result set properties: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/vellum.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/vellum.json index 4165199b999..55d38ec4f57 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/vellum.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/vellum.json @@ -761,6 +761,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ChatMessage": { "docs": undefined, + "inline": undefined, "properties": { "role": "ChatMessageRole", "text": "string", @@ -771,6 +772,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ChatMessageRequest": { "docs": undefined, + "inline": undefined, "properties": { "role": "ChatMessageRole", "text": "string", @@ -796,6 +798,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ConditionalNodeResult": { "docs": undefined, + "inline": undefined, "properties": { "data": "ConditionalNodeResultData", }, @@ -805,6 +808,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ConditionalNodeResultData": { "docs": undefined, + "inline": undefined, "properties": { "source_handle_id": "optional", }, @@ -825,6 +829,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "DeploymentNodeResult": { "docs": undefined, + "inline": undefined, "properties": { "data": "DeploymentNodeResultData", }, @@ -834,6 +839,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "DeploymentNodeResultData": { "docs": undefined, + "inline": undefined, "properties": { "delta": "optional", "output_id": "string", @@ -845,6 +851,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "DeploymentRead": { "docs": undefined, + "inline": undefined, "properties": { "active_model_version_ids": "list", "created": "datetime", @@ -921,6 +928,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "Document": { "docs": undefined, + "inline": undefined, "properties": { "external_id": { "docs": "The unique ID of the document as represented in an external system and specified when it was originally uploaded.", @@ -959,6 +967,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "DocumentDocumentToDocumentIndex": { "docs": undefined, + "inline": undefined, "properties": { "document_index_id": { "docs": "Vellum-generated ID that uniquely identifies the index this document is included in.", @@ -997,6 +1006,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "DocumentIndexRead": { "docs": undefined, + "inline": undefined, "properties": { "created": "datetime", "environment": { @@ -1065,6 +1075,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "EnrichedNormalizedCompletion": { "docs": undefined, + "inline": undefined, "properties": { "external_id": { "docs": "The external ID that was originally provided along with the generation request, which uniquely identifies this generation in an external system.", @@ -1121,6 +1132,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "EvaluationParams": { "docs": undefined, + "inline": undefined, "properties": { "target": { "docs": "The target value to compare the LLM output against. Typically what you expect or desire the LLM output to be.", @@ -1133,6 +1145,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "EvaluationParamsRequest": { "docs": undefined, + "inline": undefined, "properties": { "target": { "docs": "The target value to compare the LLM output against. Typically what you expect or desire the LLM output to be.", @@ -1158,6 +1171,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "GenerateErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "detail": { "docs": "Details about why the request failed.", @@ -1170,6 +1184,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "GenerateOptionsRequest": { "docs": undefined, + "inline": undefined, "properties": { "logprobs": { "docs": "Which logprobs to include, if any. Defaults to NONE. @@ -1185,6 +1200,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "GenerateRequest": { "docs": undefined, + "inline": undefined, "properties": { "chat_history": { "docs": "Optionally provide a list of chat messages that'll be used in place of the special {$chat_history} variable, if included in the prompt.", @@ -1205,6 +1221,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "GenerateResponse": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "The results of each generation request.", @@ -1217,6 +1234,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "GenerateResult": { "docs": undefined, + "inline": undefined, "properties": { "data": { "docs": "An object containing the resulting generation. This key will be absent if the LLM provider experienced an error.", @@ -1233,6 +1251,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "GenerateResultData": { "docs": undefined, + "inline": undefined, "properties": { "completions": { "docs": "The generated completions. This will generally be a list of length one.", @@ -1245,6 +1264,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "GenerateResultError": { "docs": undefined, + "inline": undefined, "properties": { "message": { "docs": "The error message returned by the LLM provider.", @@ -1257,6 +1277,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "GenerateStreamResponse": { "docs": undefined, + "inline": undefined, "properties": { "delta": "GenerateStreamResult", }, @@ -1266,6 +1287,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "GenerateStreamResult": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional", "error": "optional", @@ -1277,6 +1299,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "GenerateStreamResultData": { "docs": undefined, + "inline": undefined, "properties": { "completion": "EnrichedNormalizedCompletion", "completion_index": "integer", @@ -1326,6 +1349,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ModelVersionBuildConfig": { "docs": undefined, + "inline": undefined, "properties": { "base_model": { "docs": "The name of the base model used to create this model version, as identified by the LLM provider.", @@ -1342,6 +1366,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ModelVersionCompilePromptResponse": { "docs": undefined, + "inline": undefined, "properties": { "prompt": { "docs": "Information about the compiled prompt.", @@ -1354,6 +1379,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ModelVersionCompiledPrompt": { "docs": undefined, + "inline": undefined, "properties": { "num_tokens": { "docs": "The approximate number of tokens used by the compiled prompt.", @@ -1377,6 +1403,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ModelVersionExecConfig": { "docs": undefined, + "inline": undefined, "properties": { "input_variables": { "docs": "Names of the input variables specified in the prompt template.", @@ -1399,6 +1426,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ModelVersionExecConfigParameters": { "docs": undefined, + "inline": undefined, "properties": { "frequency_penalty": "double", "logit_bias": "optional>>", @@ -1415,6 +1443,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ModelVersionRead": { "docs": undefined, + "inline": undefined, "properties": { "build_config": { "docs": "Configuration used to build this model version.", @@ -1501,6 +1530,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ModelVersionSandboxSnapshot": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the sandbox snapshot.", @@ -1529,6 +1559,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "NormalizedLogProbs": { "docs": undefined, + "inline": undefined, "properties": { "likelihood": "optional", "tokens": "list", @@ -1539,6 +1570,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "NormalizedTokenLogProbs": { "docs": undefined, + "inline": undefined, "properties": { "logprob": "optional", "text_offset": "integer", @@ -1551,6 +1583,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "PaginatedSlimDocumentList": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "next": { @@ -1598,6 +1631,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "PromptNodeResult": { "docs": undefined, + "inline": undefined, "properties": { "data": "PromptNodeResultData", }, @@ -1607,6 +1641,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "PromptNodeResultData": { "docs": undefined, + "inline": undefined, "properties": { "delta": "optional", "output_id": "string", @@ -1618,6 +1653,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "PromptTemplateBlock": { "docs": undefined, + "inline": undefined, "properties": { "block_type": "BlockTypeEnum", "id": "string", @@ -1629,6 +1665,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "PromptTemplateBlockData": { "docs": undefined, + "inline": undefined, "properties": { "blocks": "list", "version": "integer", @@ -1639,6 +1676,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "PromptTemplateBlockDataRequest": { "docs": undefined, + "inline": undefined, "properties": { "blocks": "list", "version": "integer", @@ -1649,6 +1687,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "PromptTemplateBlockProperties": { "docs": undefined, + "inline": undefined, "properties": { "blocks": "optional>", "chat_message_unterminated": { @@ -1668,6 +1707,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "PromptTemplateBlockPropertiesRequest": { "docs": undefined, + "inline": undefined, "properties": { "blocks": "optional>", "chat_message_unterminated": { @@ -1703,6 +1743,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "PromptTemplateBlockRequest": { "docs": undefined, + "inline": undefined, "properties": { "block_type": "BlockTypeEnum", "id": { @@ -1722,6 +1763,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "PromptTemplateInputVariable": { "docs": undefined, + "inline": undefined, "properties": { "key": { "docs": "The name of the input variable.", @@ -1734,6 +1776,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "PromptTemplateInputVariableRequest": { "docs": undefined, + "inline": undefined, "properties": { "key": { "docs": "The name of the input variable.", @@ -1775,6 +1818,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "RegisterPromptErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "detail": { "docs": "Details about why the request failed.", @@ -1787,6 +1831,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "RegisterPromptModelParametersRequest": { "docs": undefined, + "inline": undefined, "properties": { "frequency_penalty": "double", "logit_bias": "optional>>", @@ -1803,6 +1848,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "RegisterPromptPrompt": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the generated prompt.", @@ -1819,6 +1865,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "RegisterPromptPromptInfoRequest": { "docs": undefined, + "inline": undefined, "properties": { "input_variables": { "docs": "Names of the input variables specified in the prompt template.", @@ -1836,6 +1883,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "RegisterPromptResponse": { "docs": undefined, + "inline": undefined, "properties": { "deployment": { "docs": "Information about the generated deployment", @@ -1864,6 +1912,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "RegisteredPromptDeployment": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the generated deployment.", @@ -1884,6 +1933,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "RegisteredPromptModelVersion": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the generated model version.", @@ -1900,6 +1950,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "RegisteredPromptSandbox": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the generated sandbox.", @@ -1916,6 +1967,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "RegisteredPromptSandboxSnapshot": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the generated sandbox snapshot.", @@ -1928,6 +1980,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SandboxMetricInputParams": { "docs": undefined, + "inline": undefined, "properties": { "params": "optional", }, @@ -1937,6 +1990,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SandboxMetricInputParamsRequest": { "docs": undefined, + "inline": undefined, "properties": { "params": "optional", }, @@ -1946,6 +2000,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SandboxNodeResult": { "docs": undefined, + "inline": undefined, "properties": { "data": "SandboxNodeResultData", }, @@ -1955,6 +2010,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SandboxNodeResultData": { "docs": undefined, + "inline": undefined, "properties": { "delta": "optional", "output_id": "string", @@ -1966,6 +2022,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SandboxScenario": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The id of the scenario", @@ -1987,6 +2044,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ScenarioInput": { "docs": undefined, + "inline": undefined, "properties": { "chat_history": "optional>", "key": "string", @@ -1999,6 +2057,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ScenarioInputRequest": { "docs": undefined, + "inline": undefined, "properties": { "chat_history": "optional>", "key": { @@ -2030,6 +2089,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SearchErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "detail": { "docs": "Details about why the request failed.", @@ -2042,6 +2102,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SearchFiltersRequest": { "docs": undefined, + "inline": undefined, "properties": { "external_ids": { "docs": "The document external IDs to filter by", @@ -2054,6 +2115,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SearchNodeResult": { "docs": undefined, + "inline": undefined, "properties": { "data": "SearchNodeResultData", }, @@ -2063,6 +2125,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SearchNodeResultData": { "docs": undefined, + "inline": undefined, "properties": { "results": "list>", "results_output_id": "string", @@ -2075,6 +2138,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SearchRequestOptionsRequest": { "docs": undefined, + "inline": undefined, "properties": { "filters": { "docs": "The filters to apply to the search.", @@ -2099,6 +2163,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SearchResponse": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "The results of the search. Each result represents a chunk that matches the search query.", @@ -2111,6 +2176,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SearchResult": { "docs": undefined, + "inline": undefined, "properties": { "document": { "docs": "The document that contains the chunk that matched the search query.", @@ -2132,6 +2198,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SearchResultMergingRequest": { "docs": undefined, + "inline": undefined, "properties": { "enabled": { "docs": "Whether to enable merging results", @@ -2144,6 +2211,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SearchWeightsRequest": { "docs": undefined, + "inline": undefined, "properties": { "keywords": { "docs": "The relative weight to give to keyword matches", @@ -2160,6 +2228,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SlimDocument": { "docs": undefined, + "inline": undefined, "properties": { "document_to_document_indexes": "list", "external_id": { @@ -2232,6 +2301,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SubmitCompletionActualRequest": { "docs": undefined, + "inline": undefined, "properties": { "external_id": { "docs": "The external ID that was originally provided when generating the completion that you'd now like to submit actuals for. Must provide either this or id.", @@ -2279,6 +2349,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SubmitCompletionActualsErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "detail": "string", }, @@ -2288,6 +2359,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "TerminalNodeChatHistoryResult": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "The unique name given to the terminal node that produced this output.", @@ -2301,6 +2373,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "TerminalNodeJsonResult": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "The unique name given to the terminal node that produced this output.", @@ -2314,6 +2387,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "TerminalNodeResult": { "docs": undefined, + "inline": undefined, "properties": { "data": "TerminalNodeResultData", }, @@ -2323,6 +2397,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "TerminalNodeResultData": { "docs": undefined, + "inline": undefined, "properties": { "output": "TerminalNodeResultOutput", }, @@ -2347,6 +2422,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "TerminalNodeStringResult": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "The unique name given to the terminal node that produced this output.", @@ -2360,6 +2436,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "TestSuiteTestCase": { "docs": undefined, + "inline": undefined, "properties": { "evaluation_params": { "docs": "Parameters to use when evaluating the test case, specific to the test suite's evaluation metric.", @@ -2384,6 +2461,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "UploadDocumentErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "detail": "string", }, @@ -2393,6 +2471,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "UploadDocumentResponse": { "docs": undefined, + "inline": undefined, "properties": { "document_id": { "docs": "The ID of the newly created document.", @@ -2411,6 +2490,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "WorkflowEventError": { "docs": undefined, + "inline": undefined, "properties": { "code": "WorkflowExecutionEventErrorCode", "message": "string", @@ -2432,6 +2512,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "WorkflowExecutionNodeResultEvent": { "docs": undefined, + "inline": undefined, "properties": { "data": "WorkflowNodeResultEvent", "external_id": "optional", @@ -2443,6 +2524,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "WorkflowExecutionWorkflowResultEvent": { "docs": undefined, + "inline": undefined, "properties": { "data": "WorkflowResultEvent", "external_id": "optional", @@ -2472,6 +2554,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "WorkflowNodeResultEvent": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional", "error": "optional", @@ -2502,6 +2585,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "WorkflowRequestChatHistoryInputRequest": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "The variable's name, as defined in the Workflow.", @@ -2536,6 +2620,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "WorkflowRequestJsonInputRequest": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "The variable's name, as defined in the Workflow.", @@ -2555,6 +2640,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "WorkflowRequestStringInputRequest": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "The variable's name, as defined in the Workflow.", @@ -2574,6 +2660,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "WorkflowResultEvent": { "docs": undefined, + "inline": undefined, "properties": { "error": "optional", "id": "string", @@ -2602,6 +2689,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "WorkflowResultEventOutputDataChatHistory": { "docs": undefined, + "inline": undefined, "properties": { "delta": { "docs": "The newly output string value. Only relevant for string outputs with a state of STREAMING.", @@ -2618,6 +2706,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "WorkflowResultEventOutputDataJson": { "docs": undefined, + "inline": undefined, "properties": { "delta": { "docs": "The newly output string value. Only relevant for string outputs with a state of STREAMING.", @@ -2634,6 +2723,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "WorkflowResultEventOutputDataString": { "docs": undefined, + "inline": undefined, "properties": { "delta": { "docs": "The newly output string value, meant to be concatenated with all previous. Will be non-null for events of state STREAMING.", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/webflow.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/webflow.json index c777f33b6e3..70c050afdda 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/webflow.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/webflow.json @@ -3192,6 +3192,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -3202,6 +3203,7 @@ }, "AccessGroupsListRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3216,6 +3218,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -3226,6 +3229,7 @@ }, "ActivityLogsListRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3238,6 +3242,7 @@ }, "AssetsCreateFolderRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3250,6 +3255,7 @@ }, "AssetsCreateRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3262,6 +3268,7 @@ }, "AssetsDeleteRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3274,6 +3281,7 @@ }, "AssetsGetFolderRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3286,6 +3294,7 @@ }, "AssetsGetRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3298,6 +3307,7 @@ }, "AssetsListFoldersRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3310,6 +3320,7 @@ }, "AssetsListRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3322,6 +3333,7 @@ }, "AssetsUpdateRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3334,6 +3346,7 @@ }, "CollectionsCreateRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3346,6 +3359,7 @@ }, "CollectionsDeleteRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3358,6 +3372,7 @@ }, "CollectionsGetRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3370,6 +3385,7 @@ }, "CollectionsListRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3384,6 +3400,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3394,6 +3411,7 @@ }, "ConflictErrorBodyOne": { "docs": undefined, + "inline": true, "properties": { "code": { "docs": "Error code", @@ -3420,6 +3438,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3430,6 +3449,7 @@ }, "ConflictErrorBodyZero": { "docs": undefined, + "inline": true, "properties": { "code": { "docs": "Error code", @@ -3456,6 +3476,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3466,6 +3487,7 @@ }, "DeleteCollectionRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3478,6 +3500,7 @@ }, "EcommerceGetSettingsRequestConflictErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Error code", @@ -3502,6 +3525,7 @@ }, "EcommerceGetSettingsRequestForbiddenErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "details": "optional>", "externalReference": "optional", @@ -3515,6 +3539,7 @@ }, "EcommerceGetSettingsRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3527,6 +3552,7 @@ }, "FieldsCreateRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3539,6 +3565,7 @@ }, "FieldsUpdateRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3551,6 +3578,7 @@ }, "ForbiddenErrorBodyOne": { "docs": undefined, + "inline": true, "properties": { "code": { "docs": "Error code", @@ -3577,6 +3605,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3587,6 +3616,7 @@ }, "ForbiddenErrorBodyZero": { "docs": undefined, + "inline": true, "properties": { "code": { "docs": "Error code", @@ -3613,6 +3643,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3623,6 +3654,7 @@ }, "FormsGetRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3635,6 +3667,7 @@ }, "FormsGetSubmissionRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3647,6 +3680,7 @@ }, "FormsListRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3659,6 +3693,7 @@ }, "FormsListSubmissionsRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3671,6 +3706,7 @@ }, "FormsUpdateSubmissionRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3683,6 +3719,7 @@ }, "InventoryListRequestConflictErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Error code", @@ -3707,6 +3744,7 @@ }, "InventoryListRequestForbiddenErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "details": "optional>", "externalReference": "optional", @@ -3720,6 +3758,7 @@ }, "InventoryListRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3732,6 +3771,7 @@ }, "InventoryUpdateRequestConflictErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Error code", @@ -3756,6 +3796,7 @@ }, "InventoryUpdateRequestForbiddenErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "details": "optional>", "externalReference": "optional", @@ -3769,6 +3810,7 @@ }, "InventoryUpdateRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3781,6 +3823,7 @@ }, "ItemsCreateItemForMultipleLocalesRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3793,6 +3836,7 @@ }, "ItemsCreateItemLiveRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3805,6 +3849,7 @@ }, "ItemsCreateItemRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3817,6 +3862,7 @@ }, "ItemsDeleteItemLiveRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3829,6 +3875,7 @@ }, "ItemsDeleteItemRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3841,6 +3888,7 @@ }, "ItemsGetItemLiveRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3853,6 +3901,7 @@ }, "ItemsGetItemRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3865,6 +3914,7 @@ }, "ItemsListItemsLiveRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3877,6 +3927,7 @@ }, "ItemsListItemsRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3889,6 +3940,7 @@ }, "ItemsPublishItemRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3901,6 +3953,7 @@ }, "ItemsUpdateItemLiveRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -3913,6 +3966,7 @@ }, "ItemsUpdateItemRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4047,6 +4101,7 @@ }, "OrdersGetRequestConflictErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Error code", @@ -4071,6 +4126,7 @@ }, "OrdersGetRequestForbiddenErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "details": "optional>", "externalReference": "optional", @@ -4084,6 +4140,7 @@ }, "OrdersGetRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4096,6 +4153,7 @@ }, "OrdersListRequestConflictErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Error code", @@ -4120,6 +4178,7 @@ }, "OrdersListRequestForbiddenErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "details": "optional>", "externalReference": "optional", @@ -4133,6 +4192,7 @@ }, "OrdersListRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4145,6 +4205,7 @@ }, "OrdersRefundRequestConflictErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Error code", @@ -4169,6 +4230,7 @@ }, "OrdersRefundRequestForbiddenErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "details": "optional>", "externalReference": "optional", @@ -4182,6 +4244,7 @@ }, "OrdersRefundRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4194,6 +4257,7 @@ }, "OrdersUpdateFulfillRequestConflictErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Error code", @@ -4218,6 +4282,7 @@ }, "OrdersUpdateFulfillRequestForbiddenErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "details": "optional>", "externalReference": "optional", @@ -4231,6 +4296,7 @@ }, "OrdersUpdateFulfillRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4243,6 +4309,7 @@ }, "OrdersUpdateRequestConflictErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Error code", @@ -4267,6 +4334,7 @@ }, "OrdersUpdateRequestForbiddenErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "details": "optional>", "externalReference": "optional", @@ -4280,6 +4348,7 @@ }, "OrdersUpdateRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4292,6 +4361,7 @@ }, "OrdersUpdateUnfulfillRequestConflictErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Error code", @@ -4316,6 +4386,7 @@ }, "OrdersUpdateUnfulfillRequestForbiddenErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "details": "optional>", "externalReference": "optional", @@ -4329,6 +4400,7 @@ }, "OrdersUpdateUnfulfillRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4341,6 +4413,7 @@ }, "PagesGetContentRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4353,6 +4426,7 @@ }, "PagesGetMetadataRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4365,6 +4439,7 @@ }, "PagesListRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4377,6 +4452,7 @@ }, "ProductsCreateRequestConflictErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Error code", @@ -4401,6 +4477,7 @@ }, "ProductsCreateRequestForbiddenErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "details": "optional>", "externalReference": "optional", @@ -4414,6 +4491,7 @@ }, "ProductsCreateRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4426,6 +4504,7 @@ }, "ProductsCreateSkuRequestConflictErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Error code", @@ -4450,6 +4529,7 @@ }, "ProductsCreateSkuRequestForbiddenErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "details": "optional>", "externalReference": "optional", @@ -4463,6 +4543,7 @@ }, "ProductsCreateSkuRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4475,6 +4556,7 @@ }, "ProductsGetRequestConflictErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Error code", @@ -4499,6 +4581,7 @@ }, "ProductsGetRequestForbiddenErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "details": "optional>", "externalReference": "optional", @@ -4512,6 +4595,7 @@ }, "ProductsGetRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4524,6 +4608,7 @@ }, "ProductsListRequestConflictErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Error code", @@ -4548,6 +4633,7 @@ }, "ProductsListRequestForbiddenErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "details": "optional>", "externalReference": "optional", @@ -4561,6 +4647,7 @@ }, "ProductsListRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4573,6 +4660,7 @@ }, "ProductsUpdateRequestConflictErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Error code", @@ -4597,6 +4685,7 @@ }, "ProductsUpdateRequestForbiddenErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "details": "optional>", "externalReference": "optional", @@ -4610,6 +4699,7 @@ }, "ProductsUpdateRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4622,6 +4712,7 @@ }, "ProductsUpdateSkuRequestConflictErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Error code", @@ -4646,6 +4737,7 @@ }, "ProductsUpdateSkuRequestForbiddenErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "details": "optional>", "externalReference": "optional", @@ -4659,6 +4751,7 @@ }, "ProductsUpdateSkuRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4671,6 +4764,7 @@ }, "ScriptsDeleteCustomCodeRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4683,6 +4777,7 @@ }, "ScriptsGetCustomCodeRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4695,6 +4790,7 @@ }, "ScriptsListCustomCodeBlocksRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4707,6 +4803,7 @@ }, "ScriptsListRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4719,6 +4816,7 @@ }, "ScriptsRegisterHostedRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4731,6 +4829,7 @@ }, "ScriptsRegisterInlineRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4743,6 +4842,7 @@ }, "ScriptsUpsertCustomCodeRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4755,6 +4855,7 @@ }, "SitesGetCustomDomainRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4767,6 +4868,7 @@ }, "SitesGetRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4779,6 +4881,7 @@ }, "SitesListRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4791,6 +4894,7 @@ }, "SitesPublishRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4803,6 +4907,7 @@ }, "TokenAuthorizedByRequestForbiddenErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "details": "optional>", "externalReference": "optional", @@ -4816,6 +4921,7 @@ }, "UpdatePageSettingsRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4828,6 +4934,7 @@ }, "UpdateStaticContentRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4842,6 +4949,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -4852,6 +4960,7 @@ }, "UsersDeleteRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4866,6 +4975,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -4876,6 +4986,7 @@ }, "UsersGetRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4890,6 +5001,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -4902,6 +5014,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -4912,6 +5025,7 @@ }, "UsersInviteRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4926,6 +5040,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -4936,6 +5051,7 @@ }, "UsersListRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4950,6 +5066,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -4960,6 +5077,7 @@ }, "UsersUpdateRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4972,6 +5090,7 @@ }, "WebhooksCreateRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4984,6 +5103,7 @@ }, "WebhooksDeleteRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -4996,6 +5116,7 @@ }, "WebhooksGetRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -5008,6 +5129,7 @@ }, "WebhooksListRequestTooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -5142,6 +5264,7 @@ - map source: openapi: ../openapi.yml + inline: true ForbiddenErrorBodyZero: properties: code: @@ -5158,6 +5281,7 @@ docs: Array of errors source: openapi: ../openapi.yml + inline: true ForbiddenErrorBodyOneDetailsItem: discriminated: false union: @@ -5165,6 +5289,7 @@ - map source: openapi: ../openapi.yml + inline: true ForbiddenErrorBodyOne: properties: code: @@ -5181,6 +5306,7 @@ docs: Array of errors source: openapi: ../openapi.yml + inline: true ActivityLogsListRequestForbiddenErrorBody: discriminated: false union: @@ -5654,6 +5780,7 @@ - map source: openapi: ../openapi.yml + inline: true ConflictErrorBodyZero: properties: code: @@ -5670,6 +5797,7 @@ docs: Array of errors source: openapi: ../openapi.yml + inline: true ConflictErrorBodyOneDetailsItem: discriminated: false union: @@ -5677,6 +5805,7 @@ - map source: openapi: ../openapi.yml + inline: true ConflictErrorBodyOne: properties: code: @@ -5693,6 +5822,7 @@ docs: Array of errors source: openapi: ../openapi.yml + inline: true UsersInviteRequestConflictErrorBody: discriminated: false union: @@ -5739,6 +5869,7 @@ - map source: openapi: ../openapi.yml + inline: true ProductsListRequestConflictErrorBody: properties: code: @@ -8794,6 +8925,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "AccessGroupsListResponse": { "docs": "The list access groups results", + "inline": undefined, "properties": { "accessGroups": { "docs": "List of Site Access Groups", @@ -8824,6 +8956,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "AccessGroupsListResponseAccessGroupsItem": { "docs": undefined, + "inline": true, "properties": { "createdOn": { "docs": "The date the Access Group was created", @@ -8886,6 +9019,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: The date the Access Group was created source: openapi: ../openapi.yml + inline: true AccessGroupsListResponse: docs: The list access groups results properties: @@ -9499,6 +9633,7 @@ service: "types": { "AssetsCreateFolderResponse": { "docs": "Asset Folder details", + "inline": undefined, "properties": { "assets": { "docs": "Array of Asset instances in the folder", @@ -9535,6 +9670,7 @@ service: }, "AssetsCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "assetUrl": { "docs": "S3 link to the asset", @@ -9594,6 +9730,7 @@ service: }, "AssetsCreateResponseUploadDetails": { "docs": "Metadata for uploading the asset binary", + "inline": true, "properties": { "Cache-Control": "optional", "Policy": "optional", @@ -9613,6 +9750,7 @@ service: }, "AssetsGetFolderResponse": { "docs": "Asset Folder details", + "inline": undefined, "properties": { "assets": { "docs": "Array of Asset instances in the folder", @@ -9649,6 +9787,7 @@ service: }, "AssetsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "altText": { "docs": "The visual description of the asset", @@ -9704,6 +9843,7 @@ service: }, "AssetsGetResponseVariantsItem": { "docs": undefined, + "inline": true, "properties": { "displayName": { "docs": "Display name of the variant", @@ -9750,6 +9890,7 @@ service: }, "AssetsListFoldersResponse": { "docs": "The Asset Folders object", + "inline": undefined, "properties": { "assetFolders": { "docs": "A list of Asset folders", @@ -9766,6 +9907,7 @@ service: }, "AssetsListFoldersResponseAssetFoldersItem": { "docs": "Asset Folder details", + "inline": true, "properties": { "assets": { "docs": "Array of Asset instances in the folder", @@ -9802,6 +9944,7 @@ service: }, "AssetsListFoldersResponsePagination": { "docs": "Pagination object", + "inline": true, "properties": { "limit": { "docs": "The limit used for pagination", @@ -9822,6 +9965,7 @@ service: }, "AssetsListResponse": { "docs": "A list of assets", + "inline": undefined, "properties": { "assets": "optional>", }, @@ -9831,6 +9975,7 @@ service: }, "AssetsListResponseAssetsItem": { "docs": undefined, + "inline": true, "properties": { "altText": { "docs": "The visual description of the asset", @@ -9886,6 +10031,7 @@ service: }, "AssetsListResponseAssetsItemVariantsItem": { "docs": undefined, + "inline": true, "properties": { "displayName": { "docs": "Display name of the variant", @@ -9932,6 +10078,7 @@ service: }, "AssetsUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "altText": { "docs": "The visual description of the asset", @@ -9987,6 +10134,7 @@ service: }, "AssetsUpdateResponseVariantsItem": { "docs": undefined, + "inline": true, "properties": { "displayName": { "docs": "Display name of the variant", @@ -10064,6 +10212,7 @@ service: docs: Any associated validation errors source: openapi: ../openapi.yml + inline: true AssetsListResponseAssetsItem: properties: id: @@ -10101,6 +10250,7 @@ service: docs: The visual description of the asset source: openapi: ../openapi.yml + inline: true AssetsListResponse: docs: A list of assets properties: @@ -10123,6 +10273,7 @@ service: Cache-Control: optional source: openapi: ../openapi.yml + inline: true AssetsCreateResponse: properties: uploadDetails: @@ -10190,6 +10341,7 @@ service: docs: Any associated validation errors source: openapi: ../openapi.yml + inline: true AssetsGetResponse: properties: id: @@ -10257,6 +10409,7 @@ service: docs: Any associated validation errors source: openapi: ../openapi.yml + inline: true AssetsUpdateResponse: properties: id: @@ -10320,6 +10473,7 @@ service: docs: Date that the Asset Folder was last updated on source: openapi: ../openapi.yml + inline: true AssetsListFoldersResponsePagination: docs: Pagination object properties: @@ -10334,6 +10488,7 @@ service: docs: The total number of records source: openapi: ../openapi.yml + inline: true AssetsListFoldersResponse: docs: The Asset Folders object properties: @@ -11075,6 +11230,7 @@ service: "types": { "CollectionsCreateResponse": { "docs": "A collection object", + "inline": undefined, "properties": { "createdOn": { "docs": "The date the collection was created", @@ -11111,6 +11267,7 @@ service: }, "CollectionsCreateResponseFieldsItem": { "docs": "The details of a field in a collection", + "inline": true, "properties": { "displayName": { "docs": "The name of a field", @@ -11168,6 +11325,7 @@ service: }, "CollectionsGetResponse": { "docs": "A collection object", + "inline": undefined, "properties": { "createdOn": { "docs": "The date the collection was created", @@ -11204,6 +11362,7 @@ service: }, "CollectionsGetResponseFieldsItem": { "docs": "The details of a field in a collection", + "inline": true, "properties": { "displayName": { "docs": "The name of a field", @@ -11261,6 +11420,7 @@ service: }, "CollectionsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "collections": { "docs": "An array of Collections", @@ -11273,6 +11433,7 @@ service: }, "CollectionsListResponseCollectionsItem": { "docs": "A collection object", + "inline": true, "properties": { "createdOn": { "docs": "The date the collection was created", @@ -11331,6 +11492,7 @@ service: docs: The date the collection was last updated source: openapi: ../openapi.yml + inline: true CollectionsListResponse: properties: collections: @@ -11384,6 +11546,7 @@ service: docs: Additional text to help anyone filling out this field source: openapi: ../openapi.yml + inline: true CollectionsCreateResponse: docs: A collection object properties: @@ -11458,6 +11621,7 @@ service: docs: Additional text to help anyone filling out this field source: openapi: ../openapi.yml + inline: true CollectionsGetResponse: docs: A collection object properties: @@ -11892,6 +12056,7 @@ service: }, "FieldsCreateResponse": { "docs": "The details of a field in a collection", + "inline": undefined, "properties": { "displayName": { "docs": "The name of a field", @@ -11949,6 +12114,7 @@ service: }, "FieldsUpdateResponse": { "docs": "The details of a field in a collection", + "inline": undefined, "properties": { "displayName": { "docs": "The name of a field", @@ -13227,6 +13393,7 @@ service: "ItemsCreateItemForMultipleLocalesRequestFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -13244,6 +13411,7 @@ service: "ItemsCreateItemForMultipleLocalesResponse": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "cmsLocaleIds": { "docs": "Array of identifiers for the locales where the item will be created", @@ -13284,6 +13452,7 @@ service: "ItemsCreateItemForMultipleLocalesResponseFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -13301,6 +13470,7 @@ service: "ItemsCreateItemLiveRequestFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -13318,6 +13488,7 @@ service: "ItemsCreateItemLiveResponse": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -13358,6 +13529,7 @@ service: "ItemsCreateItemLiveResponseFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -13375,6 +13547,7 @@ service: "ItemsCreateItemRequestFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -13392,6 +13565,7 @@ service: "ItemsCreateItemResponse": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -13432,6 +13606,7 @@ service: "ItemsCreateItemResponseFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -13449,6 +13624,7 @@ service: "ItemsGetItemLiveResponse": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -13489,6 +13665,7 @@ service: "ItemsGetItemLiveResponseFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -13506,6 +13683,7 @@ service: "ItemsGetItemResponse": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -13546,6 +13724,7 @@ service: "ItemsGetItemResponseFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -13581,6 +13760,7 @@ service: }, "ItemsListItemsLiveResponse": { "docs": "Results from collection items list", + "inline": undefined, "properties": { "items": { "docs": "List of Items within the collection", @@ -13595,6 +13775,7 @@ service: "ItemsListItemsLiveResponseItemsItem": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -13635,6 +13816,7 @@ service: "ItemsListItemsLiveResponseItemsItemFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -13651,6 +13833,7 @@ service: }, "ItemsListItemsLiveResponsePagination": { "docs": undefined, + "inline": true, "properties": { "limit": { "default": 100, @@ -13692,6 +13875,7 @@ service: }, "ItemsListItemsResponse": { "docs": "Results from collection items list", + "inline": undefined, "properties": { "items": { "docs": "List of Items within the collection", @@ -13706,6 +13890,7 @@ service: "ItemsListItemsResponseItemsItem": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -13746,6 +13931,7 @@ service: "ItemsListItemsResponseItemsItemFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -13762,6 +13948,7 @@ service: }, "ItemsListItemsResponsePagination": { "docs": undefined, + "inline": true, "properties": { "limit": { "default": 100, @@ -13784,6 +13971,7 @@ service: }, "ItemsPublishItemResponse": { "docs": undefined, + "inline": undefined, "properties": { "errors": "optional>", "publishedItemIds": "optional>", @@ -13795,6 +13983,7 @@ service: "ItemsUpdateItemLiveRequestFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -13812,6 +14001,7 @@ service: "ItemsUpdateItemLiveResponse": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -13852,6 +14042,7 @@ service: "ItemsUpdateItemLiveResponseFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -13869,6 +14060,7 @@ service: "ItemsUpdateItemRequestFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -13886,6 +14078,7 @@ service: "ItemsUpdateItemResponse": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -13926,6 +14119,7 @@ service: "ItemsUpdateItemResponseFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -13969,6 +14163,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsListItemsResponseItemsItem: docs: > The fields that define the schema for a given Item are based on the @@ -14002,6 +14197,7 @@ service: fieldData: optional source: openapi: ../openapi.yml + inline: true ItemsListItemsResponsePagination: properties: limit: @@ -14017,6 +14213,7 @@ service: docs: Total number of items in the collection source: openapi: ../openapi.yml + inline: true ItemsListItemsResponse: docs: Results from collection items list properties: @@ -14039,6 +14236,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsCreateItemResponseFieldData: properties: name: @@ -14052,6 +14250,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsCreateItemResponse: docs: > The fields that define the schema for a given Item are based on the @@ -14111,6 +14310,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsListItemsLiveResponseItemsItem: docs: > The fields that define the schema for a given Item are based on the @@ -14144,6 +14344,7 @@ service: fieldData: optional source: openapi: ../openapi.yml + inline: true ItemsListItemsLiveResponsePagination: properties: limit: @@ -14159,6 +14360,7 @@ service: docs: Total number of items in the collection source: openapi: ../openapi.yml + inline: true ItemsListItemsLiveResponse: docs: Results from collection items list properties: @@ -14181,6 +14383,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsCreateItemLiveResponseFieldData: properties: name: @@ -14194,6 +14397,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsCreateItemLiveResponse: docs: > The fields that define the schema for a given Item are based on the @@ -14240,6 +14444,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsCreateItemForMultipleLocalesResponseFieldData: properties: name: @@ -14253,6 +14458,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsCreateItemForMultipleLocalesResponse: docs: > The fields that define the schema for a given Item are based on the @@ -14299,6 +14505,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsGetItemResponse: docs: > The fields that define the schema for a given Item are based on the @@ -14345,6 +14552,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsUpdateItemResponseFieldData: properties: name: @@ -14358,6 +14566,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsUpdateItemResponse: docs: > The fields that define the schema for a given Item are based on the @@ -14404,6 +14613,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsGetItemLiveResponse: docs: > The fields that define the schema for a given Item are based on the @@ -14450,6 +14660,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsUpdateItemLiveResponseFieldData: properties: name: @@ -14463,6 +14674,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsUpdateItemLiveResponse: docs: > The fields that define the schema for a given Item are based on the @@ -15321,6 +15533,7 @@ Required scope | `ecommerce:read` "types": { "EcommerceGetSettingsResponse": { "docs": "Ecommerce settings for a Webflow Site", + "inline": undefined, "properties": { "createdOn": { "docs": "Date that the Site was created on", @@ -15797,6 +16010,7 @@ service: "types": { "FormSubmissionPayload": { "docs": "The Webhook payload for when a form is submitted", + "inline": undefined, "properties": { "payload": { "docs": "The payload of data sent from Webflow", @@ -15813,6 +16027,7 @@ service: }, "FormSubmissionPayloadPayload": { "docs": "The payload of data sent from Webflow", + "inline": true, "properties": { "data": { "docs": "The data submitted in the form", @@ -15853,6 +16068,7 @@ service: }, "FormsGetResponse": { "docs": "A form and its corresponding metadata", + "inline": undefined, "properties": { "createdOn": { "docs": "Date that the Form was created on", @@ -15909,6 +16125,7 @@ service: }, "FormsGetResponseFieldsValue": { "docs": "An object containing field info for a specific fieldID.", + "inline": true, "properties": { "displayName": { "docs": "The field name displayed on the site", @@ -15946,6 +16163,7 @@ service: }, "FormsGetResponseResponseSettings": { "docs": "Settings for form responses", + "inline": true, "properties": { "redirectAction": { "docs": "The action to take after form submission", @@ -15970,6 +16188,7 @@ service: }, "FormsGetSubmissionResponse": { "docs": "A form submission", + "inline": undefined, "properties": { "dateSubmitted": { "docs": "Date that the Form was submitted on", @@ -16002,6 +16221,7 @@ service: }, "FormsListResponse": { "docs": "A list of forms", + "inline": undefined, "properties": { "forms": "optional>", "pagination": { @@ -16015,6 +16235,7 @@ service: }, "FormsListResponseFormsItem": { "docs": "A Webflow form", + "inline": true, "properties": { "createdOn": { "docs": "Date that the Form was created on", @@ -16071,6 +16292,7 @@ service: }, "FormsListResponseFormsItemFieldsValue": { "docs": "An object containing field info for a specific fieldID.", + "inline": true, "properties": { "displayName": { "docs": "The field name displayed on the site", @@ -16108,6 +16330,7 @@ service: }, "FormsListResponseFormsItemResponseSettings": { "docs": "Settings for form responses", + "inline": true, "properties": { "redirectAction": { "docs": "The action to take after form submission", @@ -16132,6 +16355,7 @@ service: }, "FormsListResponsePagination": { "docs": "Pagination object", + "inline": true, "properties": { "limit": { "docs": "The limit used for pagination", @@ -16152,6 +16376,7 @@ service: }, "FormsListSubmissionsResponse": { "docs": "A list of form submissions", + "inline": undefined, "properties": { "formSubmissions": "optional>", "pagination": { @@ -16165,6 +16390,7 @@ service: }, "FormsListSubmissionsResponseFormSubmissionsItem": { "docs": undefined, + "inline": true, "properties": { "dateSubmitted": { "docs": "Date that the Form was submitted on", @@ -16197,6 +16423,7 @@ service: }, "FormsListSubmissionsResponsePagination": { "docs": "Pagination object", + "inline": true, "properties": { "limit": { "docs": "The limit used for pagination", @@ -16217,6 +16444,7 @@ service: }, "FormsUpdateSubmissionResponse": { "docs": "A form submission", + "inline": undefined, "properties": { "dateSubmitted": { "docs": "Date that the Form was submitted on", @@ -16334,6 +16562,7 @@ service: docs: Whether the field is visible to the user source: openapi: ../openapi.yml + inline: true FormsListResponseFormsItemResponseSettings: docs: Settings for form responses properties: @@ -16351,6 +16580,7 @@ service: docs: Whether to send an email confirmation to the user source: openapi: ../openapi.yml + inline: true FormsListResponseFormsItem: docs: A Webflow form properties: @@ -16392,6 +16622,7 @@ service: docs: The unique id of the Workspace the Site belongs to source: openapi: ../openapi.yml + inline: true FormsListResponsePagination: docs: Pagination object properties: @@ -16406,6 +16637,7 @@ service: docs: The total number of records source: openapi: ../openapi.yml + inline: true FormsListResponse: docs: A list of forms properties: @@ -16442,6 +16674,7 @@ service: docs: Whether the field is visible to the user source: openapi: ../openapi.yml + inline: true FormsGetResponseResponseSettings: docs: Settings for form responses properties: @@ -16459,6 +16692,7 @@ service: docs: Whether to send an email confirmation to the user source: openapi: ../openapi.yml + inline: true FormsGetResponse: docs: A form and its corresponding metadata properties: @@ -16522,6 +16756,7 @@ service: docs: The data submitted in the Form source: openapi: ../openapi.yml + inline: true FormsListSubmissionsResponsePagination: docs: Pagination object properties: @@ -16536,6 +16771,7 @@ service: docs: The total number of records source: openapi: ../openapi.yml + inline: true FormsListSubmissionsResponse: docs: A list of form submissions properties: @@ -16620,6 +16856,7 @@ service: docs: The unique id of the Form element source: openapi: ../openapi.yml + inline: true FormSubmissionPayload: docs: The Webhook payload for when a form is submitted properties: @@ -17113,6 +17350,7 @@ Required scope | `ecommerce:write` "types": { "EcommInventoryChangedPayload": { "docs": "The availabile inventory for an item", + "inline": undefined, "properties": { "id": { "docs": "Unique identifier for a SKU item", @@ -17143,6 +17381,7 @@ Required scope | `ecommerce:write` }, "InventoryListResponse": { "docs": "The availabile inventory for an item", + "inline": undefined, "properties": { "id": { "docs": "Unique identifier for a SKU item", @@ -17183,6 +17422,7 @@ Required scope | `ecommerce:write` }, "InventoryUpdateResponse": { "docs": "The availabile inventory for an item", + "inline": undefined, "properties": { "id": { "docs": "Unique identifier for a SKU item", @@ -17438,6 +17678,7 @@ webhooks: "CollectionItemChangedPayload": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -17478,6 +17719,7 @@ webhooks: "CollectionItemChangedPayloadFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -17495,6 +17737,7 @@ webhooks: "CollectionItemCreatedPayload": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -17535,6 +17778,7 @@ webhooks: "CollectionItemCreatedPayloadFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -17551,6 +17795,7 @@ webhooks: }, "CollectionItemDeletedPayload": { "docs": undefined, + "inline": undefined, "properties": { "payload": { "docs": "The payload of data sent from Webflow", @@ -17567,6 +17812,7 @@ webhooks: }, "CollectionItemDeletedPayloadPayload": { "docs": "The payload of data sent from Webflow", + "inline": true, "properties": { "collectionId": { "docs": "The ID of the collection", @@ -17591,6 +17837,7 @@ webhooks: }, "CollectionItemUnpublishedPayload": { "docs": undefined, + "inline": undefined, "properties": { "payload": { "docs": "The payload of data sent from Webflow", @@ -17607,6 +17854,7 @@ webhooks: }, "CollectionItemUnpublishedPayloadPayload": { "docs": "The payload of data sent from Webflow", + "inline": true, "properties": { "collectionId": { "docs": "The ID of the collection", @@ -17747,6 +17995,7 @@ webhooks: extra-properties: true source: openapi: ../openapi.yml + inline: true CollectionItemCreatedPayload: docs: > The fields that define the schema for a given Item are based on the @@ -17793,6 +18042,7 @@ webhooks: extra-properties: true source: openapi: ../openapi.yml + inline: true CollectionItemChangedPayload: docs: > The fields that define the schema for a given Item are based on the @@ -17843,6 +18093,7 @@ webhooks: docs: The ID of the collection source: openapi: ../openapi.yml + inline: true CollectionItemDeletedPayload: properties: triggerType: @@ -17870,6 +18121,7 @@ webhooks: docs: The ID of the collection source: openapi: ../openapi.yml + inline: true CollectionItemUnpublishedPayload: properties: triggerType: @@ -19885,6 +20137,7 @@ Required scope | `ecommerce:write` "types": { "EcommNewOrderPayload": { "docs": undefined, + "inline": undefined, "properties": { "acceptedOn": { "docs": "The ISO8601 timestamp that an Order was placed.", @@ -20038,6 +20291,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadAllAddressesItem": { "docs": "A customer address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -20102,6 +20356,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadApplicationFee": { "docs": "The application fee assessed by the platform", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -20122,6 +20377,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadBillingAddress": { "docs": "The billing address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -20186,6 +20442,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadCustomerInfo": { "docs": "An object with the keys `fullName` and `email`.", + "inline": true, "properties": { "email": { "docs": "The Customer's email address", @@ -20208,6 +20465,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadCustomerPaid": { "docs": "The total paid by the customer", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -20245,6 +20503,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadDownloadFilesItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier for the downloadable file", @@ -20271,6 +20530,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadMetadata": { "docs": undefined, + "inline": true, "properties": { "isBuyNow": "optional", }, @@ -20280,6 +20540,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadNetAmount": { "docs": "The net amount after application fees", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -20300,6 +20561,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadPaypalDetails": { "docs": undefined, + "inline": true, "properties": { "captureId": { "docs": "PayPal capture identifier", @@ -20332,6 +20594,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadPurchasedItemsItem": { "docs": "An Item that was purchased", + "inline": true, "properties": { "count": { "docs": "Number of Item purchased.", @@ -20397,6 +20660,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadPurchasedItemsItemRowTotal": { "docs": "The total for the row", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -20417,6 +20681,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadPurchasedItemsItemVariantImage": { "docs": undefined, + "inline": true, "properties": { "file": "optional", "url": { @@ -20436,6 +20701,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadPurchasedItemsItemVariantImageFile": { "docs": undefined, + "inline": true, "properties": { "contentType": { "docs": "The MIME type of the image", @@ -20472,6 +20738,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadPurchasedItemsItemVariantImageFileVariantsItem": { "docs": undefined, + "inline": true, "properties": { "height": { "docs": "The image height in pixels", @@ -20503,6 +20770,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadPurchasedItemsItemVariantPrice": { "docs": "The price corresponding to the variant", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -20523,6 +20791,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadShippingAddress": { "docs": "The shipping address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -20606,6 +20875,7 @@ Required scope | `ecommerce:write` "EcommNewOrderPayloadStripeCard": { "docs": "Details on the card used to fulfill this order, if this order was finalized with Stripe. ", + "inline": true, "properties": { "brand": { "docs": "The card's brand (ie. credit card network)", @@ -20651,6 +20921,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadStripeCardExpires": { "docs": "The card's expiration date.", + "inline": true, "properties": { "month": { "docs": "Month that the card expires", @@ -20667,6 +20938,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadStripeDetails": { "docs": "An object with various Stripe IDs, useful for linking into the stripe dashboard.", + "inline": true, "properties": { "chargeId": { "docs": "Stripe-generated charge identifier, or null", @@ -20707,6 +20979,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadTotals": { "docs": "An object describing various pricing totals", + "inline": true, "properties": { "extras": { "docs": "An array of extra items, includes discounts, shipping, and taxes.", @@ -20727,6 +21000,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadTotalsExtrasItem": { "docs": "Extra order items, includes discounts, shipping, and taxes.", + "inline": true, "properties": { "description": { "docs": "A human-readable (but English) description of this extra charge.", @@ -20751,6 +21025,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadTotalsExtrasItemPrice": { "docs": "The price for the item", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -20786,6 +21061,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadTotalsSubtotal": { "docs": "The subtotal price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -20806,6 +21082,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadTotalsTotal": { "docs": "The total price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -20826,6 +21103,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayload": { "docs": undefined, + "inline": undefined, "properties": { "acceptedOn": { "docs": "The ISO8601 timestamp that an Order was placed.", @@ -20979,6 +21257,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadAllAddressesItem": { "docs": "A customer address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -21043,6 +21322,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadApplicationFee": { "docs": "The application fee assessed by the platform", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -21063,6 +21343,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadBillingAddress": { "docs": "The billing address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -21127,6 +21408,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadCustomerInfo": { "docs": "An object with the keys `fullName` and `email`.", + "inline": true, "properties": { "email": { "docs": "The Customer's email address", @@ -21149,6 +21431,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadCustomerPaid": { "docs": "The total paid by the customer", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -21186,6 +21469,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadDownloadFilesItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier for the downloadable file", @@ -21212,6 +21496,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadMetadata": { "docs": undefined, + "inline": true, "properties": { "isBuyNow": "optional", }, @@ -21221,6 +21506,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadNetAmount": { "docs": "The net amount after application fees", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -21241,6 +21527,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadPaypalDetails": { "docs": undefined, + "inline": true, "properties": { "captureId": { "docs": "PayPal capture identifier", @@ -21273,6 +21560,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadPurchasedItemsItem": { "docs": "An Item that was purchased", + "inline": true, "properties": { "count": { "docs": "Number of Item purchased.", @@ -21338,6 +21626,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadPurchasedItemsItemRowTotal": { "docs": "The total for the row", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -21358,6 +21647,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadPurchasedItemsItemVariantImage": { "docs": undefined, + "inline": true, "properties": { "file": "optional", "url": { @@ -21377,6 +21667,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadPurchasedItemsItemVariantImageFile": { "docs": undefined, + "inline": true, "properties": { "contentType": { "docs": "The MIME type of the image", @@ -21413,6 +21704,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadPurchasedItemsItemVariantImageFileVariantsItem": { "docs": undefined, + "inline": true, "properties": { "height": { "docs": "The image height in pixels", @@ -21444,6 +21736,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadPurchasedItemsItemVariantPrice": { "docs": "The price corresponding to the variant", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -21464,6 +21757,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadShippingAddress": { "docs": "The shipping address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -21547,6 +21841,7 @@ Required scope | `ecommerce:write` "EcommOrderChangedPayloadStripeCard": { "docs": "Details on the card used to fulfill this order, if this order was finalized with Stripe. ", + "inline": true, "properties": { "brand": { "docs": "The card's brand (ie. credit card network)", @@ -21592,6 +21887,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadStripeCardExpires": { "docs": "The card's expiration date.", + "inline": true, "properties": { "month": { "docs": "Month that the card expires", @@ -21608,6 +21904,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadStripeDetails": { "docs": "An object with various Stripe IDs, useful for linking into the stripe dashboard.", + "inline": true, "properties": { "chargeId": { "docs": "Stripe-generated charge identifier, or null", @@ -21648,6 +21945,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadTotals": { "docs": "An object describing various pricing totals", + "inline": true, "properties": { "extras": { "docs": "An array of extra items, includes discounts, shipping, and taxes.", @@ -21668,6 +21966,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadTotalsExtrasItem": { "docs": "Extra order items, includes discounts, shipping, and taxes.", + "inline": true, "properties": { "description": { "docs": "A human-readable (but English) description of this extra charge.", @@ -21692,6 +21991,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadTotalsExtrasItemPrice": { "docs": "The price for the item", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -21727,6 +22027,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadTotalsSubtotal": { "docs": "The subtotal price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -21747,6 +22048,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadTotalsTotal": { "docs": "The total price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -21767,6 +22069,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "acceptedOn": { "docs": "The ISO8601 timestamp that an Order was placed.", @@ -21920,6 +22223,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseAllAddressesItem": { "docs": "A customer address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -21984,6 +22288,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseApplicationFee": { "docs": "The application fee assessed by the platform", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -22004,6 +22309,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseBillingAddress": { "docs": "The billing address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -22068,6 +22374,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseCustomerInfo": { "docs": "An object with the keys `fullName` and `email`.", + "inline": true, "properties": { "email": { "docs": "The Customer's email address", @@ -22090,6 +22397,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseCustomerPaid": { "docs": "The total paid by the customer", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -22127,6 +22435,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseDownloadFilesItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier for the downloadable file", @@ -22153,6 +22462,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseMetadata": { "docs": undefined, + "inline": true, "properties": { "isBuyNow": "optional", }, @@ -22162,6 +22472,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseNetAmount": { "docs": "The net amount after application fees", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -22182,6 +22493,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponsePaypalDetails": { "docs": undefined, + "inline": true, "properties": { "captureId": { "docs": "PayPal capture identifier", @@ -22214,6 +22526,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponsePurchasedItemsItem": { "docs": "An Item that was purchased", + "inline": true, "properties": { "count": { "docs": "Number of Item purchased.", @@ -22279,6 +22592,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponsePurchasedItemsItemRowTotal": { "docs": "The total for the row", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -22299,6 +22613,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponsePurchasedItemsItemVariantImage": { "docs": undefined, + "inline": true, "properties": { "file": "optional", "url": { @@ -22318,6 +22633,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponsePurchasedItemsItemVariantImageFile": { "docs": undefined, + "inline": true, "properties": { "contentType": { "docs": "The MIME type of the image", @@ -22354,6 +22670,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponsePurchasedItemsItemVariantImageFileVariantsItem": { "docs": undefined, + "inline": true, "properties": { "height": { "docs": "The image height in pixels", @@ -22385,6 +22702,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponsePurchasedItemsItemVariantPrice": { "docs": "The price corresponding to the variant", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -22405,6 +22723,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseShippingAddress": { "docs": "The shipping address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -22488,6 +22807,7 @@ Required scope | `ecommerce:write` "OrdersGetResponseStripeCard": { "docs": "Details on the card used to fulfill this order, if this order was finalized with Stripe. ", + "inline": true, "properties": { "brand": { "docs": "The card's brand (ie. credit card network)", @@ -22533,6 +22853,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseStripeCardExpires": { "docs": "The card's expiration date.", + "inline": true, "properties": { "month": { "docs": "Month that the card expires", @@ -22549,6 +22870,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseStripeDetails": { "docs": "An object with various Stripe IDs, useful for linking into the stripe dashboard.", + "inline": true, "properties": { "chargeId": { "docs": "Stripe-generated charge identifier, or null", @@ -22589,6 +22911,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseTotals": { "docs": "An object describing various pricing totals", + "inline": true, "properties": { "extras": { "docs": "An array of extra items, includes discounts, shipping, and taxes.", @@ -22609,6 +22932,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseTotalsExtrasItem": { "docs": "Extra order items, includes discounts, shipping, and taxes.", + "inline": true, "properties": { "description": { "docs": "A human-readable (but English) description of this extra charge.", @@ -22633,6 +22957,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseTotalsExtrasItemPrice": { "docs": "The price for the item", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -22668,6 +22993,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseTotalsSubtotal": { "docs": "The subtotal price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -22688,6 +23014,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseTotalsTotal": { "docs": "The total price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -22724,6 +23051,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponse": { "docs": "Results from order list", + "inline": undefined, "properties": { "orders": { "docs": "List of orders", @@ -22740,6 +23068,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItem": { "docs": undefined, + "inline": true, "properties": { "acceptedOn": { "docs": "The ISO8601 timestamp that an Order was placed.", @@ -22893,6 +23222,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemAllAddressesItem": { "docs": "A customer address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -22957,6 +23287,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemApplicationFee": { "docs": "The application fee assessed by the platform", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -22977,6 +23308,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemBillingAddress": { "docs": "The billing address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -23041,6 +23373,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemCustomerInfo": { "docs": "An object with the keys `fullName` and `email`.", + "inline": true, "properties": { "email": { "docs": "The Customer's email address", @@ -23063,6 +23396,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemCustomerPaid": { "docs": "The total paid by the customer", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -23100,6 +23434,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemDownloadFilesItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier for the downloadable file", @@ -23126,6 +23461,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemMetadata": { "docs": undefined, + "inline": true, "properties": { "isBuyNow": "optional", }, @@ -23135,6 +23471,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemNetAmount": { "docs": "The net amount after application fees", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -23155,6 +23492,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemPaypalDetails": { "docs": undefined, + "inline": true, "properties": { "captureId": { "docs": "PayPal capture identifier", @@ -23187,6 +23525,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemPurchasedItemsItem": { "docs": "An Item that was purchased", + "inline": true, "properties": { "count": { "docs": "Number of Item purchased.", @@ -23252,6 +23591,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemPurchasedItemsItemRowTotal": { "docs": "The total for the row", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -23272,6 +23612,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemPurchasedItemsItemVariantImage": { "docs": undefined, + "inline": true, "properties": { "file": "optional", "url": { @@ -23291,6 +23632,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemPurchasedItemsItemVariantImageFile": { "docs": undefined, + "inline": true, "properties": { "contentType": { "docs": "The MIME type of the image", @@ -23327,6 +23669,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemPurchasedItemsItemVariantImageFileVariantsItem": { "docs": undefined, + "inline": true, "properties": { "height": { "docs": "The image height in pixels", @@ -23358,6 +23701,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemPurchasedItemsItemVariantPrice": { "docs": "The price corresponding to the variant", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -23378,6 +23722,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemShippingAddress": { "docs": "The shipping address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -23461,6 +23806,7 @@ Required scope | `ecommerce:write` "OrdersListResponseOrdersItemStripeCard": { "docs": "Details on the card used to fulfill this order, if this order was finalized with Stripe. ", + "inline": true, "properties": { "brand": { "docs": "The card's brand (ie. credit card network)", @@ -23506,6 +23852,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemStripeCardExpires": { "docs": "The card's expiration date.", + "inline": true, "properties": { "month": { "docs": "Month that the card expires", @@ -23522,6 +23869,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemStripeDetails": { "docs": "An object with various Stripe IDs, useful for linking into the stripe dashboard.", + "inline": true, "properties": { "chargeId": { "docs": "Stripe-generated charge identifier, or null", @@ -23562,6 +23910,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemTotals": { "docs": "An object describing various pricing totals", + "inline": true, "properties": { "extras": { "docs": "An array of extra items, includes discounts, shipping, and taxes.", @@ -23582,6 +23931,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemTotalsExtrasItem": { "docs": "Extra order items, includes discounts, shipping, and taxes.", + "inline": true, "properties": { "description": { "docs": "A human-readable (but English) description of this extra charge.", @@ -23606,6 +23956,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemTotalsExtrasItemPrice": { "docs": "The price for the item", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -23641,6 +23992,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemTotalsSubtotal": { "docs": "The subtotal price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -23661,6 +24013,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemTotalsTotal": { "docs": "The total price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -23681,6 +24034,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponsePagination": { "docs": "Pagination object", + "inline": true, "properties": { "limit": { "docs": "The limit used for pagination", @@ -23712,6 +24066,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponse": { "docs": undefined, + "inline": undefined, "properties": { "acceptedOn": { "docs": "The ISO8601 timestamp that an Order was placed.", @@ -23865,6 +24220,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseAllAddressesItem": { "docs": "A customer address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -23929,6 +24285,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseApplicationFee": { "docs": "The application fee assessed by the platform", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -23949,6 +24306,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseBillingAddress": { "docs": "The billing address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -24013,6 +24371,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseCustomerInfo": { "docs": "An object with the keys `fullName` and `email`.", + "inline": true, "properties": { "email": { "docs": "The Customer's email address", @@ -24035,6 +24394,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseCustomerPaid": { "docs": "The total paid by the customer", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -24072,6 +24432,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseDownloadFilesItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier for the downloadable file", @@ -24098,6 +24459,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseMetadata": { "docs": undefined, + "inline": true, "properties": { "isBuyNow": "optional", }, @@ -24107,6 +24469,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseNetAmount": { "docs": "The net amount after application fees", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -24127,6 +24490,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponsePaypalDetails": { "docs": undefined, + "inline": true, "properties": { "captureId": { "docs": "PayPal capture identifier", @@ -24159,6 +24523,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponsePurchasedItemsItem": { "docs": "An Item that was purchased", + "inline": true, "properties": { "count": { "docs": "Number of Item purchased.", @@ -24224,6 +24589,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponsePurchasedItemsItemRowTotal": { "docs": "The total for the row", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -24244,6 +24610,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponsePurchasedItemsItemVariantImage": { "docs": undefined, + "inline": true, "properties": { "file": "optional", "url": { @@ -24263,6 +24630,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponsePurchasedItemsItemVariantImageFile": { "docs": undefined, + "inline": true, "properties": { "contentType": { "docs": "The MIME type of the image", @@ -24299,6 +24667,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponsePurchasedItemsItemVariantImageFileVariantsItem": { "docs": undefined, + "inline": true, "properties": { "height": { "docs": "The image height in pixels", @@ -24330,6 +24699,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponsePurchasedItemsItemVariantPrice": { "docs": "The price corresponding to the variant", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -24350,6 +24720,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseShippingAddress": { "docs": "The shipping address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -24433,6 +24804,7 @@ Required scope | `ecommerce:write` "OrdersRefundResponseStripeCard": { "docs": "Details on the card used to fulfill this order, if this order was finalized with Stripe. ", + "inline": true, "properties": { "brand": { "docs": "The card's brand (ie. credit card network)", @@ -24478,6 +24850,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseStripeCardExpires": { "docs": "The card's expiration date.", + "inline": true, "properties": { "month": { "docs": "Month that the card expires", @@ -24494,6 +24867,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseStripeDetails": { "docs": "An object with various Stripe IDs, useful for linking into the stripe dashboard.", + "inline": true, "properties": { "chargeId": { "docs": "Stripe-generated charge identifier, or null", @@ -24534,6 +24908,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseTotals": { "docs": "An object describing various pricing totals", + "inline": true, "properties": { "extras": { "docs": "An array of extra items, includes discounts, shipping, and taxes.", @@ -24554,6 +24929,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseTotalsExtrasItem": { "docs": "Extra order items, includes discounts, shipping, and taxes.", + "inline": true, "properties": { "description": { "docs": "A human-readable (but English) description of this extra charge.", @@ -24578,6 +24954,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseTotalsExtrasItemPrice": { "docs": "The price for the item", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -24613,6 +24990,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseTotalsSubtotal": { "docs": "The subtotal price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -24633,6 +25011,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseTotalsTotal": { "docs": "The total price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -24653,6 +25032,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponse": { "docs": undefined, + "inline": undefined, "properties": { "acceptedOn": { "docs": "The ISO8601 timestamp that an Order was placed.", @@ -24806,6 +25186,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseAllAddressesItem": { "docs": "A customer address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -24870,6 +25251,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseApplicationFee": { "docs": "The application fee assessed by the platform", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -24890,6 +25272,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseBillingAddress": { "docs": "The billing address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -24954,6 +25337,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseCustomerInfo": { "docs": "An object with the keys `fullName` and `email`.", + "inline": true, "properties": { "email": { "docs": "The Customer's email address", @@ -24976,6 +25360,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseCustomerPaid": { "docs": "The total paid by the customer", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -25013,6 +25398,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseDownloadFilesItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier for the downloadable file", @@ -25039,6 +25425,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseMetadata": { "docs": undefined, + "inline": true, "properties": { "isBuyNow": "optional", }, @@ -25048,6 +25435,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseNetAmount": { "docs": "The net amount after application fees", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -25068,6 +25456,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponsePaypalDetails": { "docs": undefined, + "inline": true, "properties": { "captureId": { "docs": "PayPal capture identifier", @@ -25100,6 +25489,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponsePurchasedItemsItem": { "docs": "An Item that was purchased", + "inline": true, "properties": { "count": { "docs": "Number of Item purchased.", @@ -25165,6 +25555,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponsePurchasedItemsItemRowTotal": { "docs": "The total for the row", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -25185,6 +25576,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponsePurchasedItemsItemVariantImage": { "docs": undefined, + "inline": true, "properties": { "file": "optional", "url": { @@ -25204,6 +25596,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponsePurchasedItemsItemVariantImageFile": { "docs": undefined, + "inline": true, "properties": { "contentType": { "docs": "The MIME type of the image", @@ -25240,6 +25633,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponsePurchasedItemsItemVariantImageFileVariantsItem": { "docs": undefined, + "inline": true, "properties": { "height": { "docs": "The image height in pixels", @@ -25271,6 +25665,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponsePurchasedItemsItemVariantPrice": { "docs": "The price corresponding to the variant", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -25291,6 +25686,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseShippingAddress": { "docs": "The shipping address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -25374,6 +25770,7 @@ Required scope | `ecommerce:write` "OrdersUpdateFulfillResponseStripeCard": { "docs": "Details on the card used to fulfill this order, if this order was finalized with Stripe. ", + "inline": true, "properties": { "brand": { "docs": "The card's brand (ie. credit card network)", @@ -25419,6 +25816,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseStripeCardExpires": { "docs": "The card's expiration date.", + "inline": true, "properties": { "month": { "docs": "Month that the card expires", @@ -25435,6 +25833,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseStripeDetails": { "docs": "An object with various Stripe IDs, useful for linking into the stripe dashboard.", + "inline": true, "properties": { "chargeId": { "docs": "Stripe-generated charge identifier, or null", @@ -25475,6 +25874,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseTotals": { "docs": "An object describing various pricing totals", + "inline": true, "properties": { "extras": { "docs": "An array of extra items, includes discounts, shipping, and taxes.", @@ -25495,6 +25895,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseTotalsExtrasItem": { "docs": "Extra order items, includes discounts, shipping, and taxes.", + "inline": true, "properties": { "description": { "docs": "A human-readable (but English) description of this extra charge.", @@ -25519,6 +25920,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseTotalsExtrasItemPrice": { "docs": "The price for the item", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -25554,6 +25956,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseTotalsSubtotal": { "docs": "The subtotal price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -25574,6 +25977,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseTotalsTotal": { "docs": "The total price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -25594,6 +25998,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "acceptedOn": { "docs": "The ISO8601 timestamp that an Order was placed.", @@ -25747,6 +26152,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseAllAddressesItem": { "docs": "A customer address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -25811,6 +26217,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseApplicationFee": { "docs": "The application fee assessed by the platform", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -25831,6 +26238,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseBillingAddress": { "docs": "The billing address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -25895,6 +26303,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseCustomerInfo": { "docs": "An object with the keys `fullName` and `email`.", + "inline": true, "properties": { "email": { "docs": "The Customer's email address", @@ -25917,6 +26326,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseCustomerPaid": { "docs": "The total paid by the customer", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -25954,6 +26364,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseDownloadFilesItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier for the downloadable file", @@ -25980,6 +26391,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseMetadata": { "docs": undefined, + "inline": true, "properties": { "isBuyNow": "optional", }, @@ -25989,6 +26401,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseNetAmount": { "docs": "The net amount after application fees", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -26009,6 +26422,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponsePaypalDetails": { "docs": undefined, + "inline": true, "properties": { "captureId": { "docs": "PayPal capture identifier", @@ -26041,6 +26455,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponsePurchasedItemsItem": { "docs": "An Item that was purchased", + "inline": true, "properties": { "count": { "docs": "Number of Item purchased.", @@ -26106,6 +26521,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponsePurchasedItemsItemRowTotal": { "docs": "The total for the row", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -26126,6 +26542,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponsePurchasedItemsItemVariantImage": { "docs": undefined, + "inline": true, "properties": { "file": "optional", "url": { @@ -26145,6 +26562,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponsePurchasedItemsItemVariantImageFile": { "docs": undefined, + "inline": true, "properties": { "contentType": { "docs": "The MIME type of the image", @@ -26181,6 +26599,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponsePurchasedItemsItemVariantImageFileVariantsItem": { "docs": undefined, + "inline": true, "properties": { "height": { "docs": "The image height in pixels", @@ -26212,6 +26631,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponsePurchasedItemsItemVariantPrice": { "docs": "The price corresponding to the variant", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -26232,6 +26652,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseShippingAddress": { "docs": "The shipping address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -26315,6 +26736,7 @@ Required scope | `ecommerce:write` "OrdersUpdateResponseStripeCard": { "docs": "Details on the card used to fulfill this order, if this order was finalized with Stripe. ", + "inline": true, "properties": { "brand": { "docs": "The card's brand (ie. credit card network)", @@ -26360,6 +26782,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseStripeCardExpires": { "docs": "The card's expiration date.", + "inline": true, "properties": { "month": { "docs": "Month that the card expires", @@ -26376,6 +26799,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseStripeDetails": { "docs": "An object with various Stripe IDs, useful for linking into the stripe dashboard.", + "inline": true, "properties": { "chargeId": { "docs": "Stripe-generated charge identifier, or null", @@ -26416,6 +26840,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseTotals": { "docs": "An object describing various pricing totals", + "inline": true, "properties": { "extras": { "docs": "An array of extra items, includes discounts, shipping, and taxes.", @@ -26436,6 +26861,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseTotalsExtrasItem": { "docs": "Extra order items, includes discounts, shipping, and taxes.", + "inline": true, "properties": { "description": { "docs": "A human-readable (but English) description of this extra charge.", @@ -26460,6 +26886,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseTotalsExtrasItemPrice": { "docs": "The price for the item", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -26495,6 +26922,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseTotalsSubtotal": { "docs": "The subtotal price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -26515,6 +26943,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseTotalsTotal": { "docs": "The total price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -26535,6 +26964,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponse": { "docs": undefined, + "inline": undefined, "properties": { "acceptedOn": { "docs": "The ISO8601 timestamp that an Order was placed.", @@ -26688,6 +27118,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseAllAddressesItem": { "docs": "A customer address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -26752,6 +27183,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseApplicationFee": { "docs": "The application fee assessed by the platform", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -26772,6 +27204,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseBillingAddress": { "docs": "The billing address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -26836,6 +27269,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseCustomerInfo": { "docs": "An object with the keys `fullName` and `email`.", + "inline": true, "properties": { "email": { "docs": "The Customer's email address", @@ -26858,6 +27292,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseCustomerPaid": { "docs": "The total paid by the customer", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -26895,6 +27330,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseDownloadFilesItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier for the downloadable file", @@ -26921,6 +27357,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseMetadata": { "docs": undefined, + "inline": true, "properties": { "isBuyNow": "optional", }, @@ -26930,6 +27367,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseNetAmount": { "docs": "The net amount after application fees", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -26950,6 +27388,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponsePaypalDetails": { "docs": undefined, + "inline": true, "properties": { "captureId": { "docs": "PayPal capture identifier", @@ -26982,6 +27421,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponsePurchasedItemsItem": { "docs": "An Item that was purchased", + "inline": true, "properties": { "count": { "docs": "Number of Item purchased.", @@ -27047,6 +27487,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponsePurchasedItemsItemRowTotal": { "docs": "The total for the row", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -27067,6 +27508,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponsePurchasedItemsItemVariantImage": { "docs": undefined, + "inline": true, "properties": { "file": "optional", "url": { @@ -27086,6 +27528,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponsePurchasedItemsItemVariantImageFile": { "docs": undefined, + "inline": true, "properties": { "contentType": { "docs": "The MIME type of the image", @@ -27122,6 +27565,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponsePurchasedItemsItemVariantImageFileVariantsItem": { "docs": undefined, + "inline": true, "properties": { "height": { "docs": "The image height in pixels", @@ -27153,6 +27597,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponsePurchasedItemsItemVariantPrice": { "docs": "The price corresponding to the variant", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -27173,6 +27618,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseShippingAddress": { "docs": "The shipping address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -27256,6 +27702,7 @@ Required scope | `ecommerce:write` "OrdersUpdateUnfulfillResponseStripeCard": { "docs": "Details on the card used to fulfill this order, if this order was finalized with Stripe. ", + "inline": true, "properties": { "brand": { "docs": "The card's brand (ie. credit card network)", @@ -27301,6 +27748,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseStripeCardExpires": { "docs": "The card's expiration date.", + "inline": true, "properties": { "month": { "docs": "Month that the card expires", @@ -27317,6 +27765,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseStripeDetails": { "docs": "An object with various Stripe IDs, useful for linking into the stripe dashboard.", + "inline": true, "properties": { "chargeId": { "docs": "Stripe-generated charge identifier, or null", @@ -27357,6 +27806,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseTotals": { "docs": "An object describing various pricing totals", + "inline": true, "properties": { "extras": { "docs": "An array of extra items, includes discounts, shipping, and taxes.", @@ -27377,6 +27827,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseTotalsExtrasItem": { "docs": "Extra order items, includes discounts, shipping, and taxes.", + "inline": true, "properties": { "description": { "docs": "A human-readable (but English) description of this extra charge.", @@ -27401,6 +27852,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseTotalsExtrasItemPrice": { "docs": "The price for the item", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -27436,6 +27888,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseTotalsSubtotal": { "docs": "The subtotal price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -27456,6 +27909,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseTotalsTotal": { "docs": "The total price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -27984,6 +28438,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemNetAmount: docs: The net amount after application fees properties: @@ -27998,6 +28453,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemApplicationFee: docs: The application fee assessed by the platform properties: @@ -28012,6 +28468,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemAllAddressesItemType: enum: - shipping @@ -28062,6 +28519,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemShippingAddressType: enum: - shipping @@ -28112,6 +28570,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemBillingAddressType: enum: - shipping @@ -28162,6 +28621,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemCustomerInfo: docs: An object with the keys `fullName` and `email`. properties: @@ -28175,6 +28635,7 @@ Required scope | `ecommerce:write` format: email source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemPurchasedItemsItemRowTotal: docs: The total for the row properties: @@ -28189,6 +28650,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemPurchasedItemsItemVariantImageFileVariantsItem: properties: url: @@ -28208,6 +28670,7 @@ Required scope | `ecommerce:write` docs: The image height in pixels source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemPurchasedItemsItemVariantImageFile: properties: size: @@ -28234,6 +28697,7 @@ Required scope | `ecommerce:write` docs: Variants of the supplied image source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemPurchasedItemsItemVariantImage: properties: url: @@ -28244,6 +28708,7 @@ Required scope | `ecommerce:write` file: optional source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemPurchasedItemsItemVariantPrice: docs: The price corresponding to the variant properties: @@ -28258,6 +28723,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemPurchasedItemsItem: docs: An Item that was purchased properties: @@ -28306,6 +28772,7 @@ Required scope | `ecommerce:write` docs: The physical length of the variant if provided, or null source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemStripeDetails: docs: >- An object with various Stripe IDs, useful for linking into the stripe @@ -28337,6 +28804,7 @@ Required scope | `ecommerce:write` docs: Stripe-generated refund reason, or null source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemStripeCardBrand: enum: - Visa @@ -28362,6 +28830,7 @@ Required scope | `ecommerce:write` docs: Month that the card expires source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemStripeCard: docs: > Details on the card used to fulfill this order, if this order was @@ -28381,6 +28850,7 @@ Required scope | `ecommerce:write` docs: The card's expiration date. source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemPaypalDetails: properties: orderId: @@ -28403,11 +28873,13 @@ Required scope | `ecommerce:write` docs: PayPal dispute identifier source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemMetadata: properties: isBuyNow: optional source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemTotalsSubtotal: docs: The subtotal price properties: @@ -28422,6 +28894,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemTotalsExtrasItemType: enum: - discount @@ -28446,6 +28919,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemTotalsExtrasItem: docs: Extra order items, includes discounts, shipping, and taxes. properties: @@ -28463,6 +28937,7 @@ Required scope | `ecommerce:write` docs: The price for the item source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemTotalsTotal: docs: The total price properties: @@ -28477,6 +28952,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemTotals: docs: An object describing various pricing totals properties: @@ -28491,6 +28967,7 @@ Required scope | `ecommerce:write` docs: The total price source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemDownloadFilesItem: properties: id: @@ -28506,6 +28983,7 @@ Required scope | `ecommerce:write` format: uri source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItem: properties: orderId: @@ -28642,6 +29120,7 @@ Required scope | `ecommerce:write` docs: An array of downloadable file objects. source: openapi: ../openapi.yml + inline: true OrdersListResponsePagination: docs: Pagination object properties: @@ -28656,6 +29135,7 @@ Required scope | `ecommerce:write` docs: The total number of records source: openapi: ../openapi.yml + inline: true OrdersListResponse: docs: Results from order list properties: @@ -28709,6 +29189,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersGetResponseNetAmount: docs: The net amount after application fees properties: @@ -28723,6 +29204,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersGetResponseApplicationFee: docs: The application fee assessed by the platform properties: @@ -28737,6 +29219,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersGetResponseAllAddressesItemType: enum: - shipping @@ -28787,6 +29270,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersGetResponseShippingAddressType: enum: - shipping @@ -28837,6 +29321,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersGetResponseBillingAddressType: enum: - shipping @@ -28887,6 +29372,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersGetResponseCustomerInfo: docs: An object with the keys `fullName` and `email`. properties: @@ -28900,6 +29386,7 @@ Required scope | `ecommerce:write` format: email source: openapi: ../openapi.yml + inline: true OrdersGetResponsePurchasedItemsItemRowTotal: docs: The total for the row properties: @@ -28914,6 +29401,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersGetResponsePurchasedItemsItemVariantImageFileVariantsItem: properties: url: @@ -28933,6 +29421,7 @@ Required scope | `ecommerce:write` docs: The image height in pixels source: openapi: ../openapi.yml + inline: true OrdersGetResponsePurchasedItemsItemVariantImageFile: properties: size: @@ -28959,6 +29448,7 @@ Required scope | `ecommerce:write` docs: Variants of the supplied image source: openapi: ../openapi.yml + inline: true OrdersGetResponsePurchasedItemsItemVariantImage: properties: url: @@ -28969,6 +29459,7 @@ Required scope | `ecommerce:write` file: optional source: openapi: ../openapi.yml + inline: true OrdersGetResponsePurchasedItemsItemVariantPrice: docs: The price corresponding to the variant properties: @@ -28983,6 +29474,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersGetResponsePurchasedItemsItem: docs: An Item that was purchased properties: @@ -29031,6 +29523,7 @@ Required scope | `ecommerce:write` docs: The physical length of the variant if provided, or null source: openapi: ../openapi.yml + inline: true OrdersGetResponseStripeDetails: docs: >- An object with various Stripe IDs, useful for linking into the stripe @@ -29062,6 +29555,7 @@ Required scope | `ecommerce:write` docs: Stripe-generated refund reason, or null source: openapi: ../openapi.yml + inline: true OrdersGetResponseStripeCardBrand: enum: - Visa @@ -29087,6 +29581,7 @@ Required scope | `ecommerce:write` docs: Month that the card expires source: openapi: ../openapi.yml + inline: true OrdersGetResponseStripeCard: docs: > Details on the card used to fulfill this order, if this order was @@ -29106,6 +29601,7 @@ Required scope | `ecommerce:write` docs: The card's expiration date. source: openapi: ../openapi.yml + inline: true OrdersGetResponsePaypalDetails: properties: orderId: @@ -29128,11 +29624,13 @@ Required scope | `ecommerce:write` docs: PayPal dispute identifier source: openapi: ../openapi.yml + inline: true OrdersGetResponseMetadata: properties: isBuyNow: optional source: openapi: ../openapi.yml + inline: true OrdersGetResponseTotalsSubtotal: docs: The subtotal price properties: @@ -29147,6 +29645,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersGetResponseTotalsExtrasItemType: enum: - discount @@ -29171,6 +29670,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersGetResponseTotalsExtrasItem: docs: Extra order items, includes discounts, shipping, and taxes. properties: @@ -29188,6 +29688,7 @@ Required scope | `ecommerce:write` docs: The price for the item source: openapi: ../openapi.yml + inline: true OrdersGetResponseTotalsTotal: docs: The total price properties: @@ -29202,6 +29703,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersGetResponseTotals: docs: An object describing various pricing totals properties: @@ -29216,6 +29718,7 @@ Required scope | `ecommerce:write` docs: The total price source: openapi: ../openapi.yml + inline: true OrdersGetResponseDownloadFilesItem: properties: id: @@ -29231,6 +29734,7 @@ Required scope | `ecommerce:write` format: uri source: openapi: ../openapi.yml + inline: true OrdersGetResponse: properties: orderId: @@ -29409,6 +29913,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseNetAmount: docs: The net amount after application fees properties: @@ -29423,6 +29928,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseApplicationFee: docs: The application fee assessed by the platform properties: @@ -29437,6 +29943,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseAllAddressesItemType: enum: - shipping @@ -29487,6 +29994,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseShippingAddressType: enum: - shipping @@ -29537,6 +30045,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseBillingAddressType: enum: - shipping @@ -29587,6 +30096,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseCustomerInfo: docs: An object with the keys `fullName` and `email`. properties: @@ -29600,6 +30110,7 @@ Required scope | `ecommerce:write` format: email source: openapi: ../openapi.yml + inline: true OrdersUpdateResponsePurchasedItemsItemRowTotal: docs: The total for the row properties: @@ -29614,6 +30125,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateResponsePurchasedItemsItemVariantImageFileVariantsItem: properties: url: @@ -29633,6 +30145,7 @@ Required scope | `ecommerce:write` docs: The image height in pixels source: openapi: ../openapi.yml + inline: true OrdersUpdateResponsePurchasedItemsItemVariantImageFile: properties: size: @@ -29659,6 +30172,7 @@ Required scope | `ecommerce:write` docs: Variants of the supplied image source: openapi: ../openapi.yml + inline: true OrdersUpdateResponsePurchasedItemsItemVariantImage: properties: url: @@ -29669,6 +30183,7 @@ Required scope | `ecommerce:write` file: optional source: openapi: ../openapi.yml + inline: true OrdersUpdateResponsePurchasedItemsItemVariantPrice: docs: The price corresponding to the variant properties: @@ -29683,6 +30198,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateResponsePurchasedItemsItem: docs: An Item that was purchased properties: @@ -29731,6 +30247,7 @@ Required scope | `ecommerce:write` docs: The physical length of the variant if provided, or null source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseStripeDetails: docs: >- An object with various Stripe IDs, useful for linking into the stripe @@ -29762,6 +30279,7 @@ Required scope | `ecommerce:write` docs: Stripe-generated refund reason, or null source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseStripeCardBrand: enum: - Visa @@ -29787,6 +30305,7 @@ Required scope | `ecommerce:write` docs: Month that the card expires source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseStripeCard: docs: > Details on the card used to fulfill this order, if this order was @@ -29806,6 +30325,7 @@ Required scope | `ecommerce:write` docs: The card's expiration date. source: openapi: ../openapi.yml + inline: true OrdersUpdateResponsePaypalDetails: properties: orderId: @@ -29828,11 +30348,13 @@ Required scope | `ecommerce:write` docs: PayPal dispute identifier source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseMetadata: properties: isBuyNow: optional source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseTotalsSubtotal: docs: The subtotal price properties: @@ -29847,6 +30369,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseTotalsExtrasItemType: enum: - discount @@ -29871,6 +30394,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseTotalsExtrasItem: docs: Extra order items, includes discounts, shipping, and taxes. properties: @@ -29888,6 +30412,7 @@ Required scope | `ecommerce:write` docs: The price for the item source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseTotalsTotal: docs: The total price properties: @@ -29902,6 +30427,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseTotals: docs: An object describing various pricing totals properties: @@ -29916,6 +30442,7 @@ Required scope | `ecommerce:write` docs: The total price source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseDownloadFilesItem: properties: id: @@ -29931,6 +30458,7 @@ Required scope | `ecommerce:write` format: uri source: openapi: ../openapi.yml + inline: true OrdersUpdateResponse: properties: orderId: @@ -30109,6 +30637,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseNetAmount: docs: The net amount after application fees properties: @@ -30123,6 +30652,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseApplicationFee: docs: The application fee assessed by the platform properties: @@ -30137,6 +30667,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseAllAddressesItemType: enum: - shipping @@ -30187,6 +30718,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseShippingAddressType: enum: - shipping @@ -30237,6 +30769,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseBillingAddressType: enum: - shipping @@ -30287,6 +30820,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseCustomerInfo: docs: An object with the keys `fullName` and `email`. properties: @@ -30300,6 +30834,7 @@ Required scope | `ecommerce:write` format: email source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponsePurchasedItemsItemRowTotal: docs: The total for the row properties: @@ -30314,6 +30849,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponsePurchasedItemsItemVariantImageFileVariantsItem: properties: url: @@ -30333,6 +30869,7 @@ Required scope | `ecommerce:write` docs: The image height in pixels source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponsePurchasedItemsItemVariantImageFile: properties: size: @@ -30359,6 +30896,7 @@ Required scope | `ecommerce:write` docs: Variants of the supplied image source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponsePurchasedItemsItemVariantImage: properties: url: @@ -30369,6 +30907,7 @@ Required scope | `ecommerce:write` file: optional source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponsePurchasedItemsItemVariantPrice: docs: The price corresponding to the variant properties: @@ -30383,6 +30922,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponsePurchasedItemsItem: docs: An Item that was purchased properties: @@ -30431,6 +30971,7 @@ Required scope | `ecommerce:write` docs: The physical length of the variant if provided, or null source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseStripeDetails: docs: >- An object with various Stripe IDs, useful for linking into the stripe @@ -30462,6 +31003,7 @@ Required scope | `ecommerce:write` docs: Stripe-generated refund reason, or null source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseStripeCardBrand: enum: - Visa @@ -30487,6 +31029,7 @@ Required scope | `ecommerce:write` docs: Month that the card expires source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseStripeCard: docs: > Details on the card used to fulfill this order, if this order was @@ -30506,6 +31049,7 @@ Required scope | `ecommerce:write` docs: The card's expiration date. source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponsePaypalDetails: properties: orderId: @@ -30528,11 +31072,13 @@ Required scope | `ecommerce:write` docs: PayPal dispute identifier source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseMetadata: properties: isBuyNow: optional source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseTotalsSubtotal: docs: The subtotal price properties: @@ -30547,6 +31093,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseTotalsExtrasItemType: enum: - discount @@ -30571,6 +31118,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseTotalsExtrasItem: docs: Extra order items, includes discounts, shipping, and taxes. properties: @@ -30588,6 +31136,7 @@ Required scope | `ecommerce:write` docs: The price for the item source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseTotalsTotal: docs: The total price properties: @@ -30602,6 +31151,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseTotals: docs: An object describing various pricing totals properties: @@ -30616,6 +31166,7 @@ Required scope | `ecommerce:write` docs: The total price source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseDownloadFilesItem: properties: id: @@ -30631,6 +31182,7 @@ Required scope | `ecommerce:write` format: uri source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponse: properties: orderId: @@ -30809,6 +31361,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseNetAmount: docs: The net amount after application fees properties: @@ -30823,6 +31376,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseApplicationFee: docs: The application fee assessed by the platform properties: @@ -30837,6 +31391,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseAllAddressesItemType: enum: - shipping @@ -30887,6 +31442,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseShippingAddressType: enum: - shipping @@ -30937,6 +31493,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseBillingAddressType: enum: - shipping @@ -30987,6 +31544,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseCustomerInfo: docs: An object with the keys `fullName` and `email`. properties: @@ -31000,6 +31558,7 @@ Required scope | `ecommerce:write` format: email source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponsePurchasedItemsItemRowTotal: docs: The total for the row properties: @@ -31014,6 +31573,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponsePurchasedItemsItemVariantImageFileVariantsItem: properties: url: @@ -31033,6 +31593,7 @@ Required scope | `ecommerce:write` docs: The image height in pixels source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponsePurchasedItemsItemVariantImageFile: properties: size: @@ -31059,6 +31620,7 @@ Required scope | `ecommerce:write` docs: Variants of the supplied image source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponsePurchasedItemsItemVariantImage: properties: url: @@ -31070,6 +31632,7 @@ Required scope | `ecommerce:write` optional source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponsePurchasedItemsItemVariantPrice: docs: The price corresponding to the variant properties: @@ -31084,6 +31647,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponsePurchasedItemsItem: docs: An Item that was purchased properties: @@ -31132,6 +31696,7 @@ Required scope | `ecommerce:write` docs: The physical length of the variant if provided, or null source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseStripeDetails: docs: >- An object with various Stripe IDs, useful for linking into the stripe @@ -31163,6 +31728,7 @@ Required scope | `ecommerce:write` docs: Stripe-generated refund reason, or null source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseStripeCardBrand: enum: - Visa @@ -31188,6 +31754,7 @@ Required scope | `ecommerce:write` docs: Month that the card expires source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseStripeCard: docs: > Details on the card used to fulfill this order, if this order was @@ -31207,6 +31774,7 @@ Required scope | `ecommerce:write` docs: The card's expiration date. source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponsePaypalDetails: properties: orderId: @@ -31229,11 +31797,13 @@ Required scope | `ecommerce:write` docs: PayPal dispute identifier source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseMetadata: properties: isBuyNow: optional source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseTotalsSubtotal: docs: The subtotal price properties: @@ -31248,6 +31818,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseTotalsExtrasItemType: enum: - discount @@ -31272,6 +31843,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseTotalsExtrasItem: docs: Extra order items, includes discounts, shipping, and taxes. properties: @@ -31289,6 +31861,7 @@ Required scope | `ecommerce:write` docs: The price for the item source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseTotalsTotal: docs: The total price properties: @@ -31303,6 +31876,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseTotals: docs: An object describing various pricing totals properties: @@ -31317,6 +31891,7 @@ Required scope | `ecommerce:write` docs: The total price source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseDownloadFilesItem: properties: id: @@ -31332,6 +31907,7 @@ Required scope | `ecommerce:write` format: uri source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponse: properties: orderId: @@ -31518,6 +32094,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersRefundResponseNetAmount: docs: The net amount after application fees properties: @@ -31532,6 +32109,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersRefundResponseApplicationFee: docs: The application fee assessed by the platform properties: @@ -31546,6 +32124,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersRefundResponseAllAddressesItemType: enum: - shipping @@ -31596,6 +32175,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersRefundResponseShippingAddressType: enum: - shipping @@ -31646,6 +32226,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersRefundResponseBillingAddressType: enum: - shipping @@ -31696,6 +32277,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersRefundResponseCustomerInfo: docs: An object with the keys `fullName` and `email`. properties: @@ -31709,6 +32291,7 @@ Required scope | `ecommerce:write` format: email source: openapi: ../openapi.yml + inline: true OrdersRefundResponsePurchasedItemsItemRowTotal: docs: The total for the row properties: @@ -31723,6 +32306,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersRefundResponsePurchasedItemsItemVariantImageFileVariantsItem: properties: url: @@ -31742,6 +32326,7 @@ Required scope | `ecommerce:write` docs: The image height in pixels source: openapi: ../openapi.yml + inline: true OrdersRefundResponsePurchasedItemsItemVariantImageFile: properties: size: @@ -31768,6 +32353,7 @@ Required scope | `ecommerce:write` docs: Variants of the supplied image source: openapi: ../openapi.yml + inline: true OrdersRefundResponsePurchasedItemsItemVariantImage: properties: url: @@ -31778,6 +32364,7 @@ Required scope | `ecommerce:write` file: optional source: openapi: ../openapi.yml + inline: true OrdersRefundResponsePurchasedItemsItemVariantPrice: docs: The price corresponding to the variant properties: @@ -31792,6 +32379,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersRefundResponsePurchasedItemsItem: docs: An Item that was purchased properties: @@ -31840,6 +32428,7 @@ Required scope | `ecommerce:write` docs: The physical length of the variant if provided, or null source: openapi: ../openapi.yml + inline: true OrdersRefundResponseStripeDetails: docs: >- An object with various Stripe IDs, useful for linking into the stripe @@ -31871,6 +32460,7 @@ Required scope | `ecommerce:write` docs: Stripe-generated refund reason, or null source: openapi: ../openapi.yml + inline: true OrdersRefundResponseStripeCardBrand: enum: - Visa @@ -31896,6 +32486,7 @@ Required scope | `ecommerce:write` docs: Month that the card expires source: openapi: ../openapi.yml + inline: true OrdersRefundResponseStripeCard: docs: > Details on the card used to fulfill this order, if this order was @@ -31915,6 +32506,7 @@ Required scope | `ecommerce:write` docs: The card's expiration date. source: openapi: ../openapi.yml + inline: true OrdersRefundResponsePaypalDetails: properties: orderId: @@ -31937,11 +32529,13 @@ Required scope | `ecommerce:write` docs: PayPal dispute identifier source: openapi: ../openapi.yml + inline: true OrdersRefundResponseMetadata: properties: isBuyNow: optional source: openapi: ../openapi.yml + inline: true OrdersRefundResponseTotalsSubtotal: docs: The subtotal price properties: @@ -31956,6 +32550,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersRefundResponseTotalsExtrasItemType: enum: - discount @@ -31980,6 +32575,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersRefundResponseTotalsExtrasItem: docs: Extra order items, includes discounts, shipping, and taxes. properties: @@ -31997,6 +32593,7 @@ Required scope | `ecommerce:write` docs: The price for the item source: openapi: ../openapi.yml + inline: true OrdersRefundResponseTotalsTotal: docs: The total price properties: @@ -32011,6 +32608,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersRefundResponseTotals: docs: An object describing various pricing totals properties: @@ -32025,6 +32623,7 @@ Required scope | `ecommerce:write` docs: The total price source: openapi: ../openapi.yml + inline: true OrdersRefundResponseDownloadFilesItem: properties: id: @@ -32040,6 +32639,7 @@ Required scope | `ecommerce:write` format: uri source: openapi: ../openapi.yml + inline: true OrdersRefundResponse: properties: orderId: @@ -32218,6 +32818,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadNetAmount: docs: The net amount after application fees properties: @@ -32232,6 +32833,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadApplicationFee: docs: The application fee assessed by the platform properties: @@ -32246,6 +32848,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadAllAddressesItemType: enum: - shipping @@ -32296,6 +32899,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadShippingAddressType: enum: - shipping @@ -32346,6 +32950,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadBillingAddressType: enum: - shipping @@ -32396,6 +33001,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadCustomerInfo: docs: An object with the keys `fullName` and `email`. properties: @@ -32409,6 +33015,7 @@ Required scope | `ecommerce:write` format: email source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadPurchasedItemsItemRowTotal: docs: The total for the row properties: @@ -32423,6 +33030,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadPurchasedItemsItemVariantImageFileVariantsItem: properties: url: @@ -32442,6 +33050,7 @@ Required scope | `ecommerce:write` docs: The image height in pixels source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadPurchasedItemsItemVariantImageFile: properties: size: @@ -32468,6 +33077,7 @@ Required scope | `ecommerce:write` docs: Variants of the supplied image source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadPurchasedItemsItemVariantImage: properties: url: @@ -32478,6 +33088,7 @@ Required scope | `ecommerce:write` file: optional source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadPurchasedItemsItemVariantPrice: docs: The price corresponding to the variant properties: @@ -32492,6 +33103,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadPurchasedItemsItem: docs: An Item that was purchased properties: @@ -32540,6 +33152,7 @@ Required scope | `ecommerce:write` docs: The physical length of the variant if provided, or null source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadStripeDetails: docs: >- An object with various Stripe IDs, useful for linking into the stripe @@ -32571,6 +33184,7 @@ Required scope | `ecommerce:write` docs: Stripe-generated refund reason, or null source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadStripeCardBrand: enum: - Visa @@ -32596,6 +33210,7 @@ Required scope | `ecommerce:write` docs: Month that the card expires source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadStripeCard: docs: > Details on the card used to fulfill this order, if this order was @@ -32615,6 +33230,7 @@ Required scope | `ecommerce:write` docs: The card's expiration date. source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadPaypalDetails: properties: orderId: @@ -32637,11 +33253,13 @@ Required scope | `ecommerce:write` docs: PayPal dispute identifier source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadMetadata: properties: isBuyNow: optional source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadTotalsSubtotal: docs: The subtotal price properties: @@ -32656,6 +33274,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadTotalsExtrasItemType: enum: - discount @@ -32680,6 +33299,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadTotalsExtrasItem: docs: Extra order items, includes discounts, shipping, and taxes. properties: @@ -32697,6 +33317,7 @@ Required scope | `ecommerce:write` docs: The price for the item source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadTotalsTotal: docs: The total price properties: @@ -32711,6 +33332,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadTotals: docs: An object describing various pricing totals properties: @@ -32725,6 +33347,7 @@ Required scope | `ecommerce:write` docs: The total price source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadDownloadFilesItem: properties: id: @@ -32740,6 +33363,7 @@ Required scope | `ecommerce:write` format: uri source: openapi: ../openapi.yml + inline: true EcommNewOrderPayload: properties: orderId: @@ -32918,6 +33542,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadNetAmount: docs: The net amount after application fees properties: @@ -32932,6 +33557,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadApplicationFee: docs: The application fee assessed by the platform properties: @@ -32946,6 +33572,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadAllAddressesItemType: enum: - shipping @@ -32996,6 +33623,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadShippingAddressType: enum: - shipping @@ -33046,6 +33674,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadBillingAddressType: enum: - shipping @@ -33096,6 +33725,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadCustomerInfo: docs: An object with the keys `fullName` and `email`. properties: @@ -33109,6 +33739,7 @@ Required scope | `ecommerce:write` format: email source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadPurchasedItemsItemRowTotal: docs: The total for the row properties: @@ -33123,6 +33754,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadPurchasedItemsItemVariantImageFileVariantsItem: properties: url: @@ -33142,6 +33774,7 @@ Required scope | `ecommerce:write` docs: The image height in pixels source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadPurchasedItemsItemVariantImageFile: properties: size: @@ -33168,6 +33801,7 @@ Required scope | `ecommerce:write` docs: Variants of the supplied image source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadPurchasedItemsItemVariantImage: properties: url: @@ -33178,6 +33812,7 @@ Required scope | `ecommerce:write` file: optional source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadPurchasedItemsItemVariantPrice: docs: The price corresponding to the variant properties: @@ -33192,6 +33827,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadPurchasedItemsItem: docs: An Item that was purchased properties: @@ -33240,6 +33876,7 @@ Required scope | `ecommerce:write` docs: The physical length of the variant if provided, or null source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadStripeDetails: docs: >- An object with various Stripe IDs, useful for linking into the stripe @@ -33271,6 +33908,7 @@ Required scope | `ecommerce:write` docs: Stripe-generated refund reason, or null source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadStripeCardBrand: enum: - Visa @@ -33296,6 +33934,7 @@ Required scope | `ecommerce:write` docs: Month that the card expires source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadStripeCard: docs: > Details on the card used to fulfill this order, if this order was @@ -33315,6 +33954,7 @@ Required scope | `ecommerce:write` docs: The card's expiration date. source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadPaypalDetails: properties: orderId: @@ -33337,11 +33977,13 @@ Required scope | `ecommerce:write` docs: PayPal dispute identifier source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadMetadata: properties: isBuyNow: optional source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadTotalsSubtotal: docs: The subtotal price properties: @@ -33356,6 +33998,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadTotalsExtrasItemType: enum: - discount @@ -33380,6 +34023,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadTotalsExtrasItem: docs: Extra order items, includes discounts, shipping, and taxes. properties: @@ -33397,6 +34041,7 @@ Required scope | `ecommerce:write` docs: The price for the item source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadTotalsTotal: docs: The total price properties: @@ -33411,6 +34056,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadTotals: docs: An object describing various pricing totals properties: @@ -33425,6 +34071,7 @@ Required scope | `ecommerce:write` docs: The total price source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadDownloadFilesItem: properties: id: @@ -33440,6 +34087,7 @@ Required scope | `ecommerce:write` format: uri source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayload: properties: orderId: @@ -36002,6 +36650,7 @@ Required scope | `pages:write` "types": { "PageCreatedPayload": { "docs": "The Webhook payload for when a Page is created", + "inline": undefined, "properties": { "payload": { "docs": "The payload of data sent from Webflow", @@ -36018,6 +36667,7 @@ Required scope | `pages:write` }, "PageCreatedPayloadPayload": { "docs": "The payload of data sent from Webflow", + "inline": true, "properties": { "createdOn": "optional", "pageId": "optional", @@ -36030,6 +36680,7 @@ Required scope | `pages:write` }, "PageDeletedPayload": { "docs": "The Webhook payload for when a Page is deleted", + "inline": undefined, "properties": { "payload": { "docs": "The payload of data sent from Webflow", @@ -36046,6 +36697,7 @@ Required scope | `pages:write` }, "PageDeletedPayloadPayload": { "docs": "The payload of data sent from Webflow", + "inline": true, "properties": { "deletedOn": "optional", "pageId": "optional", @@ -36058,6 +36710,7 @@ Required scope | `pages:write` }, "PageMetadataUpdatedPayload": { "docs": "The Webhook payload for when a Page's metadata is updated", + "inline": undefined, "properties": { "payload": { "docs": "The payload of data sent from Webflow", @@ -36074,6 +36727,7 @@ Required scope | `pages:write` }, "PageMetadataUpdatedPayloadPayload": { "docs": "The payload of data sent from Webflow", + "inline": true, "properties": { "lastUpdated": "optional", "pageId": "optional", @@ -36087,6 +36741,7 @@ Required scope | `pages:write` "PagesGetContentResponse": { "docs": "The DOM (Document Object Model) schema represents the content structure of a web page. It captures various content nodes, such as text and images, along with their associated attributes. Each node has a unique identifier and can be of different types like text or image. The schema also provides pagination details for scenarios where the content nodes are too many to be fetched in a single request. ", + "inline": undefined, "properties": { "nodes": "optional>", "pageId": { @@ -36105,6 +36760,7 @@ Required scope | `pages:write` "PagesGetContentResponseNodesItem": { "docs": "A generic representation of a content element within the Document Object Model (DOM). Each node has a unique identifier and a specific type that determines its content structure and attributes. ", + "inline": true, "properties": { "attributes": { "docs": "The custom attributes of the node", @@ -36133,6 +36789,7 @@ Required scope | `pages:write` "PagesGetContentResponseNodesItemImage": { "docs": "Represents an image within the DOM. It contains details about the image, such as its alternative text (alt) for accessibility and an asset identifier for fetching the actual image resource. Additional attributes can be associated with the image for styling or other purposes. ", + "inline": true, "properties": { "alt": "optional", "assetId": "optional", @@ -36144,6 +36801,7 @@ Required scope | `pages:write` "PagesGetContentResponseNodesItemText": { "docs": "Represents textual content within the DOM. It contains both the raw text and its HTML representation, allowing for flexibility in rendering and processing. Additional attributes can be associated with the text for styling or other purposes. ", + "inline": true, "properties": { "html": "optional", "text": "optional", @@ -36163,6 +36821,7 @@ Required scope | `pages:write` }, "PagesGetContentResponsePagination": { "docs": "Pagination object", + "inline": true, "properties": { "limit": { "docs": "The limit used for pagination", @@ -36183,6 +36842,7 @@ Required scope | `pages:write` }, "PagesGetMetadataResponse": { "docs": "The Page object", + "inline": undefined, "properties": { "archived": { "default": false, @@ -36259,6 +36919,7 @@ Required scope | `pages:write` }, "PagesGetMetadataResponseOpenGraph": { "docs": "Open Graph fields for the Page", + "inline": true, "properties": { "description": { "docs": "The description supplied to Open Graph annotations", @@ -36285,6 +36946,7 @@ Required scope | `pages:write` }, "PagesGetMetadataResponseSeo": { "docs": "SEO-related fields for the Page", + "inline": true, "properties": { "description": { "docs": "The Page description shown in search engine results", @@ -36301,6 +36963,7 @@ Required scope | `pages:write` }, "PagesListResponse": { "docs": "The Page object", + "inline": undefined, "properties": { "pages": "optional>", "pagination": { @@ -36314,6 +36977,7 @@ Required scope | `pages:write` }, "PagesListResponsePagesItem": { "docs": "The Page object", + "inline": true, "properties": { "archived": { "default": false, @@ -36390,6 +37054,7 @@ Required scope | `pages:write` }, "PagesListResponsePagesItemOpenGraph": { "docs": "Open Graph fields for the Page", + "inline": true, "properties": { "description": { "docs": "The description supplied to Open Graph annotations", @@ -36416,6 +37081,7 @@ Required scope | `pages:write` }, "PagesListResponsePagesItemSeo": { "docs": "SEO-related fields for the Page", + "inline": true, "properties": { "description": { "docs": "The Page description shown in search engine results", @@ -36432,6 +37098,7 @@ Required scope | `pages:write` }, "PagesListResponsePagination": { "docs": "Pagination object", + "inline": true, "properties": { "limit": { "docs": "The limit used for pagination", @@ -36452,6 +37119,7 @@ Required scope | `pages:write` }, "UpdatePageSettingsRequestOpenGraph": { "docs": "Open Graph fields for the Page", + "inline": true, "properties": { "description": { "docs": "The description supplied to Open Graph annotations", @@ -36478,6 +37146,7 @@ Required scope | `pages:write` }, "UpdatePageSettingsRequestSeo": { "docs": "SEO-related fields for the Page", + "inline": true, "properties": { "description": { "docs": "The Page description shown in search engine results", @@ -36494,6 +37163,7 @@ Required scope | `pages:write` }, "UpdatePageSettingsResponse": { "docs": "The Page object", + "inline": undefined, "properties": { "archived": { "default": false, @@ -36570,6 +37240,7 @@ Required scope | `pages:write` }, "UpdatePageSettingsResponseOpenGraph": { "docs": "Open Graph fields for the Page", + "inline": true, "properties": { "description": { "docs": "The description supplied to Open Graph annotations", @@ -36596,6 +37267,7 @@ Required scope | `pages:write` }, "UpdatePageSettingsResponseSeo": { "docs": "SEO-related fields for the Page", + "inline": true, "properties": { "description": { "docs": "The Page description shown in search engine results", @@ -36612,6 +37284,7 @@ Required scope | `pages:write` }, "UpdateStaticContentRequestNodesItem": { "docs": undefined, + "inline": true, "properties": { "nodeId": { "docs": "Node UUID", @@ -36628,6 +37301,7 @@ Required scope | `pages:write` }, "UpdateStaticContentResponse": { "docs": undefined, + "inline": undefined, "properties": { "errors": { "docs": "A list of error messages, if any.", @@ -36726,6 +37400,7 @@ Required scope | `pages:write` docs: The Page description shown in search engine results source: openapi: ../openapi.yml + inline: true PagesListResponsePagesItemOpenGraph: docs: Open Graph fields for the Page properties: @@ -36747,6 +37422,7 @@ Required scope | `pages:write` default: true source: openapi: ../openapi.yml + inline: true PagesListResponsePagesItem: docs: The Page object properties: @@ -36810,6 +37486,7 @@ Required scope | `pages:write` docs: Relative path of the published page URL source: openapi: ../openapi.yml + inline: true PagesListResponsePagination: docs: Pagination object properties: @@ -36824,6 +37501,7 @@ Required scope | `pages:write` docs: The total number of records source: openapi: ../openapi.yml + inline: true PagesListResponse: docs: The Page object properties: @@ -36844,6 +37522,7 @@ Required scope | `pages:write` docs: The Page description shown in search engine results source: openapi: ../openapi.yml + inline: true PagesGetMetadataResponseOpenGraph: docs: Open Graph fields for the Page properties: @@ -36865,6 +37544,7 @@ Required scope | `pages:write` default: true source: openapi: ../openapi.yml + inline: true PagesGetMetadataResponse: docs: The Page object properties: @@ -36939,6 +37619,7 @@ Required scope | `pages:write` docs: The Page description shown in search engine results source: openapi: ../openapi.yml + inline: true UpdatePageSettingsRequestOpenGraph: docs: Open Graph fields for the Page properties: @@ -36960,6 +37641,7 @@ Required scope | `pages:write` default: true source: openapi: ../openapi.yml + inline: true UpdatePageSettingsResponseSeo: docs: SEO-related fields for the Page properties: @@ -36971,6 +37653,7 @@ Required scope | `pages:write` docs: The Page description shown in search engine results source: openapi: ../openapi.yml + inline: true UpdatePageSettingsResponseOpenGraph: docs: Open Graph fields for the Page properties: @@ -36992,6 +37675,7 @@ Required scope | `pages:write` default: true source: openapi: ../openapi.yml + inline: true UpdatePageSettingsResponse: docs: The Page object properties: @@ -37072,6 +37756,7 @@ Required scope | `pages:write` text: optional source: openapi: ../openapi.yml + inline: true PagesGetContentResponseNodesItemImage: docs: > Represents an image within the DOM. It contains details about the image, @@ -37083,6 +37768,7 @@ Required scope | `pages:write` assetId: optional source: openapi: ../openapi.yml + inline: true PagesGetContentResponseNodesItem: docs: > A generic representation of a content element within the Document Object @@ -37113,6 +37799,7 @@ Required scope | `pages:write` docs: The custom attributes of the node source: openapi: ../openapi.yml + inline: true PagesGetContentResponsePagination: docs: Pagination object properties: @@ -37127,6 +37814,7 @@ Required scope | `pages:write` docs: The total number of records source: openapi: ../openapi.yml + inline: true PagesGetContentResponse: docs: > The DOM (Document Object Model) schema represents the content structure of @@ -37157,6 +37845,7 @@ Required scope | `pages:write` be the same as what's returned from the Get Content endpoint. source: openapi: ../openapi.yml + inline: true UpdateStaticContentResponse: properties: errors: @@ -37173,6 +37862,7 @@ Required scope | `pages:write` createdOn: optional source: openapi: ../openapi.yml + inline: true PageCreatedPayload: docs: The Webhook payload for when a Page is created properties: @@ -37193,6 +37883,7 @@ Required scope | `pages:write` lastUpdated: optional source: openapi: ../openapi.yml + inline: true PageMetadataUpdatedPayload: docs: The Webhook payload for when a Page's metadata is updated properties: @@ -37213,6 +37904,7 @@ Required scope | `pages:write` deletedOn: optional source: openapi: ../openapi.yml + inline: true PageDeletedPayload: docs: The Webhook payload for when a Page is deleted properties: @@ -37876,6 +38568,7 @@ webhooks: "types": { "ScriptsGetCustomCodeResponse": { "docs": undefined, + "inline": undefined, "properties": { "createdOn": { "docs": "Date when the Site's scripts were created", @@ -37896,6 +38589,7 @@ webhooks: }, "ScriptsGetCustomCodeResponseScriptsItem": { "docs": undefined, + "inline": true, "properties": { "attributes": { "docs": "Developer-specified key/value pairs to be applied as attributes to the script", @@ -37932,6 +38626,7 @@ webhooks: }, "ScriptsUpsertCustomCodeRequestScriptsItem": { "docs": undefined, + "inline": true, "properties": { "attributes": { "docs": "Developer-specified key/value pairs to be applied as attributes to the script", @@ -37968,6 +38663,7 @@ webhooks: }, "ScriptsUpsertCustomCodeResponse": { "docs": undefined, + "inline": undefined, "properties": { "createdOn": { "docs": "Date when the Site's scripts were created", @@ -37988,6 +38684,7 @@ webhooks: }, "ScriptsUpsertCustomCodeResponseScriptsItem": { "docs": undefined, + "inline": true, "properties": { "attributes": { "docs": "Developer-specified key/value pairs to be applied as attributes to the script", @@ -38056,6 +38753,7 @@ webhooks: script source: openapi: ../openapi.yml + inline: true ScriptsGetCustomCodeResponse: properties: scripts: @@ -38100,6 +38798,7 @@ webhooks: script source: openapi: ../openapi.yml + inline: true ScriptsUpsertCustomCodeResponseScriptsItemLocation: enum: - header @@ -38131,6 +38830,7 @@ webhooks: script source: openapi: ../openapi.yml + inline: true ScriptsUpsertCustomCodeResponse: properties: scripts: @@ -39096,6 +39796,7 @@ Required scope | `ecommerce:write` "types": { "ProductsCreateRequestProduct": { "docs": "The Product object", + "inline": true, "properties": { "fieldData": { "docs": "Contains content-specific details for a product, covering both standard (e.g., title, description) and custom fields tailored to the product setup.", @@ -39108,6 +39809,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateRequestProductFieldData": { "docs": "Contains content-specific details for a product, covering both standard (e.g., title, description) and custom fields tailored to the product setup.", + "inline": true, "properties": { "categories": { "docs": "The categories your product belongs to.", @@ -39164,6 +39866,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateRequestProductFieldDataSkuPropertiesItem": { "docs": "A variant/option type for a SKU", + "inline": true, "properties": { "enum": { "docs": "The individual Product variants that are contained within the collection", @@ -39184,6 +39887,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateRequestProductFieldDataSkuPropertiesItemEnumItem": { "docs": "Enumerated Product variants/Options for the SKU", + "inline": true, "properties": { "id": { "docs": "Unique identifier for a Product variant/Option", @@ -39336,6 +40040,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateRequestSku": { "docs": "The SKU object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -39368,6 +40073,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateRequestSkuFieldData": { "docs": "Standard and Custom fields for a SKU", + "inline": true, "properties": { "compare-at-price": { "docs": "comparison price of SKU", @@ -39408,6 +40114,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateRequestSkuFieldDataCompareAtPrice": { "docs": "comparison price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -39436,6 +40143,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateRequestSkuFieldDataEcSkuSubscriptionPlan": { "docs": undefined, + "inline": true, "properties": { "frequency": { "docs": "Frequncy of billing within interval", @@ -39469,6 +40177,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateRequestSkuFieldDataEcSkuSubscriptionPlanPlansItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier of the plan", @@ -39500,6 +40209,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateRequestSkuFieldDataPrice": { "docs": "price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -39516,6 +40226,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateResponse": { "docs": "A product and its SKUs.", + "inline": undefined, "properties": { "product": { "docs": "The Product object", @@ -39532,6 +40243,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateResponseProduct": { "docs": "The Product object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -39574,6 +40286,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateResponseProductFieldData": { "docs": "Contains content-specific details for a product, covering both standard (e.g., title, description) and custom fields tailored to the product setup.", + "inline": true, "properties": { "categories": { "docs": "The categories your product belongs to.", @@ -39630,6 +40343,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateResponseProductFieldDataSkuPropertiesItem": { "docs": "A variant/option type for a SKU", + "inline": true, "properties": { "enum": { "docs": "The individual Product variants that are contained within the collection", @@ -39650,6 +40364,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateResponseProductFieldDataSkuPropertiesItemEnumItem": { "docs": "Enumerated Product variants/Options for the SKU", + "inline": true, "properties": { "id": { "docs": "Unique identifier for a Product variant/Option", @@ -39791,6 +40506,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateResponseSkusItem": { "docs": "The SKU object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -39823,6 +40539,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateResponseSkusItemFieldData": { "docs": "Standard and Custom fields for a SKU", + "inline": true, "properties": { "compare-at-price": { "docs": "comparison price of SKU", @@ -39863,6 +40580,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateResponseSkusItemFieldDataCompareAtPrice": { "docs": "comparison price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -39891,6 +40609,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateResponseSkusItemFieldDataEcSkuSubscriptionPlan": { "docs": undefined, + "inline": true, "properties": { "frequency": { "docs": "Frequncy of billing within interval", @@ -39924,6 +40643,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateResponseSkusItemFieldDataEcSkuSubscriptionPlanPlansItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier of the plan", @@ -39955,6 +40675,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateResponseSkusItemFieldDataPrice": { "docs": "price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -39982,6 +40703,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuRequestSkusItem": { "docs": "The SKU object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -40014,6 +40736,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuRequestSkusItemFieldData": { "docs": "Standard and Custom fields for a SKU", + "inline": true, "properties": { "compare-at-price": { "docs": "comparison price of SKU", @@ -40054,6 +40777,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuRequestSkusItemFieldDataCompareAtPrice": { "docs": "comparison price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -40082,6 +40806,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuRequestSkusItemFieldDataEcSkuSubscriptionPlan": { "docs": undefined, + "inline": true, "properties": { "frequency": { "docs": "Frequncy of billing within interval", @@ -40115,6 +40840,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuRequestSkusItemFieldDataEcSkuSubscriptionPlanPlansItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier of the plan", @@ -40146,6 +40872,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuRequestSkusItemFieldDataPrice": { "docs": "price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -40162,6 +40889,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuResponse": { "docs": undefined, + "inline": undefined, "properties": { "skus": "optional>", }, @@ -40171,6 +40899,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuResponseSkusItem": { "docs": "The SKU object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -40203,6 +40932,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuResponseSkusItemFieldData": { "docs": "Standard and Custom fields for a SKU", + "inline": true, "properties": { "compare-at-price": { "docs": "comparison price of SKU", @@ -40243,6 +40973,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuResponseSkusItemFieldDataCompareAtPrice": { "docs": "comparison price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -40271,6 +41002,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuResponseSkusItemFieldDataEcSkuSubscriptionPlan": { "docs": undefined, + "inline": true, "properties": { "frequency": { "docs": "Frequncy of billing within interval", @@ -40304,6 +41036,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuResponseSkusItemFieldDataEcSkuSubscriptionPlanPlansItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier of the plan", @@ -40335,6 +41068,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuResponseSkusItemFieldDataPrice": { "docs": "price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -40351,6 +41085,7 @@ Required scope | `ecommerce:write` }, "ProductsGetResponse": { "docs": "A product and its SKUs.", + "inline": undefined, "properties": { "product": { "docs": "The Product object", @@ -40367,6 +41102,7 @@ Required scope | `ecommerce:write` }, "ProductsGetResponseProduct": { "docs": "The Product object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -40409,6 +41145,7 @@ Required scope | `ecommerce:write` }, "ProductsGetResponseProductFieldData": { "docs": "Contains content-specific details for a product, covering both standard (e.g., title, description) and custom fields tailored to the product setup.", + "inline": true, "properties": { "categories": { "docs": "The categories your product belongs to.", @@ -40465,6 +41202,7 @@ Required scope | `ecommerce:write` }, "ProductsGetResponseProductFieldDataSkuPropertiesItem": { "docs": "A variant/option type for a SKU", + "inline": true, "properties": { "enum": { "docs": "The individual Product variants that are contained within the collection", @@ -40485,6 +41223,7 @@ Required scope | `ecommerce:write` }, "ProductsGetResponseProductFieldDataSkuPropertiesItemEnumItem": { "docs": "Enumerated Product variants/Options for the SKU", + "inline": true, "properties": { "id": { "docs": "Unique identifier for a Product variant/Option", @@ -40626,6 +41365,7 @@ Required scope | `ecommerce:write` }, "ProductsGetResponseSkusItem": { "docs": "The SKU object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -40658,6 +41398,7 @@ Required scope | `ecommerce:write` }, "ProductsGetResponseSkusItemFieldData": { "docs": "Standard and Custom fields for a SKU", + "inline": true, "properties": { "compare-at-price": { "docs": "comparison price of SKU", @@ -40698,6 +41439,7 @@ Required scope | `ecommerce:write` }, "ProductsGetResponseSkusItemFieldDataCompareAtPrice": { "docs": "comparison price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -40726,6 +41468,7 @@ Required scope | `ecommerce:write` }, "ProductsGetResponseSkusItemFieldDataEcSkuSubscriptionPlan": { "docs": undefined, + "inline": true, "properties": { "frequency": { "docs": "Frequncy of billing within interval", @@ -40759,6 +41502,7 @@ Required scope | `ecommerce:write` }, "ProductsGetResponseSkusItemFieldDataEcSkuSubscriptionPlanPlansItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier of the plan", @@ -40790,6 +41534,7 @@ Required scope | `ecommerce:write` }, "ProductsGetResponseSkusItemFieldDataPrice": { "docs": "price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -40806,6 +41551,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponse": { "docs": "Results from product list", + "inline": undefined, "properties": { "items": { "docs": "List of Item objects within the Collection. Contains product and skus keys for each Item", @@ -40822,6 +41568,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponseItemsItem": { "docs": "A product and its SKUs.", + "inline": true, "properties": { "product": { "docs": "The Product object", @@ -40838,6 +41585,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponseItemsItemProduct": { "docs": "The Product object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -40880,6 +41628,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponseItemsItemProductFieldData": { "docs": "Contains content-specific details for a product, covering both standard (e.g., title, description) and custom fields tailored to the product setup.", + "inline": true, "properties": { "categories": { "docs": "The categories your product belongs to.", @@ -40936,6 +41685,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponseItemsItemProductFieldDataSkuPropertiesItem": { "docs": "A variant/option type for a SKU", + "inline": true, "properties": { "enum": { "docs": "The individual Product variants that are contained within the collection", @@ -40956,6 +41706,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponseItemsItemProductFieldDataSkuPropertiesItemEnumItem": { "docs": "Enumerated Product variants/Options for the SKU", + "inline": true, "properties": { "id": { "docs": "Unique identifier for a Product variant/Option", @@ -41097,6 +41848,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponseItemsItemSkusItem": { "docs": "The SKU object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -41129,6 +41881,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponseItemsItemSkusItemFieldData": { "docs": "Standard and Custom fields for a SKU", + "inline": true, "properties": { "compare-at-price": { "docs": "comparison price of SKU", @@ -41169,6 +41922,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponseItemsItemSkusItemFieldDataCompareAtPrice": { "docs": "comparison price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -41197,6 +41951,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponseItemsItemSkusItemFieldDataEcSkuSubscriptionPlan": { "docs": undefined, + "inline": true, "properties": { "frequency": { "docs": "Frequncy of billing within interval", @@ -41230,6 +41985,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponseItemsItemSkusItemFieldDataEcSkuSubscriptionPlanPlansItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier of the plan", @@ -41261,6 +42017,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponseItemsItemSkusItemFieldDataPrice": { "docs": "price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -41277,6 +42034,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponsePagination": { "docs": "Pagination object", + "inline": true, "properties": { "limit": { "docs": "The limit used for pagination", @@ -41297,6 +42055,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateRequestProduct": { "docs": "The Product object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -41339,6 +42098,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateRequestProductFieldData": { "docs": "Contains content-specific details for a product, covering both standard (e.g., title, description) and custom fields tailored to the product setup.", + "inline": true, "properties": { "categories": { "docs": "The categories your product belongs to.", @@ -41395,6 +42155,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateRequestProductFieldDataSkuPropertiesItem": { "docs": "A variant/option type for a SKU", + "inline": true, "properties": { "enum": { "docs": "The individual Product variants that are contained within the collection", @@ -41415,6 +42176,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateRequestProductFieldDataSkuPropertiesItemEnumItem": { "docs": "Enumerated Product variants/Options for the SKU", + "inline": true, "properties": { "id": { "docs": "Unique identifier for a Product variant/Option", @@ -41567,6 +42329,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateRequestSku": { "docs": "The SKU object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -41599,6 +42362,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateRequestSkuFieldData": { "docs": "Standard and Custom fields for a SKU", + "inline": true, "properties": { "compare-at-price": { "docs": "comparison price of SKU", @@ -41639,6 +42403,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateRequestSkuFieldDataCompareAtPrice": { "docs": "comparison price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -41667,6 +42432,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateRequestSkuFieldDataEcSkuSubscriptionPlan": { "docs": undefined, + "inline": true, "properties": { "frequency": { "docs": "Frequncy of billing within interval", @@ -41700,6 +42466,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateRequestSkuFieldDataEcSkuSubscriptionPlanPlansItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier of the plan", @@ -41731,6 +42498,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateRequestSkuFieldDataPrice": { "docs": "price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -41747,6 +42515,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateResponse": { "docs": "The Product object", + "inline": undefined, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -41789,6 +42558,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateResponseFieldData": { "docs": "Contains content-specific details for a product, covering both standard (e.g., title, description) and custom fields tailored to the product setup.", + "inline": true, "properties": { "categories": { "docs": "The categories your product belongs to.", @@ -41845,6 +42615,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateResponseFieldDataSkuPropertiesItem": { "docs": "A variant/option type for a SKU", + "inline": true, "properties": { "enum": { "docs": "The individual Product variants that are contained within the collection", @@ -41865,6 +42636,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateResponseFieldDataSkuPropertiesItemEnumItem": { "docs": "Enumerated Product variants/Options for the SKU", + "inline": true, "properties": { "id": { "docs": "Unique identifier for a Product variant/Option", @@ -42017,6 +42789,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuRequestSku": { "docs": "The SKU object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -42049,6 +42822,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuRequestSkuFieldData": { "docs": "Standard and Custom fields for a SKU", + "inline": true, "properties": { "compare-at-price": { "docs": "comparison price of SKU", @@ -42089,6 +42863,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuRequestSkuFieldDataCompareAtPrice": { "docs": "comparison price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -42117,6 +42892,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuRequestSkuFieldDataEcSkuSubscriptionPlan": { "docs": undefined, + "inline": true, "properties": { "frequency": { "docs": "Frequncy of billing within interval", @@ -42150,6 +42926,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuRequestSkuFieldDataEcSkuSubscriptionPlanPlansItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier of the plan", @@ -42181,6 +42958,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuRequestSkuFieldDataPrice": { "docs": "price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -42197,6 +42975,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuResponse": { "docs": "The SKU object", + "inline": undefined, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -42229,6 +43008,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuResponseFieldData": { "docs": "Standard and Custom fields for a SKU", + "inline": true, "properties": { "compare-at-price": { "docs": "comparison price of SKU", @@ -42269,6 +43049,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuResponseFieldDataCompareAtPrice": { "docs": "comparison price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -42297,6 +43078,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuResponseFieldDataEcSkuSubscriptionPlan": { "docs": undefined, + "inline": true, "properties": { "frequency": { "docs": "Frequncy of billing within interval", @@ -42330,6 +43112,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuResponseFieldDataEcSkuSubscriptionPlanPlansItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier of the plan", @@ -42361,6 +43144,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuResponseFieldDataPrice": { "docs": "price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -42392,6 +43176,7 @@ Required scope | `ecommerce:write` docs: Slug for the Product variant/Option in the Site URL structure source: openapi: ../openapi.yml + inline: true ProductsListResponseItemsItemProductFieldDataSkuPropertiesItem: docs: A variant/option type for a SKU properties: @@ -42409,6 +43194,7 @@ Required scope | `ecommerce:write` list source: openapi: ../openapi.yml + inline: true ProductsListResponseItemsItemProductFieldDataTaxCategory: enum: - value: standard-taxable @@ -42524,6 +43310,7 @@ Required scope | `ecommerce:write` Digital, Service, Advanced" source: openapi: ../openapi.yml + inline: true ProductsListResponseItemsItemProduct: docs: The Product object properties: @@ -42558,6 +43345,7 @@ Required scope | `ecommerce:write` product setup. source: openapi: ../openapi.yml + inline: true ProductsListResponseItemsItemSkusItemFieldDataPrice: docs: price of SKU properties: @@ -42569,6 +43357,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsListResponseItemsItemSkusItemFieldDataCompareAtPrice: docs: comparison price of SKU properties: @@ -42580,6 +43369,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsListResponseItemsItemSkusItemFieldDataEcSkuBillingMethod: enum: - value: one-time @@ -42618,6 +43408,7 @@ Required scope | `ecommerce:write` docs: The status of the plan source: openapi: ../openapi.yml + inline: true ProductsListResponseItemsItemSkusItemFieldDataEcSkuSubscriptionPlan: properties: interval: @@ -42634,6 +43425,7 @@ Required scope | `ecommerce:write` optional> source: openapi: ../openapi.yml + inline: true ProductsListResponseItemsItemSkusItemFieldData: docs: Standard and Custom fields for a SKU properties: @@ -42669,6 +43461,7 @@ Required scope | `ecommerce:write` docs: Quantity of SKU that will be tracked as items are ordered. source: openapi: ../openapi.yml + inline: true ProductsListResponseItemsItemSkusItem: docs: The SKU object properties: @@ -42692,6 +43485,7 @@ Required scope | `ecommerce:write` docs: Standard and Custom fields for a SKU source: openapi: ../openapi.yml + inline: true ProductsListResponseItemsItem: docs: A product and its SKUs. properties: @@ -42703,6 +43497,7 @@ Required scope | `ecommerce:write` docs: A list of SKU Objects source: openapi: ../openapi.yml + inline: true ProductsListResponsePagination: docs: Pagination object properties: @@ -42717,6 +43512,7 @@ Required scope | `ecommerce:write` docs: The total number of records source: openapi: ../openapi.yml + inline: true ProductsListResponse: docs: Results from product list properties: @@ -42752,6 +43548,7 @@ Required scope | `ecommerce:write` docs: Slug for the Product variant/Option in the Site URL structure source: openapi: ../openapi.yml + inline: true ProductsCreateRequestProductFieldDataSkuPropertiesItem: docs: A variant/option type for a SKU properties: @@ -42768,6 +43565,7 @@ Required scope | `ecommerce:write` type: list source: openapi: ../openapi.yml + inline: true ProductsCreateRequestProductFieldDataTaxCategory: enum: - value: standard-taxable @@ -42882,6 +43680,7 @@ Required scope | `ecommerce:write` Digital, Service, Advanced" source: openapi: ../openapi.yml + inline: true ProductsCreateRequestProduct: docs: The Product object properties: @@ -42893,6 +43692,7 @@ Required scope | `ecommerce:write` product setup. source: openapi: ../openapi.yml + inline: true ProductsCreateRequestSkuFieldDataPrice: docs: price of SKU properties: @@ -42904,6 +43704,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsCreateRequestSkuFieldDataCompareAtPrice: docs: comparison price of SKU properties: @@ -42915,6 +43716,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsCreateRequestSkuFieldDataEcSkuBillingMethod: enum: - value: one-time @@ -42953,6 +43755,7 @@ Required scope | `ecommerce:write` docs: The status of the plan source: openapi: ../openapi.yml + inline: true ProductsCreateRequestSkuFieldDataEcSkuSubscriptionPlan: properties: interval: @@ -42969,6 +43772,7 @@ Required scope | `ecommerce:write` optional> source: openapi: ../openapi.yml + inline: true ProductsCreateRequestSkuFieldData: docs: Standard and Custom fields for a SKU properties: @@ -43002,6 +43806,7 @@ Required scope | `ecommerce:write` docs: Quantity of SKU that will be tracked as items are ordered. source: openapi: ../openapi.yml + inline: true ProductsCreateRequestSku: docs: The SKU object properties: @@ -43025,6 +43830,7 @@ Required scope | `ecommerce:write` docs: Standard and Custom fields for a SKU source: openapi: ../openapi.yml + inline: true ProductsCreateResponseProductFieldDataSkuPropertiesItemEnumItem: docs: Enumerated Product variants/Options for the SKU properties: @@ -43039,6 +43845,7 @@ Required scope | `ecommerce:write` docs: Slug for the Product variant/Option in the Site URL structure source: openapi: ../openapi.yml + inline: true ProductsCreateResponseProductFieldDataSkuPropertiesItem: docs: A variant/option type for a SKU properties: @@ -43055,6 +43862,7 @@ Required scope | `ecommerce:write` type: list source: openapi: ../openapi.yml + inline: true ProductsCreateResponseProductFieldDataTaxCategory: enum: - value: standard-taxable @@ -43170,6 +43978,7 @@ Required scope | `ecommerce:write` Digital, Service, Advanced" source: openapi: ../openapi.yml + inline: true ProductsCreateResponseProduct: docs: The Product object properties: @@ -43204,6 +44013,7 @@ Required scope | `ecommerce:write` product setup. source: openapi: ../openapi.yml + inline: true ProductsCreateResponseSkusItemFieldDataPrice: docs: price of SKU properties: @@ -43215,6 +44025,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsCreateResponseSkusItemFieldDataCompareAtPrice: docs: comparison price of SKU properties: @@ -43226,6 +44037,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsCreateResponseSkusItemFieldDataEcSkuBillingMethod: enum: - value: one-time @@ -43264,6 +44076,7 @@ Required scope | `ecommerce:write` docs: The status of the plan source: openapi: ../openapi.yml + inline: true ProductsCreateResponseSkusItemFieldDataEcSkuSubscriptionPlan: properties: interval: @@ -43280,6 +44093,7 @@ Required scope | `ecommerce:write` optional> source: openapi: ../openapi.yml + inline: true ProductsCreateResponseSkusItemFieldData: docs: Standard and Custom fields for a SKU properties: @@ -43313,6 +44127,7 @@ Required scope | `ecommerce:write` docs: Quantity of SKU that will be tracked as items are ordered. source: openapi: ../openapi.yml + inline: true ProductsCreateResponseSkusItem: docs: The SKU object properties: @@ -43336,6 +44151,7 @@ Required scope | `ecommerce:write` docs: Standard and Custom fields for a SKU source: openapi: ../openapi.yml + inline: true ProductsCreateResponse: docs: A product and its SKUs. properties: @@ -43361,6 +44177,7 @@ Required scope | `ecommerce:write` docs: Slug for the Product variant/Option in the Site URL structure source: openapi: ../openapi.yml + inline: true ProductsGetResponseProductFieldDataSkuPropertiesItem: docs: A variant/option type for a SKU properties: @@ -43377,6 +44194,7 @@ Required scope | `ecommerce:write` type: list source: openapi: ../openapi.yml + inline: true ProductsGetResponseProductFieldDataTaxCategory: enum: - value: standard-taxable @@ -43491,6 +44309,7 @@ Required scope | `ecommerce:write` Digital, Service, Advanced" source: openapi: ../openapi.yml + inline: true ProductsGetResponseProduct: docs: The Product object properties: @@ -43525,6 +44344,7 @@ Required scope | `ecommerce:write` product setup. source: openapi: ../openapi.yml + inline: true ProductsGetResponseSkusItemFieldDataPrice: docs: price of SKU properties: @@ -43536,6 +44356,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsGetResponseSkusItemFieldDataCompareAtPrice: docs: comparison price of SKU properties: @@ -43547,6 +44368,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsGetResponseSkusItemFieldDataEcSkuBillingMethod: enum: - value: one-time @@ -43585,6 +44407,7 @@ Required scope | `ecommerce:write` docs: The status of the plan source: openapi: ../openapi.yml + inline: true ProductsGetResponseSkusItemFieldDataEcSkuSubscriptionPlan: properties: interval: @@ -43601,6 +44424,7 @@ Required scope | `ecommerce:write` optional> source: openapi: ../openapi.yml + inline: true ProductsGetResponseSkusItemFieldData: docs: Standard and Custom fields for a SKU properties: @@ -43634,6 +44458,7 @@ Required scope | `ecommerce:write` docs: Quantity of SKU that will be tracked as items are ordered. source: openapi: ../openapi.yml + inline: true ProductsGetResponseSkusItem: docs: The SKU object properties: @@ -43657,6 +44482,7 @@ Required scope | `ecommerce:write` docs: Standard and Custom fields for a SKU source: openapi: ../openapi.yml + inline: true ProductsGetResponse: docs: A product and its SKUs. properties: @@ -43690,6 +44516,7 @@ Required scope | `ecommerce:write` docs: Slug for the Product variant/Option in the Site URL structure source: openapi: ../openapi.yml + inline: true ProductsUpdateRequestProductFieldDataSkuPropertiesItem: docs: A variant/option type for a SKU properties: @@ -43706,6 +44533,7 @@ Required scope | `ecommerce:write` type: list source: openapi: ../openapi.yml + inline: true ProductsUpdateRequestProductFieldDataTaxCategory: enum: - value: standard-taxable @@ -43820,6 +44648,7 @@ Required scope | `ecommerce:write` Digital, Service, Advanced" source: openapi: ../openapi.yml + inline: true ProductsUpdateRequestProduct: docs: The Product object properties: @@ -43854,6 +44683,7 @@ Required scope | `ecommerce:write` product setup. source: openapi: ../openapi.yml + inline: true ProductsUpdateRequestSkuFieldDataPrice: docs: price of SKU properties: @@ -43865,6 +44695,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsUpdateRequestSkuFieldDataCompareAtPrice: docs: comparison price of SKU properties: @@ -43876,6 +44707,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsUpdateRequestSkuFieldDataEcSkuBillingMethod: enum: - value: one-time @@ -43914,6 +44746,7 @@ Required scope | `ecommerce:write` docs: The status of the plan source: openapi: ../openapi.yml + inline: true ProductsUpdateRequestSkuFieldDataEcSkuSubscriptionPlan: properties: interval: @@ -43930,6 +44763,7 @@ Required scope | `ecommerce:write` optional> source: openapi: ../openapi.yml + inline: true ProductsUpdateRequestSkuFieldData: docs: Standard and Custom fields for a SKU properties: @@ -43963,6 +44797,7 @@ Required scope | `ecommerce:write` docs: Quantity of SKU that will be tracked as items are ordered. source: openapi: ../openapi.yml + inline: true ProductsUpdateRequestSku: docs: The SKU object properties: @@ -43986,6 +44821,7 @@ Required scope | `ecommerce:write` docs: Standard and Custom fields for a SKU source: openapi: ../openapi.yml + inline: true ProductsUpdateResponseFieldDataSkuPropertiesItemEnumItem: docs: Enumerated Product variants/Options for the SKU properties: @@ -44000,6 +44836,7 @@ Required scope | `ecommerce:write` docs: Slug for the Product variant/Option in the Site URL structure source: openapi: ../openapi.yml + inline: true ProductsUpdateResponseFieldDataSkuPropertiesItem: docs: A variant/option type for a SKU properties: @@ -44016,6 +44853,7 @@ Required scope | `ecommerce:write` type: list source: openapi: ../openapi.yml + inline: true ProductsUpdateResponseFieldDataTaxCategory: enum: - value: standard-taxable @@ -44130,6 +44968,7 @@ Required scope | `ecommerce:write` Digital, Service, Advanced" source: openapi: ../openapi.yml + inline: true ProductsUpdateResponse: docs: The Product object properties: @@ -44183,6 +45022,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsCreateSkuRequestSkusItemFieldDataCompareAtPrice: docs: comparison price of SKU properties: @@ -44194,6 +45034,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsCreateSkuRequestSkusItemFieldDataEcSkuBillingMethod: enum: - value: one-time @@ -44232,6 +45073,7 @@ Required scope | `ecommerce:write` docs: The status of the plan source: openapi: ../openapi.yml + inline: true ProductsCreateSkuRequestSkusItemFieldDataEcSkuSubscriptionPlan: properties: interval: @@ -44248,6 +45090,7 @@ Required scope | `ecommerce:write` optional> source: openapi: ../openapi.yml + inline: true ProductsCreateSkuRequestSkusItemFieldData: docs: Standard and Custom fields for a SKU properties: @@ -44281,6 +45124,7 @@ Required scope | `ecommerce:write` docs: Quantity of SKU that will be tracked as items are ordered. source: openapi: ../openapi.yml + inline: true ProductsCreateSkuRequestSkusItem: docs: The SKU object properties: @@ -44304,6 +45148,7 @@ Required scope | `ecommerce:write` docs: Standard and Custom fields for a SKU source: openapi: ../openapi.yml + inline: true ProductsCreateSkuResponseSkusItemFieldDataPrice: docs: price of SKU properties: @@ -44315,6 +45160,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsCreateSkuResponseSkusItemFieldDataCompareAtPrice: docs: comparison price of SKU properties: @@ -44326,6 +45172,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsCreateSkuResponseSkusItemFieldDataEcSkuBillingMethod: enum: - value: one-time @@ -44364,6 +45211,7 @@ Required scope | `ecommerce:write` docs: The status of the plan source: openapi: ../openapi.yml + inline: true ProductsCreateSkuResponseSkusItemFieldDataEcSkuSubscriptionPlan: properties: interval: @@ -44380,6 +45228,7 @@ Required scope | `ecommerce:write` optional> source: openapi: ../openapi.yml + inline: true ProductsCreateSkuResponseSkusItemFieldData: docs: Standard and Custom fields for a SKU properties: @@ -44414,6 +45263,7 @@ Required scope | `ecommerce:write` docs: Quantity of SKU that will be tracked as items are ordered. source: openapi: ../openapi.yml + inline: true ProductsCreateSkuResponseSkusItem: docs: The SKU object properties: @@ -44437,6 +45287,7 @@ Required scope | `ecommerce:write` docs: Standard and Custom fields for a SKU source: openapi: ../openapi.yml + inline: true ProductsCreateSkuResponse: properties: skus: optional> @@ -44461,6 +45312,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsUpdateSkuRequestSkuFieldDataCompareAtPrice: docs: comparison price of SKU properties: @@ -44472,6 +45324,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsUpdateSkuRequestSkuFieldDataEcSkuBillingMethod: enum: - value: one-time @@ -44510,6 +45363,7 @@ Required scope | `ecommerce:write` docs: The status of the plan source: openapi: ../openapi.yml + inline: true ProductsUpdateSkuRequestSkuFieldDataEcSkuSubscriptionPlan: properties: interval: @@ -44526,6 +45380,7 @@ Required scope | `ecommerce:write` optional> source: openapi: ../openapi.yml + inline: true ProductsUpdateSkuRequestSkuFieldData: docs: Standard and Custom fields for a SKU properties: @@ -44559,6 +45414,7 @@ Required scope | `ecommerce:write` docs: Quantity of SKU that will be tracked as items are ordered. source: openapi: ../openapi.yml + inline: true ProductsUpdateSkuRequestSku: docs: The SKU object properties: @@ -44582,6 +45438,7 @@ Required scope | `ecommerce:write` docs: Standard and Custom fields for a SKU source: openapi: ../openapi.yml + inline: true ProductsUpdateSkuResponseFieldDataPrice: docs: price of SKU properties: @@ -44593,6 +45450,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsUpdateSkuResponseFieldDataCompareAtPrice: docs: comparison price of SKU properties: @@ -44604,6 +45462,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsUpdateSkuResponseFieldDataEcSkuBillingMethod: enum: - value: one-time @@ -44642,6 +45501,7 @@ Required scope | `ecommerce:write` docs: The status of the plan source: openapi: ../openapi.yml + inline: true ProductsUpdateSkuResponseFieldDataEcSkuSubscriptionPlan: properties: interval: @@ -44658,6 +45518,7 @@ Required scope | `ecommerce:write` optional> source: openapi: ../openapi.yml + inline: true ProductsUpdateSkuResponseFieldData: docs: Standard and Custom fields for a SKU properties: @@ -44691,6 +45552,7 @@ Required scope | `ecommerce:write` docs: Quantity of SKU that will be tracked as items are ordered. source: openapi: ../openapi.yml + inline: true ProductsUpdateSkuResponse: docs: The SKU object properties: @@ -45584,6 +46446,7 @@ service: "types": { "ScriptsListResponse": { "docs": "A list of scripts registered to the site", + "inline": undefined, "properties": { "registeredScripts": "optional>", }, @@ -45593,6 +46456,7 @@ service: }, "ScriptsListResponseRegisteredScriptsItem": { "docs": "Registered custom code for application", + "inline": true, "properties": { "canCopy": { "default": false, @@ -45634,6 +46498,7 @@ service: }, "ScriptsRegisterHostedResponse": { "docs": "Registered custom code for application", + "inline": undefined, "properties": { "canCopy": { "default": false, @@ -45675,6 +46540,7 @@ service: }, "ScriptsRegisterInlineResponse": { "docs": "Registered custom code for application", + "inline": undefined, "properties": { "canCopy": { "default": false, @@ -45753,6 +46619,7 @@ service: docs: A Semantic Version (SemVer) string, denoting the version of the script source: openapi: ../openapi.yml + inline: true ScriptsListResponse: docs: A list of scripts registered to the site properties: @@ -46434,6 +47301,7 @@ service: "types": { "SitePublishPayload": { "docs": "The Webhook payload for when a Site is published", + "inline": undefined, "properties": { "payload": { "docs": "The payload of data sent from Webflow", @@ -46450,6 +47318,7 @@ service: }, "SitePublishPayloadPayload": { "docs": "The payload of data sent from Webflow", + "inline": true, "properties": { "domains": { "docs": "The domains that were published", @@ -46474,6 +47343,7 @@ service: }, "SitesGetCustomDomainResponse": { "docs": undefined, + "inline": undefined, "properties": { "customDomains": "optional>", }, @@ -46483,6 +47353,7 @@ service: }, "SitesGetCustomDomainResponseCustomDomainsItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "Unique identifier for the Domain", @@ -46499,6 +47370,7 @@ service: }, "SitesGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "createdOn": { "docs": "Date the Site was created", @@ -46555,6 +47427,7 @@ service: }, "SitesGetResponseCustomDomainsItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "Unique identifier for the Domain", @@ -46571,6 +47444,7 @@ service: }, "SitesGetResponseLocales": { "docs": undefined, + "inline": true, "properties": { "primary": { "docs": "The primary locale for the site or application.", @@ -46587,6 +47461,7 @@ service: }, "SitesGetResponseLocalesPrimary": { "docs": "The primary locale for the site or application.", + "inline": true, "properties": { "cmsLocaleId": { "docs": "A CMS-specific identifier for the locale.", @@ -46627,6 +47502,7 @@ service: }, "SitesGetResponseLocalesSecondaryItem": { "docs": undefined, + "inline": true, "properties": { "cmsLocaleId": { "docs": "A CMS-specific identifier for the locale.", @@ -46667,6 +47543,7 @@ service: }, "SitesListResponse": { "docs": undefined, + "inline": undefined, "properties": { "sites": "optional>", }, @@ -46676,6 +47553,7 @@ service: }, "SitesListResponseSitesItem": { "docs": undefined, + "inline": true, "properties": { "createdOn": { "docs": "Date the Site was created", @@ -46732,6 +47610,7 @@ service: }, "SitesListResponseSitesItemCustomDomainsItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "Unique identifier for the Domain", @@ -46748,6 +47627,7 @@ service: }, "SitesListResponseSitesItemLocales": { "docs": undefined, + "inline": true, "properties": { "primary": { "docs": "The primary locale for the site or application.", @@ -46764,6 +47644,7 @@ service: }, "SitesListResponseSitesItemLocalesPrimary": { "docs": "The primary locale for the site or application.", + "inline": true, "properties": { "cmsLocaleId": { "docs": "A CMS-specific identifier for the locale.", @@ -46804,6 +47685,7 @@ service: }, "SitesListResponseSitesItemLocalesSecondaryItem": { "docs": undefined, + "inline": true, "properties": { "cmsLocaleId": { "docs": "A CMS-specific identifier for the locale.", @@ -46844,6 +47726,7 @@ service: }, "SitesPublishResponse": { "docs": undefined, + "inline": undefined, "properties": { "customDomains": { "docs": "Array of domains objects", @@ -46861,6 +47744,7 @@ service: }, "SitesPublishResponseCustomDomainsItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "Unique identifier for the Domain", @@ -46918,6 +47802,7 @@ service: docs: The registered Domain name source: openapi: ../openapi.yml + inline: true SitesListResponseSitesItemLocalesPrimary: docs: The primary locale for the site or application. properties: @@ -46949,6 +47834,7 @@ service: format like 'en-US'. source: openapi: ../openapi.yml + inline: true SitesListResponseSitesItemLocalesSecondaryItem: properties: id: @@ -46979,6 +47865,7 @@ service: format like 'en-US'. source: openapi: ../openapi.yml + inline: true SitesListResponseSitesItemLocales: properties: primary: @@ -46989,6 +47876,7 @@ service: docs: A list of secondary locales available for the site or application. source: openapi: ../openapi.yml + inline: true SitesListResponseSitesItem: properties: id: @@ -47027,6 +47915,7 @@ service: locales: optional source: openapi: ../openapi.yml + inline: true SitesListResponse: properties: sites: optional> @@ -47042,6 +47931,7 @@ service: docs: The registered Domain name source: openapi: ../openapi.yml + inline: true SitesGetResponseLocalesPrimary: docs: The primary locale for the site or application. properties: @@ -47073,6 +47963,7 @@ service: format like 'en-US'. source: openapi: ../openapi.yml + inline: true SitesGetResponseLocalesSecondaryItem: properties: id: @@ -47103,6 +47994,7 @@ service: format like 'en-US'. source: openapi: ../openapi.yml + inline: true SitesGetResponseLocales: properties: primary: @@ -47113,6 +48005,7 @@ service: docs: A list of secondary locales available for the site or application. source: openapi: ../openapi.yml + inline: true SitesGetResponse: properties: id: @@ -47161,6 +48054,7 @@ service: docs: The registered Domain name source: openapi: ../openapi.yml + inline: true SitesGetCustomDomainResponse: properties: customDomains: optional> @@ -47176,6 +48070,7 @@ service: docs: The registered Domain name source: openapi: ../openapi.yml + inline: true SitesPublishResponse: properties: customDomains: @@ -47204,6 +48099,7 @@ service: docs: The name and id of the user who published the site source: openapi: ../openapi.yml + inline: true SitePublishPayload: docs: The Webhook payload for when a Site is published properties: @@ -47601,6 +48497,7 @@ webhooks: "types": { "ActivityLogsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "items": "optional>", "pagination": { @@ -47614,6 +48511,7 @@ webhooks: }, "ActivityLogsListResponseItemsItem": { "docs": undefined, + "inline": true, "properties": { "createdOn": "optional", "event": "optional", @@ -47645,6 +48543,7 @@ webhooks: }, "ActivityLogsListResponseItemsItemUser": { "docs": undefined, + "inline": true, "properties": { "displayName": "optional", "id": "optional", @@ -47655,6 +48554,7 @@ webhooks: }, "ActivityLogsListResponsePagination": { "docs": "Pagination object", + "inline": true, "properties": { "limit": { "docs": "The limit used for pagination", @@ -47691,6 +48591,7 @@ webhooks: displayName: optional source: openapi: ../openapi.yml + inline: true ActivityLogsListResponseItemsItem: properties: id: optional @@ -47706,6 +48607,7 @@ webhooks: payload: optional> source: openapi: ../openapi.yml + inline: true ActivityLogsListResponsePagination: docs: Pagination object properties: @@ -47720,6 +48622,7 @@ webhooks: docs: The total number of records source: openapi: ../openapi.yml + inline: true ActivityLogsListResponse: properties: items: optional> @@ -48099,6 +49002,7 @@ service: "types": { "ScriptsGetCustomCodeResponse": { "docs": undefined, + "inline": undefined, "properties": { "createdOn": { "docs": "Date when the Site's scripts were created", @@ -48119,6 +49023,7 @@ service: }, "ScriptsGetCustomCodeResponseScriptsItem": { "docs": undefined, + "inline": true, "properties": { "attributes": { "docs": "Developer-specified key/value pairs to be applied as attributes to the script", @@ -48155,6 +49060,7 @@ service: }, "ScriptsListCustomCodeBlocksResponse": { "docs": "Custom Code Blocks corresponding to where scripts were applied", + "inline": undefined, "properties": { "blocks": "optional>", "pagination": { @@ -48168,6 +49074,7 @@ service: }, "ScriptsListCustomCodeBlocksResponseBlocksItem": { "docs": "A specific instance of Custom Code applied to a Site or Page", + "inline": true, "properties": { "createdOn": { "docs": "The date the Block was created", @@ -48200,6 +49107,7 @@ service: }, "ScriptsListCustomCodeBlocksResponseBlocksItemScriptsItem": { "docs": undefined, + "inline": true, "properties": { "attributes": { "docs": "Developer-specified key/value pairs to be applied as attributes to the script", @@ -48246,6 +49154,7 @@ service: }, "ScriptsListCustomCodeBlocksResponsePagination": { "docs": "Pagination object", + "inline": true, "properties": { "limit": { "docs": "The limit used for pagination", @@ -48266,6 +49175,7 @@ service: }, "ScriptsUpsertCustomCodeRequestScriptsItem": { "docs": undefined, + "inline": true, "properties": { "attributes": { "docs": "Developer-specified key/value pairs to be applied as attributes to the script", @@ -48302,6 +49212,7 @@ service: }, "ScriptsUpsertCustomCodeResponse": { "docs": undefined, + "inline": undefined, "properties": { "createdOn": { "docs": "Date when the Site's scripts were created", @@ -48322,6 +49233,7 @@ service: }, "ScriptsUpsertCustomCodeResponseScriptsItem": { "docs": undefined, + "inline": true, "properties": { "attributes": { "docs": "Developer-specified key/value pairs to be applied as attributes to the script", @@ -48390,6 +49302,7 @@ service: script source: openapi: ../openapi.yml + inline: true ScriptsGetCustomCodeResponse: properties: scripts: @@ -48434,6 +49347,7 @@ service: script source: openapi: ../openapi.yml + inline: true ScriptsUpsertCustomCodeResponseScriptsItemLocation: enum: - header @@ -48465,6 +49379,7 @@ service: script source: openapi: ../openapi.yml + inline: true ScriptsUpsertCustomCodeResponse: properties: scripts: @@ -48516,6 +49431,7 @@ service: script source: openapi: ../openapi.yml + inline: true ScriptsListCustomCodeBlocksResponseBlocksItem: docs: A specific instance of Custom Code applied to a Site or Page properties: @@ -48542,6 +49458,7 @@ service: docs: The date the Block was most recently updated source: openapi: ../openapi.yml + inline: true ScriptsListCustomCodeBlocksResponsePagination: docs: Pagination object properties: @@ -48556,6 +49473,7 @@ service: docs: The total number of records source: openapi: ../openapi.yml + inline: true ScriptsListCustomCodeBlocksResponse: docs: Custom Code Blocks corresponding to where scripts were applied properties: @@ -48885,6 +49803,7 @@ service: "types": { "TokenAuthorizedByResponse": { "docs": undefined, + "inline": undefined, "properties": { "email": { "docs": "The user's email address", @@ -48915,6 +49834,7 @@ service: }, "TokenIntrospectResponse": { "docs": undefined, + "inline": undefined, "properties": { "application": "optional", "authorization": { @@ -48928,6 +49848,7 @@ service: }, "TokenIntrospectResponseAuthorization": { "docs": "The Authorization object", + "inline": true, "properties": { "authorizedTo": "optional", "createdOn": { @@ -48961,6 +49882,7 @@ service: }, "TokenIntrospectResponseAuthorizationAuthorizedTo": { "docs": undefined, + "inline": true, "properties": { "siteIds": { "docs": "Array of Sites this app is authorized to", @@ -49013,6 +49935,7 @@ service: docs: Array of Users this app is authorized to source: openapi: ../openapi.yml + inline: true TokenIntrospectResponseAuthorization: docs: The Authorization object properties: @@ -49037,6 +49960,7 @@ service: authorizedTo: optional source: openapi: ../openapi.yml + inline: true TokenIntrospectResponse: properties: authorization: @@ -49576,6 +50500,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) "types": { "UserAccountAddedPayload": { "docs": undefined, + "inline": undefined, "properties": { "payload": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items @@ -49594,6 +50519,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) "UserAccountAddedPayloadPayload": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": true, "properties": { "accessGroups": { "docs": "Access groups the user belongs to", @@ -49638,6 +50564,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UserAccountAddedPayloadPayloadAccessGroupsItem": { "docs": "Access group slugs and types", + "inline": true, "properties": { "slug": { "docs": "Access group identifier for APIs", @@ -49670,6 +50597,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UserAccountAddedPayloadPayloadData": { "docs": "An object containing the User's basic info and custom fields", + "inline": true, "properties": { "data": "optional", }, @@ -49679,6 +50607,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UserAccountAddedPayloadPayloadDataData": { "docs": undefined, + "inline": true, "properties": { "accept-communications": { "docs": "Boolean indicating if the user has accepted to receive communications @@ -49733,6 +50662,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UserAccountDeletedPayload": { "docs": undefined, + "inline": undefined, "properties": { "payload": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items @@ -49751,6 +50681,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) "UserAccountDeletedPayloadPayload": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": true, "properties": { "accessGroups": { "docs": "Access groups the user belongs to", @@ -49795,6 +50726,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UserAccountDeletedPayloadPayloadAccessGroupsItem": { "docs": "Access group slugs and types", + "inline": true, "properties": { "slug": { "docs": "Access group identifier for APIs", @@ -49827,6 +50759,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UserAccountDeletedPayloadPayloadData": { "docs": "An object containing the User's basic info and custom fields", + "inline": true, "properties": { "data": "optional", }, @@ -49836,6 +50769,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UserAccountDeletedPayloadPayloadDataData": { "docs": undefined, + "inline": true, "properties": { "accept-communications": { "docs": "Boolean indicating if the user has accepted to receive communications @@ -49890,6 +50824,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UserAccountUpdatedPayload": { "docs": undefined, + "inline": undefined, "properties": { "payload": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items @@ -49908,6 +50843,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) "UserAccountUpdatedPayloadPayload": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": true, "properties": { "accessGroups": { "docs": "Access groups the user belongs to", @@ -49952,6 +50888,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UserAccountUpdatedPayloadPayloadAccessGroupsItem": { "docs": "Access group slugs and types", + "inline": true, "properties": { "slug": { "docs": "Access group identifier for APIs", @@ -49984,6 +50921,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UserAccountUpdatedPayloadPayloadData": { "docs": "An object containing the User's basic info and custom fields", + "inline": true, "properties": { "data": "optional", }, @@ -49993,6 +50931,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UserAccountUpdatedPayloadPayloadDataData": { "docs": undefined, + "inline": true, "properties": { "accept-communications": { "docs": "Boolean indicating if the user has accepted to receive communications @@ -50048,6 +50987,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) "UsersGetResponse": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "accessGroups": { "docs": "Access groups the user belongs to", @@ -50092,6 +51032,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersGetResponseAccessGroupsItem": { "docs": "Access group slugs and types", + "inline": true, "properties": { "slug": { "docs": "Access group identifier for APIs", @@ -50124,6 +51065,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersGetResponseData": { "docs": "An object containing the User's basic info and custom fields", + "inline": true, "properties": { "data": "optional", }, @@ -50133,6 +51075,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersGetResponseDataData": { "docs": undefined, + "inline": true, "properties": { "accept-communications": { "docs": "Boolean indicating if the user has accepted to receive communications @@ -50177,6 +51120,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) "UsersInviteResponse": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "accessGroups": { "docs": "Access groups the user belongs to", @@ -50221,6 +51165,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersInviteResponseAccessGroupsItem": { "docs": "Access group slugs and types", + "inline": true, "properties": { "slug": { "docs": "Access group identifier for APIs", @@ -50253,6 +51198,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersInviteResponseData": { "docs": "An object containing the User's basic info and custom fields", + "inline": true, "properties": { "data": "optional", }, @@ -50262,6 +51208,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersInviteResponseDataData": { "docs": undefined, + "inline": true, "properties": { "accept-communications": { "docs": "Boolean indicating if the user has accepted to receive communications @@ -50362,6 +51309,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersListResponse": { "docs": "The list users results", + "inline": undefined, "properties": { "count": { "docs": "Number of users returned", @@ -50393,6 +51341,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) "UsersListResponseUsersItem": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": true, "properties": { "accessGroups": { "docs": "Access groups the user belongs to", @@ -50437,6 +51386,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersListResponseUsersItemAccessGroupsItem": { "docs": "Access group slugs and types", + "inline": true, "properties": { "slug": { "docs": "Access group identifier for APIs", @@ -50469,6 +51419,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersListResponseUsersItemData": { "docs": "An object containing the User's basic info and custom fields", + "inline": true, "properties": { "data": "optional", }, @@ -50478,6 +51429,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersListResponseUsersItemDataData": { "docs": undefined, + "inline": true, "properties": { "accept-communications": { "docs": "Boolean indicating if the user has accepted to receive communications @@ -50521,6 +51473,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersUpdateRequestData": { "docs": undefined, + "inline": true, "properties": { "accept-communications": { "docs": "Boolean indicating if the user has accepted to receive communications @@ -50545,6 +51498,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) "UsersUpdateResponse": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "accessGroups": { "docs": "Access groups the user belongs to", @@ -50589,6 +51543,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersUpdateResponseAccessGroupsItem": { "docs": "Access group slugs and types", + "inline": true, "properties": { "slug": { "docs": "Access group identifier for APIs", @@ -50621,6 +51576,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersUpdateResponseData": { "docs": "An object containing the User's basic info and custom fields", + "inline": true, "properties": { "data": "optional", }, @@ -50630,6 +51586,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersUpdateResponseDataData": { "docs": undefined, + "inline": true, "properties": { "accept-communications": { "docs": "Boolean indicating if the user has accepted to receive communications @@ -50829,6 +51786,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) * `ecommerce` - Assigned to the user via an ecommerce purchase source: openapi: ../openapi.yml + inline: true UsersListResponseUsersItemDataData: properties: name: @@ -50852,12 +51810,14 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: Custom user attributes source: openapi: ../openapi.yml + inline: true UsersListResponseUsersItemData: docs: An object containing the User's basic info and custom fields properties: data: optional source: openapi: ../openapi.yml + inline: true UsersListResponseUsersItem: docs: > The fields that define the schema for a given Item are based on the @@ -50894,6 +51854,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: An object containing the User's basic info and custom fields source: openapi: ../openapi.yml + inline: true UsersListResponse: docs: The list users results properties: @@ -50948,6 +51909,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) * `ecommerce` - Assigned to the user via an ecommerce purchase source: openapi: ../openapi.yml + inline: true UsersGetResponseDataData: properties: name: @@ -50971,12 +51933,14 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: Custom user attributes source: openapi: ../openapi.yml + inline: true UsersGetResponseData: docs: An object containing the User's basic info and custom fields properties: data: optional source: openapi: ../openapi.yml + inline: true UsersGetResponse: docs: > The fields that define the schema for a given Item are based on the @@ -51029,6 +51993,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) Boolean indicating if the user has accepted to receive communications source: openapi: ../openapi.yml + inline: true UsersUpdateResponseStatus: enum: - invited @@ -51061,6 +52026,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) * `ecommerce` - Assigned to the user via an ecommerce purchase source: openapi: ../openapi.yml + inline: true UsersUpdateResponseDataData: properties: name: @@ -51084,12 +52050,14 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: Custom user attributes source: openapi: ../openapi.yml + inline: true UsersUpdateResponseData: docs: An object containing the User's basic info and custom fields properties: data: optional source: openapi: ../openapi.yml + inline: true UsersUpdateResponse: docs: > The fields that define the schema for a given Item are based on the @@ -51158,6 +52126,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) * `ecommerce` - Assigned to the user via an ecommerce purchase source: openapi: ../openapi.yml + inline: true UsersInviteResponseDataData: properties: name: @@ -51181,12 +52150,14 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: Custom user attributes source: openapi: ../openapi.yml + inline: true UsersInviteResponseData: docs: An object containing the User's basic info and custom fields properties: data: optional source: openapi: ../openapi.yml + inline: true UsersInviteResponse: docs: > The fields that define the schema for a given Item are based on the @@ -51263,6 +52234,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) * `ecommerce` - Assigned to the user via an ecommerce purchase source: openapi: ../openapi.yml + inline: true UserAccountAddedPayloadPayloadDataData: properties: name: @@ -51286,12 +52258,14 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: Custom user attributes source: openapi: ../openapi.yml + inline: true UserAccountAddedPayloadPayloadData: docs: An object containing the User's basic info and custom fields properties: data: optional source: openapi: ../openapi.yml + inline: true UserAccountAddedPayloadPayload: docs: > The fields that define the schema for a given Item are based on the @@ -51328,6 +52302,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: An object containing the User's basic info and custom fields source: openapi: ../openapi.yml + inline: true UserAccountAddedPayload: properties: triggerType: @@ -51382,6 +52357,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) * `ecommerce` - Assigned to the user via an ecommerce purchase source: openapi: ../openapi.yml + inline: true UserAccountUpdatedPayloadPayloadDataData: properties: name: @@ -51405,12 +52381,14 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: Custom user attributes source: openapi: ../openapi.yml + inline: true UserAccountUpdatedPayloadPayloadData: docs: An object containing the User's basic info and custom fields properties: data: optional source: openapi: ../openapi.yml + inline: true UserAccountUpdatedPayloadPayload: docs: > The fields that define the schema for a given Item are based on the @@ -51447,6 +52425,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: An object containing the User's basic info and custom fields source: openapi: ../openapi.yml + inline: true UserAccountUpdatedPayload: properties: triggerType: @@ -51501,6 +52480,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) * `ecommerce` - Assigned to the user via an ecommerce purchase source: openapi: ../openapi.yml + inline: true UserAccountDeletedPayloadPayloadDataData: properties: name: @@ -51524,12 +52504,14 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: Custom user attributes source: openapi: ../openapi.yml + inline: true UserAccountDeletedPayloadPayloadData: docs: An object containing the User's basic info and custom fields properties: data: optional source: openapi: ../openapi.yml + inline: true UserAccountDeletedPayloadPayload: docs: > The fields that define the schema for a given Item are based on the @@ -51566,6 +52548,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: An object containing the User's basic info and custom fields source: openapi: ../openapi.yml + inline: true UserAccountDeletedPayload: properties: triggerType: @@ -52235,6 +53218,7 @@ webhooks: "types": { "WebhooksCreateRequestFilter": { "docs": "Only supported for the `form_submission` trigger type. Filter for the form you want Webhooks to be sent for. ", + "inline": true, "properties": { "name": { "docs": "The name of the form you'd like to recieve notifications for.", @@ -52285,6 +53269,7 @@ webhooks: }, "WebhooksCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "createdOn": { "docs": "Date the Webhook registration was created", @@ -52340,6 +53325,7 @@ webhooks: }, "WebhooksCreateResponseFilter": { "docs": "Only supported for the `form_submission` trigger type. Filter for the form you want Webhooks to be sent for. ", + "inline": true, "properties": { "name": { "docs": "The name of the form you'd like to recieve notifications for.", @@ -52390,6 +53376,7 @@ webhooks: }, "WebhooksGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "createdOn": { "docs": "Date the Webhook registration was created", @@ -52445,6 +53432,7 @@ webhooks: }, "WebhooksGetResponseFilter": { "docs": "Only supported for the `form_submission` trigger type. Filter for the form you want Webhooks to be sent for. ", + "inline": true, "properties": { "name": { "docs": "The name of the form you'd like to recieve notifications for.", @@ -52495,6 +53483,7 @@ webhooks: }, "WebhooksListResponse": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Pagination object", @@ -52508,6 +53497,7 @@ webhooks: }, "WebhooksListResponsePagination": { "docs": "Pagination object", + "inline": true, "properties": { "limit": { "docs": "The limit used for pagination", @@ -52528,6 +53518,7 @@ webhooks: }, "WebhooksListResponseWebhooksItem": { "docs": undefined, + "inline": true, "properties": { "createdOn": { "docs": "Date the Webhook registration was created", @@ -52583,6 +53574,7 @@ webhooks: }, "WebhooksListResponseWebhooksItemFilter": { "docs": "Only supported for the `form_submission` trigger type. Filter for the form you want Webhooks to be sent for. ", + "inline": true, "properties": { "name": { "docs": "The name of the form you'd like to recieve notifications for.", @@ -52648,6 +53640,7 @@ webhooks: docs: The total number of records source: openapi: ../openapi.yml + inline: true WebhooksListResponseWebhooksItemTriggerType: enum: - form_submission @@ -52718,6 +53711,7 @@ webhooks: docs: The name of the form you'd like to recieve notifications for. source: openapi: ../openapi.yml + inline: true WebhooksListResponseWebhooksItem: properties: id: @@ -52789,6 +53783,7 @@ webhooks: docs: Date the Webhook registration was created source: openapi: ../openapi.yml + inline: true WebhooksListResponse: properties: pagination: @@ -52867,6 +53862,7 @@ webhooks: docs: The name of the form you'd like to recieve notifications for. source: openapi: ../openapi.yml + inline: true WebhooksCreateResponseTriggerType: enum: - form_submission @@ -52937,6 +53933,7 @@ webhooks: docs: The name of the form you'd like to recieve notifications for. source: openapi: ../openapi.yml + inline: true WebhooksCreateResponse: properties: id: @@ -53078,6 +54075,7 @@ webhooks: docs: The name of the form you'd like to recieve notifications for. source: openapi: ../openapi.yml + inline: true WebhooksGetResponse: properties: id: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/webhooks.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/webhooks.json index d52ee4ba306..6549bc09a14 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/webhooks.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/webhooks.json @@ -8,6 +8,7 @@ "types": { "Pet": { "docs": undefined, + "inline": undefined, "properties": { "id": "long", "name": "string", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-audiences.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-audiences.json index 9ea17ce95a6..692e2c0fb1d 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-audiences.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-audiences.json @@ -51,6 +51,7 @@ "types": { "BaseUser": { "docs": undefined, + "inline": undefined, "properties": { "id": { "audiences": [ diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-auth-variables.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-auth-variables.json index 2c23ca6fdaf..0b288cfa31b 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-auth-variables.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-auth-variables.json @@ -71,6 +71,7 @@ "types": { "UserGetAllResponseItem": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", @@ -88,6 +89,7 @@ }, "UserGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-encoding.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-encoding.json index ae27944f654..915d16f92c3 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-encoding.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-encoding.json @@ -22,6 +22,7 @@ "type": "google.protobuf.Value", }, }, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-global-headers.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-global-headers.json index 3918bfd4d6d..c96e3d9c727 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-global-headers.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-global-headers.json @@ -8,6 +8,7 @@ "types": { "StreamUser": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", @@ -26,6 +27,7 @@ }, "User": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-ignore.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-ignore.json index f63e11f3957..3ae3f0d02bb 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-ignore.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-ignore.json @@ -58,6 +58,7 @@ "types": { "Meta": { "docs": undefined, + "inline": undefined, "properties": { "hasMore": "optional", }, @@ -67,6 +68,7 @@ }, "User": { "docs": undefined, + "inline": undefined, "properties": { "age": "optional", "email": "optional", @@ -87,6 +89,7 @@ }, "UsersResponse": { "docs": undefined, + "inline": undefined, "properties": { "meta": "optional", "users": "optional>", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-pagination.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-pagination.json index a01b42ff886..d3241a7f8f5 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-pagination.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-pagination.json @@ -63,6 +63,7 @@ "types": { "Meta": { "docs": undefined, + "inline": undefined, "properties": { "hasMore": "optional", }, @@ -72,6 +73,7 @@ }, "User": { "docs": undefined, + "inline": undefined, "properties": { "age": "optional", "email": "optional", @@ -92,6 +94,7 @@ }, "UsersResponse": { "docs": undefined, + "inline": undefined, "properties": { "meta": "optional", "users": "optional>", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-property-name.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-property-name.json index 6adeac7a1c8..44779d38820 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-property-name.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-property-name.json @@ -8,6 +8,7 @@ "types": { "BaseUser": { "docs": undefined, + "inline": undefined, "properties": { "id": { "name": "renamed_id", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-resolutions.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-resolutions.json index ed9839ce3ac..98f46b082c0 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-resolutions.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-resolutions.json @@ -8,6 +8,7 @@ "types": { "User": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-sdk-group-name-with-streaming.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-sdk-group-name-with-streaming.json index ab43256e6ff..b71914d179a 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-sdk-group-name-with-streaming.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-sdk-group-name-with-streaming.json @@ -8,6 +8,7 @@ "types": { "StreamUser": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", @@ -26,6 +27,7 @@ }, "User": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-sdk-group-name.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-sdk-group-name.json index ba79432b480..8922916ae27 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-sdk-group-name.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-sdk-group-name.json @@ -8,6 +8,7 @@ "types": { "Person": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", @@ -137,6 +138,7 @@ service: "types": { "User": { "docs": "This user object should be in user.yml", + "inline": undefined, "properties": { "associatedPersons": "optional>", "id": { diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-streaming-with-audiences.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-streaming-with-audiences.json index f4893974af2..9cacc3dfa11 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-streaming-with-audiences.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-streaming-with-audiences.json @@ -8,6 +8,7 @@ "types": { "StreamUser": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", @@ -26,6 +27,7 @@ }, "User": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-streaming-with-reference.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-streaming-with-reference.json index 947e7655e1e..f86cece83a3 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-streaming-with-reference.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-streaming-with-reference.json @@ -8,6 +8,7 @@ "types": { "Completion": { "docs": undefined, + "inline": undefined, "properties": { "text": "optional", }, @@ -17,6 +18,7 @@ }, "CompletionChunk": { "docs": undefined, + "inline": undefined, "properties": { "text": "optional", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-streaming-with-sse.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-streaming-with-sse.json index 798002653c1..59b19cf5096 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-streaming-with-sse.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-streaming-with-sse.json @@ -8,6 +8,7 @@ "types": { "Completion": { "docs": undefined, + "inline": undefined, "properties": { "text": "optional", }, @@ -17,6 +18,7 @@ }, "CompletionChunk": { "docs": undefined, + "inline": undefined, "properties": { "text": "optional", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-streaming-with-stream-condition.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-streaming-with-stream-condition.json index c2486c68f87..1192924a90b 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-streaming-with-stream-condition.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-streaming-with-stream-condition.json @@ -116,6 +116,7 @@ "types": { "ChatFullResponse": { "docs": "Full response to a chat question when the result is not streamed.", + "inline": undefined, "properties": { "answer": { "docs": "The message from the chat model for the chat message.", @@ -136,6 +137,7 @@ }, "ChatStreamedResponse": { "docs": "An individual event when the response is streamed.", + "inline": undefined, "properties": { "chunk": { "docs": "The chunk of the response.", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-token-variable-name.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-token-variable-name.json index cb4279a8c61..c9383c0f0d5 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-token-variable-name.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-token-variable-name.json @@ -8,6 +8,7 @@ "types": { "Completion": { "docs": undefined, + "inline": undefined, "properties": { "text": "optional", }, @@ -17,6 +18,7 @@ }, "CompletionChunk": { "docs": undefined, + "inline": undefined, "properties": { "text": "optional", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-version.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-version.json index 3ae0294234c..546971d5294 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-version.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi-docs/x-fern-version.json @@ -8,6 +8,7 @@ "types": { "Completion": { "docs": undefined, + "inline": undefined, "properties": { "text": "optional", }, @@ -17,6 +18,7 @@ }, "CompletionChunk": { "docs": undefined, + "inline": undefined, "properties": { "text": "optional", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/ada.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/ada.json index f24f2d5ad51..3b1f368def2 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/ada.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/ada.json @@ -125,6 +125,7 @@ "EndUser": "unknown", "EndUserCreatedWebhookPayload": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional", "timestamp": "optional", @@ -137,6 +138,7 @@ "EndUserRequest": "unknown", "EndUserUpdatedWebhookPayload": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional", "timestamp": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/anyOf.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/anyOf.json index b0be7e7f005..cf8ad12d6e2 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/anyOf.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/anyOf.json @@ -58,6 +58,7 @@ "Response": { "docs": "A generic response type used throughout the API. ", + "inline": undefined, "properties": { "value": { "docs": "An optional numerical value. diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/apiture.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/apiture.json index 0c12db90011..a8837830bb1 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/apiture.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/apiture.json @@ -425,6 +425,7 @@ This error response may have one of the following `type` values: "types": { "AbstractBody": { "docs": "An abstract schema used to define other request and response body model schemas.", + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -436,6 +437,7 @@ This error response may have one of the following `type` values: "AbstractBody", "AbstractPagedBodyFields", ], + "inline": undefined, "properties": { "start": { "docs": "The opaque cursor that specifies the starting location of this page of items.", @@ -454,6 +456,7 @@ This error response may have one of the following `type` values: }, "AbstractPagedBodyFields": { "docs": "Common properties of collection page responses.", + "inline": undefined, "properties": { "limit": { "default": 100, @@ -488,6 +491,7 @@ This error response may have one of the following `type` values: "AbstractBody", "AccountFields", ], + "inline": undefined, "properties": { "allows": { "docs": "Flags which indicate the permissions the current authorized user has on this account resource.", @@ -559,6 +563,7 @@ This error response may have one of the following `type` values: }, "AccountBalance": { "docs": "The current balances of the given account.", + "inline": undefined, "properties": { "available": { "docs": "The available balance: the funds available for use. This is the string representation of the exact decimal amount.", @@ -594,6 +599,7 @@ This error response may have one of the following `type` values: "extends": [ "AbstractBody", ], + "inline": undefined, "properties": { "items": { "docs": "An array of items, one for each of the `?accounts=` in the request, returned in the same order.", @@ -606,6 +612,7 @@ This error response may have one of the following `type` values: }, "AccountFields": { "docs": "Fragment schema use to build other account schemas.", + "inline": undefined, "properties": { "id": { "docs": "The unique identifier for this account resource. This is an immutable opaque string.", @@ -645,6 +652,7 @@ This error response may have one of the following `type` values: }, "AccountItem": { "docs": "An account item in a list items in the `accounts` schema.", + "inline": undefined, "properties": { "allows": { "type": "AccountPermissions", @@ -680,6 +688,7 @@ This error response may have one of the following `type` values: "extends": [ "AbstractBody", ], + "inline": undefined, "properties": { "id": "ReadOnlyResourceId", "name": { @@ -699,6 +708,7 @@ This error response may have one of the following `type` values: }, "AccountJointOwners": { "docs": undefined, + "inline": undefined, "properties": { "items": { "docs": "An array containing account joint owner items.", @@ -736,6 +746,7 @@ Account transfers are only allowed between `internal` and `external` accounts. A }, "AccountPermissions": { "docs": "Flags which indicate the permissions the current authorized user has on this account item resource. Most of these properties may only be `true` for internal accounts. These permissions are available in account items in the [`accounts`](#schema-accounts) list. See [`fullAccountPermissions`](#schema-fullAccountPermissions) for all capabilities a customer has on an account (the `account.allows` object in the [`account`](#schema-account) object response from [`getAccount`](#op-getAccount).)", + "inline": undefined, "properties": { "billPay": { "docs": "If `true`, the customer may use this account for Bill Pay.", @@ -785,6 +796,7 @@ Account transfers are only allowed between `internal` and `external` accounts. A "extends": [ "AbstractBody", ], + "inline": undefined, "properties": { "count": { "docs": "The total number of accounts for which the user has access. This value ignores any filters. This value is _optional_ and may be omitted if the count is not computable efficiently.", @@ -947,6 +959,7 @@ Account transfers are only allowed between `internal` and `external` accounts. A "extends": [ "AddressFields", ], + "inline": undefined, "properties": { "postalCode": { "docs": "The postal code, which varies in format by country. If `countryCode` is `US`, this should be a five digit US ZIP code or ten character ZIP+4.", @@ -985,6 +998,7 @@ Account transfers are only allowed between `internal` and `external` accounts. A }, "AddressFields": { "docs": "Properties of a simple address, used to compose other addresses.", + "inline": undefined, "properties": { "address1": { "docs": "The first line of the postal address. In the US, this typically includes the building number and street name.", @@ -1043,6 +1057,7 @@ Account transfers are only allowed between `internal` and `external` accounts. A }, "ApiProblem": { "docs": "API problem or error, as per [RFC 7807 application/problem+json](https://tools.ietf.org/html/rfc7807).", + "inline": undefined, "properties": { "attributes": { "docs": "Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.", @@ -1099,6 +1114,7 @@ Account transfers are only allowed between `internal` and `external` accounts. A }, "ChallengeFactor": { "docs": "An challenge factor. See [`requiredIdentityChallenge`](#schema-requiredIdentityChallenge) for multiple examples.", + "inline": undefined, "properties": { "labels": { "docs": "A list of text label which identifies the channel(s) though which the user completes the challenge. For an `sms` or `voice` challenge, the only label item is the last four digits of the corresponding phone number. For an `email` challenge, each label is the masked email address.", @@ -1172,6 +1188,7 @@ Account transfers are only allowed between `internal` and `external` accounts. A }, "ChallengeSecurityQuestion": { "docs": "A single security question within the `questions` array of the [`challengeSecurityQuestions`](#schema-challengeSecurityQuestions)", + "inline": undefined, "properties": { "id": { "docs": "The unique ID of security question prompt. This should be included in the [`challengeVerification`](#schema-challengeVerification) response as the `promptId`.", @@ -1194,6 +1211,7 @@ Account transfers are only allowed between `internal` and `external` accounts. A }, "ChallengeSecurityQuestions": { "docs": "Describes a `securityQuestions` challenge. This is omitted if the challenge `type` is not `securityQuestions`.", + "inline": undefined, "properties": { "questions": { "docs": "The array of security questions.", @@ -1230,6 +1248,7 @@ Account transfers are only allowed between `internal` and `external` accounts. A }, "CutoffTime": { "docs": "A representation of a cutoff time for a money movement process at a financial institution.", + "inline": undefined, "properties": { "time": { "docs": "The cutoff time for a product formatted in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) `time` format: `hh:mm`. The time is expressed in 24 hour time and is set to the local time zone of the financial institution.", @@ -1304,6 +1323,7 @@ Account transfers are only allowed between `internal` and `external` accounts. A "extends": [ "AbstractBody", ], + "inline": undefined, "properties": { "items": { "docs": "A list of cutoff times for a financial institution.", @@ -1338,6 +1358,7 @@ The client can use this value to localize the `items[].time` values to the local "extends": [ "AbstractBody", ], + "inline": undefined, "properties": { "items": "unknown", "limit": { @@ -1438,6 +1459,7 @@ The client can use this value to localize the `items[].time` values to the local "extends": [ "AccountPermissions", ], + "inline": undefined, "properties": { "manageJointOwners": { "docs": "If `true`, the customer can list the other joint owners on the account and invite new joint owners.", @@ -1457,6 +1479,7 @@ The client can use this value to localize the `items[].time` values to the local "extends": [ "AbstractBody", ], + "inline": undefined, "properties": { "incompleteAccounts": { "docs": "Pass these values as the `?accounts=` query parameter on the next retry of the [`listAccountBalances`](#op-listAccountBalances) operation. This value is empty if the client has reached the retry limit.", @@ -1487,6 +1510,7 @@ The client can use this value to localize the `items[].time` values to the local "extends": [ "AbstractBody", ], + "inline": undefined, "properties": { "retryCount": { "docs": "Pass this value as the as the `?retryCount=` parameter with the next retry of the [`listTransactions`](#op-listTransactions) operation.", @@ -1554,6 +1578,7 @@ The client can use this value to localize the `items[].time` values to the local "extends": [ "AbstractBody", ], + "inline": undefined, "properties": { "found": { "docs": "`true` if a financial institution was found matching the requested FI locator, `false` if none was found.", @@ -1578,6 +1603,7 @@ The client can use this value to localize the `items[].time` values to the local "AbstractBody", "JointOwnerInvitationFields", ], + "inline": undefined, "properties": { "id": { "docs": "The unique ID of the invitation.", @@ -1590,6 +1616,7 @@ The client can use this value to localize the `items[].time` values to the local }, "JointOwnerInvitationFields": { "docs": "Fields used to compose other joint owner invitation schemas.", + "inline": undefined, "properties": { "disallowDebitCardAccess": { "default": false, @@ -1673,6 +1700,7 @@ The client can use this value to localize the `items[].time` values to the local }, "OverdraftAccountFields": { "docs": "Fields of an overdraft protection account, used to compose other schemas.", + "inline": undefined, "properties": { "id": { "docs": "The unique ID of the account resource. Use this as the `{accountId}` in [`getAccount`](#op-getAccount) or [`listAccountBalances`](#op-listAccountBalances).", @@ -1706,6 +1734,7 @@ The client can use this value to localize the `items[].time` values to the local "AbstractBody", "OverdraftProtectionFields", ], + "inline": undefined, "properties": { "maximumOverdraftAccounts": { "docs": "The maximum number of overdraft protection accounts that may be linked to the account.", @@ -1725,6 +1754,7 @@ The client can use this value to localize the `items[].time` values to the local }, "OverdraftProtectionFields": { "docs": "Fields used to compose other overdraft protection schemas.", + "inline": undefined, "properties": { "accounts": { "type": "optional", @@ -1750,6 +1780,7 @@ The client can use this value to localize the `items[].time` values to the local "AbstractBody", "ApiProblem", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -1757,6 +1788,7 @@ The client can use this value to localize the `items[].time` values to the local }, "ProductReference": { "docs": "A reference to a banking product.", + "inline": undefined, "properties": { "code": { "docs": "The product's product code. Codes are unique to the financial institution.", @@ -1857,6 +1889,7 @@ The client can use this value to localize the `items[].time` values to the local }, "RequiredIdentityChallenge": { "docs": "A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 [Unauthorized problem response](#schema-apiProblem) when the 401 problem type name is `challengeRequired`. See the "Challenge API" for details.", + "inline": undefined, "properties": { "challengeId": { "docs": "The unique ID of this challenge instance. This is an opaque string. This is passed when starting a challenge factor or when validating the identity challenge responses.", @@ -1887,6 +1920,7 @@ The client can use this value to localize the `items[].time` values to the local }, "SimpleInstitution": { "docs": "A simple representation of a financial institution.", + "inline": undefined, "properties": { "address": { "docs": "The financial institution's postal mailing address.", @@ -1933,6 +1967,7 @@ The client can use this value to localize the `items[].time` values to the local }, "TimestampFields": { "docs": "Timestamps which describe when a resource was created or last updated.", + "inline": undefined, "properties": { "createdAt": { "docs": "The date-time when this resource was created, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. This is derived and immutable.", @@ -1949,6 +1984,7 @@ The client can use this value to localize the `items[].time` values to the local }, "TransactionCategories": { "docs": undefined, + "inline": undefined, "properties": { "items": { "docs": "An array containing transaction category items.", @@ -1961,6 +1997,7 @@ The client can use this value to localize the `items[].time` values to the local }, "TransactionCategorization": { "docs": "The transaction categorization.", + "inline": undefined, "properties": { "id": { "docs": "The unique ID of this transaction's category.", @@ -1986,6 +2023,7 @@ The client can use this value to localize the `items[].time` values to the local "AbstractBody", "TransactionCategorization", ], + "inline": undefined, "properties": { "type": { "type": "TransactionCategoryType", @@ -2037,6 +2075,7 @@ The client can use this value to localize the `items[].time` values to the local }, "TransactionCheck": { "docs": "Describes a check associated with a transaction for a checking account. This object is only present if the transaction `type` is `debit` and the `subtype` is `check`.", + "inline": undefined, "properties": { "imageBack_url": { "docs": "The URL for downloading the image of the front of the check.", @@ -2076,6 +2115,7 @@ The client can use this value to localize the `items[].time` values to the local }, "TransactionFields": { "docs": "Common fields of the transaction resource used to build other model schemas.", + "inline": undefined, "properties": { "amount": { "docs": "The transaction amount in dollars. This value is negative if the transaction is a debit and positive if it is a credit.", @@ -2180,6 +2220,7 @@ The client can use this value to localize the `items[].time` values to the local "AbstractBody", "TransactionFields", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -2187,6 +2228,7 @@ The client can use this value to localize the `items[].time` values to the local }, "TransactionMerchant": { "docs": "Describes the merchant associated with a transaction.", + "inline": undefined, "properties": { "logo_url": { "docs": "The optional URL of the merchant's logo. This image must be an image resource (SVG, PNG, GIF, JPEG image) that does not require any authentication. The URL may contain query parameters.", @@ -2293,6 +2335,7 @@ The client can use this value to localize the `items[].time` values to the local "extends": [ "AbstractPagedBody", ], + "inline": undefined, "properties": { "count": { "docs": "The total number of transactions which satisfy the request filters. This is optional and only included if the service can calculate it.", @@ -2320,6 +2363,7 @@ The client can use this value to localize the `items[].time` values to the local "AbstractBody", "TransferItem", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -2327,6 +2371,7 @@ The client can use this value to localize the `items[].time` values to the local }, "TransferAccountReference": { "docs": "A reference to a banking account used within an account to account transfer. This object may be set from an account's `account.reference` object.", + "inline": undefined, "properties": { "id": { "docs": "The unique ID of a banking account.", @@ -2357,6 +2402,7 @@ The client can use this value to localize the `items[].time` values to the local }, "TransferDateRestriction": { "docs": "A date where a transfer restriction occurs, and the `reason` it is restricted. If the `reason` is `holiday`, `closure` and the transfer is an ACH transfer, the object also contains either a `debitOn` or `creditOn` date or both.", + "inline": undefined, "properties": { "creditOn": { "docs": "The date the local financial institution account is credited in [RFC 3339 `YYYY-MM-DD`](https://tools.ietf.org/html/rfc3339) date format. This is derived from the `date` based on the `risk` level. The credit-on date normally falls one business day after the restricted `date`. This property is only returned if the payment `type` is `achDebit` or `ach`.", @@ -2453,6 +2499,7 @@ The response may include dates prior to requested the start date, as that is use "extends": [ "AbstractBody", ], + "inline": undefined, "properties": { "accuracyEndsOn": { "docs": "The service only knows [bank holidays](https://www.federalreserve.gov/aboutthefed/k8.htm) for about two to four years in advance. This date is the end of that known holiday schedule, although the requested dates may extend well beyond this date. Any dates in the response beyond this date may omit holidays but may include other restricted dates based on the financial institution's normal scheduled closures such as Saturdays and Sundays.", @@ -2475,6 +2522,7 @@ The response may include dates prior to requested the start date, as that is use }, "TransferFields": { "docs": "Common fields of the transfer resource used to build other model schemas.", + "inline": undefined, "properties": { "amount": { "docs": "The amount of money to transfer between accounts.", @@ -2594,6 +2642,7 @@ The response may include dates prior to requested the start date, as that is use "TransferFields", "TimestampFields", ], + "inline": undefined, "properties": { "id": { "docs": "The unique identifier for this transfer resource. This is an immutable opaque string.", @@ -2631,6 +2680,7 @@ The response may include dates prior to requested the start date, as that is use "extends": [ "TransferSchedule", ], + "inline": undefined, "properties": { "creditsOn": { "docs": "The effective the transfer is scheduled to credit the target account, in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) `date` format. This is derived from the `scheduledOn` date, based on the financial institution's transfer rules.", @@ -2691,6 +2741,7 @@ The response may include dates prior to requested the start date, as that is use "docs": "The scheduled date when the transfer should be completed, the recurrence, if any, and other derived dates based on the scheduled date. For recurring transfer schedules, `endsOn`, `count`, and `amountLimit` are mutually exclusive.", + "inline": undefined, "properties": { "amountLimit": { "docs": "For recurring schedules (`frequency` is not `once`), this is the total dollar amount limit including the first transfer. No transfers are scheduled if they would exceed this amount. This property is ignored if `frequency` is `once`.", @@ -2776,6 +2827,7 @@ For recurring transfer schedules, `endsOn`, `count`, and `amountLimit` are mutua }, "TransferScheduleItem": { "docs": "Summary representation of a transfer schedule resource in transfer schedule list.", + "inline": undefined, "properties": { "effectiveOn": { "docs": "The effective date of the recurrence in `YYYY-MM-DD` [RFC 3339](https://tools.ietf.org/html/rfc3339) date format. When the effective date differs from the scheduled date, it is due to a banking holiday, weekend, or other non-business day. The date is adjusted to before the scheduled date when the transfer direction is `credit` and adjusted to after the scheduled date when the transfer direction is `debit`.", @@ -2807,6 +2859,7 @@ For recurring transfer schedules, `endsOn`, `count`, and `amountLimit` are mutua "extends": [ "AbstractBody", ], + "inline": undefined, "properties": { "items": { "docs": "An array containing upcoming transfer schedule items.", @@ -2926,6 +2979,7 @@ For recurring transfer schedules, `endsOn`, `count`, and `amountLimit` are mutua "extends": [ "AbstractPagedBody", ], + "inline": undefined, "properties": { "count": { "docs": "The number of transfers that meet the filters in the `listTransfers` operation. This is optional and only included if the service can calculate it efficiently.", @@ -2952,6 +3006,7 @@ For recurring transfer schedules, `endsOn`, `count`, and `amountLimit` are mutua "extends": [ "SimpleInstitution", ], + "inline": undefined, "properties": { "localClearingCode": { "docs": "The clearing code used to identify the financial institution for select countries.", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/application-json.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/application-json.json index e2c70ce1468..38a6d0941a4 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/application-json.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/application-json.json @@ -65,6 +65,7 @@ "types": { "Data": { "docs": undefined, + "inline": undefined, "properties": { "bar": "optional", "foo": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/aries.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/aries.json index a2ba8aa0d7c..ce5781685ec 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/aries.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/aries.json @@ -89,6 +89,7 @@ "types": { "AMLRecord": { "docs": undefined, + "inline": undefined, "properties": { "aml": { "type": "optional>", @@ -106,6 +107,7 @@ }, "ActionMenuFetchResult": { "docs": undefined, + "inline": undefined, "properties": { "result": { "type": "optional", @@ -122,6 +124,7 @@ "ActionMenuModulesResult": "map", "AdminConfig": { "docs": undefined, + "inline": undefined, "properties": { "config": { "docs": "Configuration settings", @@ -134,6 +137,7 @@ }, "AdminConfigConfig": { "docs": "Configuration settings", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -141,6 +145,7 @@ }, "AdminModules": { "docs": undefined, + "inline": undefined, "properties": { "result": { "docs": "List of admin modules", @@ -155,6 +160,7 @@ "AdminShutdown": "map", "AdminStatus": { "docs": undefined, + "inline": undefined, "properties": { "conductor": { "docs": "Conductor statistics", @@ -179,6 +185,7 @@ }, "AdminStatusConductor": { "docs": "Conductor statistics", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -186,6 +193,7 @@ }, "AdminStatusLiveliness": { "docs": undefined, + "inline": undefined, "properties": { "alive": { "docs": "Liveliness status", @@ -198,6 +206,7 @@ }, "AdminStatusReadiness": { "docs": undefined, + "inline": undefined, "properties": { "ready": { "docs": "Readiness status", @@ -210,6 +219,7 @@ }, "AdminStatusTiming": { "docs": "Timing results", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -217,6 +227,7 @@ }, "AttachDecorator": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Attachment identifier", @@ -258,6 +269,7 @@ }, "AttachDecoratorData": { "docs": undefined, + "inline": undefined, "properties": { "base64": { "docs": "Base64-encoded data", @@ -297,6 +309,7 @@ }, "AttachDecoratorData1Jws": { "docs": undefined, + "inline": undefined, "properties": { "header": { "type": "AttachDecoratorDataJWSHeader", @@ -328,6 +341,7 @@ }, "AttachDecoratorDataJWS": { "docs": undefined, + "inline": undefined, "properties": { "header": { "type": "optional", @@ -363,6 +377,7 @@ }, "AttachDecoratorDataJWSHeader": { "docs": undefined, + "inline": undefined, "properties": { "kid": { "docs": "Key identifier, in W3C did:key or DID URL format", @@ -385,6 +400,7 @@ }, "AttachmentDef": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "Attachment identifier", @@ -417,6 +433,7 @@ }, "AttributeMimeTypesResult": { "docs": undefined, + "inline": undefined, "properties": { "results": { "type": "optional>>", @@ -429,6 +446,7 @@ "BasicMessageModuleResponse": "map", "ClaimFormat": { "docs": undefined, + "inline": undefined, "properties": { "jwt": { "type": "optional", @@ -455,6 +473,7 @@ }, "ClaimFormatJwtVc": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -462,6 +481,7 @@ }, "ClaimFormatJwtVp": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -469,6 +489,7 @@ }, "ClaimFormatLdpVc": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -476,6 +497,7 @@ }, "ClaimFormatLdpVp": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -483,6 +505,7 @@ }, "ConnRecord": { "docs": undefined, + "inline": undefined, "properties": { "accept": { "docs": "Connection acceptance: manual or auto", @@ -662,6 +685,7 @@ }, "ConnectionInvitation": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -708,6 +732,7 @@ }, "ConnectionList": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "List of connection records", @@ -720,6 +745,7 @@ }, "ConnectionMetadata": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "Dictionary of metadata associated with connection.", @@ -732,6 +758,7 @@ }, "ConnectionMetadataResults": { "docs": "Dictionary of metadata associated with connection.", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -740,6 +767,7 @@ "ConnectionModuleResponse": "map", "ConnectionStaticResult": { "docs": undefined, + "inline": undefined, "properties": { "my_did": { "docs": "Local DID", @@ -801,6 +829,7 @@ }, "Constraints": { "docs": undefined, + "inline": undefined, "properties": { "fields": { "type": "optional>", @@ -872,6 +901,7 @@ }, "CreateWalletResponse": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Time of record creation", @@ -930,6 +960,7 @@ }, "CreateWalletResponseSettings": { "docs": "Settings for this wallet.", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -937,6 +968,7 @@ }, "CreateWalletTokenResponse": { "docs": undefined, + "inline": undefined, "properties": { "token": { "docs": "Authorization token to authenticate wallet requests", @@ -949,6 +981,7 @@ }, "CredAttrSpec": { "docs": undefined, + "inline": undefined, "properties": { "mime-type": { "docs": "MIME type: omit for (null) default", @@ -969,6 +1002,7 @@ }, "CredDefValue": { "docs": undefined, + "inline": undefined, "properties": { "primary": { "type": "optional", @@ -983,6 +1017,7 @@ }, "CredDefValuePrimary": { "docs": undefined, + "inline": undefined, "properties": { "n": { "type": "optional", @@ -1030,6 +1065,7 @@ }, "CredDefValueRevocation": { "docs": undefined, + "inline": undefined, "properties": { "g": { "type": "optional", @@ -1071,6 +1107,7 @@ }, "CredInfoList": { "docs": undefined, + "inline": undefined, "properties": { "results": { "type": "optional>", @@ -1082,6 +1119,7 @@ }, "CredRevIndyRecordsResult": { "docs": undefined, + "inline": undefined, "properties": { "rev_reg_delta": { "docs": "Indy revocation registry delta", @@ -1094,6 +1132,7 @@ }, "CredRevIndyRecordsResultRevRegDelta": { "docs": "Indy revocation registry delta", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -1101,6 +1140,7 @@ }, "CredRevRecordDetailsResult": { "docs": undefined, + "inline": undefined, "properties": { "results": { "type": "optional>", @@ -1112,6 +1152,7 @@ }, "CredRevRecordResult": { "docs": undefined, + "inline": undefined, "properties": { "result": { "type": "optional", @@ -1123,6 +1164,7 @@ }, "CredRevokedResult": { "docs": undefined, + "inline": undefined, "properties": { "revoked": { "docs": "Whether credential is revoked on the ledger", @@ -1135,6 +1177,7 @@ }, "Credential": { "docs": undefined, + "inline": undefined, "properties": { "@context": { "docs": "The JSON-LD context of the credential", @@ -1190,6 +1233,7 @@ }, "CredentialDefinition": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "Credential definition identifier", @@ -1233,6 +1277,7 @@ }, "CredentialDefinitionGetResult": { "docs": undefined, + "inline": undefined, "properties": { "credential_definition": { "type": "optional", @@ -1244,6 +1289,7 @@ }, "CredentialDefinitionSendResult": { "docs": undefined, + "inline": undefined, "properties": { "credential_definition_id": { "docs": "Credential definition identifier", @@ -1266,6 +1312,7 @@ }, "CredentialDefinitionsCreatedResult": { "docs": undefined, + "inline": undefined, "properties": { "credential_definition_ids": { "type": "optional>", @@ -1277,6 +1324,7 @@ }, "CredentialOffer": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -1303,6 +1351,7 @@ }, "CredentialPreview": { "docs": undefined, + "inline": undefined, "properties": { "@type": { "docs": "Message type identifier", @@ -1320,6 +1369,7 @@ }, "CredentialProposal": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -1391,6 +1441,7 @@ }, "CredentialStatusOptions": { "docs": undefined, + "inline": undefined, "properties": { "type": { "docs": "Credential status method type to use for the credential. Should match status method registered in the Verifiable Credential Extension Registry", @@ -1403,6 +1454,7 @@ }, "DID": { "docs": undefined, + "inline": undefined, "properties": { "did": { "docs": "DID of interest", @@ -1443,6 +1495,7 @@ }, "DIDCreateOptions": { "docs": undefined, + "inline": undefined, "properties": { "did": { "docs": "Specify final value of the did (including did:: prefix)if the method supports or requires so.", @@ -1465,6 +1518,7 @@ }, "DIDEndpoint": { "docs": undefined, + "inline": undefined, "properties": { "did": { "docs": "DID of interest", @@ -1493,6 +1547,7 @@ }, "DIDList": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "DID list", @@ -1505,6 +1560,7 @@ }, "DIDResult": { "docs": undefined, + "inline": undefined, "properties": { "result": { "type": "optional", @@ -1516,6 +1572,7 @@ }, "DIFField": { "docs": undefined, + "inline": undefined, "properties": { "filter": { "type": "optional", @@ -1542,6 +1599,7 @@ }, "DIFHolder": { "docs": undefined, + "inline": undefined, "properties": { "directive": { "docs": "Preference", @@ -1557,6 +1615,7 @@ }, "DIFOptions": { "docs": undefined, + "inline": undefined, "properties": { "challenge": { "docs": "Challenge protect against replay attack", @@ -1579,6 +1638,7 @@ }, "DIFPresSpec": { "docs": undefined, + "inline": undefined, "properties": { "issuer_id": { "docs": "Issuer identifier to sign the presentation, if different from current public DID", @@ -1602,6 +1662,7 @@ }, "DIFProofProposal": { "docs": undefined, + "inline": undefined, "properties": { "input_descriptors": { "type": "optional>", @@ -1616,6 +1677,7 @@ }, "DIFProofRequest": { "docs": undefined, + "inline": undefined, "properties": { "options": { "type": "optional", @@ -1669,6 +1731,7 @@ }, "DifPresSpecRecordIds": { "docs": "Mapping of input_descriptor id to list of stored W3C credential record_id", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -1676,6 +1739,7 @@ }, "DifPresSpecRevealDoc": { "docs": "reveal doc [JSON-LD frame] dict used to derive the credential when selective disclosure is required", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -1683,6 +1747,7 @@ }, "Disclose": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -1703,6 +1768,7 @@ }, "Disclosures": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -1723,6 +1789,7 @@ }, "Doc": { "docs": undefined, + "inline": undefined, "properties": { "credential": { "docs": "Credential to sign", @@ -1736,6 +1803,7 @@ }, "DocCredential": { "docs": "Credential to sign", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -1747,6 +1815,7 @@ }, "EndorserInfo": { "docs": undefined, + "inline": undefined, "properties": { "endorser_did": { "docs": "Endorser DID", @@ -1763,6 +1832,7 @@ }, "EndpointsResult": { "docs": undefined, + "inline": undefined, "properties": { "my_endpoint": { "docs": "My endpoint", @@ -1791,6 +1861,7 @@ }, "Filter": { "docs": undefined, + "inline": undefined, "properties": { "const": { "docs": "Const", @@ -1846,6 +1917,7 @@ }, "Generated": { "docs": undefined, + "inline": undefined, "properties": { "master_secret": { "type": "optional", @@ -1881,6 +1953,7 @@ }, "GetDIDEndpointResponse": { "docs": undefined, + "inline": undefined, "properties": { "endpoint": { "docs": "Full verification key", @@ -1899,6 +1972,7 @@ }, "GetDIDVerkeyResponse": { "docs": undefined, + "inline": undefined, "properties": { "verkey": { "docs": "Full verification key", @@ -1917,6 +1991,7 @@ }, "GetNymRoleResponse": { "docs": undefined, + "inline": undefined, "properties": { "role": { "docs": "Ledger role", @@ -1944,6 +2019,7 @@ "HolderModuleResponse": "map", "IndyAttrValue": { "docs": undefined, + "inline": undefined, "properties": { "encoded": { "docs": "Attribute encoded value", @@ -1966,6 +2042,7 @@ }, "IndyCredAbstract": { "docs": undefined, + "inline": undefined, "properties": { "cred_def_id": { "docs": "Credential definition identifier", @@ -2009,6 +2086,7 @@ }, "IndyCredInfo": { "docs": undefined, + "inline": undefined, "properties": { "attrs": { "docs": "Attribute names and value", @@ -2065,6 +2143,7 @@ }, "IndyCredPrecis": { "docs": undefined, + "inline": undefined, "properties": { "cred_info": { "type": "optional", @@ -2090,6 +2169,7 @@ }, "IndyCredRequest": { "docs": undefined, + "inline": undefined, "properties": { "blinded_ms": { "docs": "Blinded master secret", @@ -2136,6 +2216,7 @@ }, "IndyCredRequestBlindedMs": { "docs": "Blinded master secret", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -2143,6 +2224,7 @@ }, "IndyCredRequestBlindedMsCorrectnessProof": { "docs": "Blinded master secret correctness proof", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -2150,6 +2232,7 @@ }, "IndyCredential": { "docs": undefined, + "inline": undefined, "properties": { "cred_def_id": { "docs": "Credential definition identifier", @@ -2208,6 +2291,7 @@ }, "IndyCredentialRevReg": { "docs": "Revocation registry state", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -2215,6 +2299,7 @@ }, "IndyCredentialSignatureCorrectnessProof": { "docs": "Credential signature correctness proof", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -2226,6 +2311,7 @@ }, "IndyEQProof": { "docs": undefined, + "inline": undefined, "properties": { "a_prime": { "type": "optional", @@ -2276,6 +2362,7 @@ }, "IndyGEProof": { "docs": undefined, + "inline": undefined, "properties": { "alpha": { "type": "optional", @@ -2314,6 +2401,7 @@ }, "IndyGEProofPred": { "docs": undefined, + "inline": undefined, "properties": { "attr_name": { "docs": "Attribute name, indy-canonicalized", @@ -2346,6 +2434,7 @@ }, "IndyKeyCorrectnessProof": { "docs": undefined, + "inline": undefined, "properties": { "c": { "docs": "c in key correctness proof", @@ -2378,6 +2467,7 @@ }, "IndyNonRevocProof": { "docs": undefined, + "inline": undefined, "properties": { "c_list": { "type": "optional>", @@ -2392,6 +2482,7 @@ }, "IndyNonRevocationInterval": { "docs": undefined, + "inline": undefined, "properties": { "from": { "docs": "Earliest time of interest in non-revocation interval", @@ -2422,6 +2513,7 @@ }, "IndyPresAttrSpec": { "docs": undefined, + "inline": undefined, "properties": { "cred_def_id": { "type": "optional", @@ -2455,6 +2547,7 @@ }, "IndyPresPredSpec": { "docs": undefined, + "inline": undefined, "properties": { "cred_def_id": { "docs": "Credential definition identifier", @@ -2509,6 +2602,7 @@ }, "IndyPresPreview": { "docs": undefined, + "inline": undefined, "properties": { "@type": { "docs": "Message type identifier", @@ -2523,6 +2617,7 @@ }, "IndyPresSpec": { "docs": undefined, + "inline": undefined, "properties": { "requested_attributes": { "docs": "Nested object mapping proof request attribute referents to requested-attribute specifiers", @@ -2547,6 +2642,7 @@ }, "IndyPrimaryProof": { "docs": undefined, + "inline": undefined, "properties": { "eq_proof": { "type": "optional", @@ -2566,6 +2662,7 @@ }, "IndyProof": { "docs": undefined, + "inline": undefined, "properties": { "identifiers": { "docs": "Indy proof.identifiers content", @@ -2584,6 +2681,7 @@ }, "IndyProofIdentifier": { "docs": undefined, + "inline": undefined, "properties": { "cred_def_id": { "docs": "Credential definition identifier", @@ -2633,6 +2731,7 @@ }, "IndyProofProof": { "docs": undefined, + "inline": undefined, "properties": { "aggregated_proof": { "type": "optional", @@ -2648,6 +2747,7 @@ }, "IndyProofProofAggregatedProof": { "docs": undefined, + "inline": undefined, "properties": { "c_hash": { "docs": "c_hash value", @@ -2664,6 +2764,7 @@ }, "IndyProofProofProofsProof": { "docs": undefined, + "inline": undefined, "properties": { "non_revoc_proof": { "type": "optional", @@ -2686,6 +2787,7 @@ }, "IndyProofReqAttrSpec": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "Attribute name", @@ -2709,6 +2811,7 @@ }, "IndyProofReqAttrSpecNonRevoked": { "docs": undefined, + "inline": undefined, "properties": { "from": { "docs": "Earliest time of interest in non-revocation interval", @@ -2739,6 +2842,7 @@ }, "IndyProofReqPredSpec": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "Attribute name", @@ -2766,6 +2870,7 @@ }, "IndyProofReqPredSpecNonRevoked": { "docs": undefined, + "inline": undefined, "properties": { "from": { "docs": "Earliest time of interest in non-revocation interval", @@ -2820,6 +2925,7 @@ }, "IndyProofRequest": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "Proof request name", @@ -2863,6 +2969,7 @@ }, "IndyProofRequestNonRevoked": { "docs": undefined, + "inline": undefined, "properties": { "from": { "docs": "Earliest time of interest in non-revocation interval", @@ -2893,6 +3000,7 @@ }, "IndyProofRequestedProof": { "docs": undefined, + "inline": undefined, "properties": { "predicates": { "docs": "Proof requested proof predicates.", @@ -2921,6 +3029,7 @@ }, "IndyProofRequestedProofPredicate": { "docs": undefined, + "inline": undefined, "properties": { "sub_proof_index": { "docs": "Sub-proof index", @@ -2933,6 +3042,7 @@ }, "IndyProofRequestedProofRevealedAttr": { "docs": undefined, + "inline": undefined, "properties": { "encoded": { "docs": "Encoded value", @@ -2959,6 +3069,7 @@ }, "IndyProofRequestedProofRevealedAttrGroup": { "docs": undefined, + "inline": undefined, "properties": { "sub_proof_index": { "docs": "Sub-proof index", @@ -2975,6 +3086,7 @@ }, "IndyProofRequestedProofSelfAttestedAttrs": { "docs": "Proof requested proof self-attested attributes", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -2982,6 +3094,7 @@ }, "IndyProofRequestedProofUnrevealedAttrs": { "docs": "Unrevealed attributes", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -2989,6 +3102,7 @@ }, "IndyRequestedCredsRequestedAttr": { "docs": undefined, + "inline": undefined, "properties": { "cred_id": { "docs": "Wallet credential identifier (typically but not necessarily a UUID)", @@ -3005,6 +3119,7 @@ }, "IndyRequestedCredsRequestedPred": { "docs": undefined, + "inline": undefined, "properties": { "cred_id": { "docs": "Wallet credential identifier (typically but not necessarily a UUID)", @@ -3028,6 +3143,7 @@ }, "IndyRevRegDef": { "docs": undefined, + "inline": undefined, "properties": { "credDefId": { "docs": "Credential definition identifier", @@ -3077,6 +3193,7 @@ }, "IndyRevRegDefValue": { "docs": undefined, + "inline": undefined, "properties": { "issuanceType": { "docs": "Issuance type", @@ -3117,6 +3234,7 @@ }, "IndyRevRegDefValuePublicKeys": { "docs": undefined, + "inline": undefined, "properties": { "accumKey": { "type": "optional", @@ -3128,6 +3246,7 @@ }, "IndyRevRegDefValuePublicKeysAccumKey": { "docs": undefined, + "inline": undefined, "properties": { "z": { "docs": "Value for z", @@ -3140,6 +3259,7 @@ }, "IndyRevRegEntry": { "docs": undefined, + "inline": undefined, "properties": { "value": { "type": "optional", @@ -3161,6 +3281,7 @@ }, "IndyRevRegEntryValue": { "docs": undefined, + "inline": undefined, "properties": { "accum": { "docs": "Accumulator value", @@ -3181,6 +3302,7 @@ }, "InputDescriptors": { "docs": undefined, + "inline": undefined, "properties": { "constraints": { "type": "optional", @@ -3219,6 +3341,7 @@ "IntroModuleResponse": "map", "InvitationMessage": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -3257,6 +3380,7 @@ }, "InvitationRecord": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Time of record creation", @@ -3316,6 +3440,7 @@ }, "InvitationResult": { "docs": undefined, + "inline": undefined, "properties": { "connection_id": { "docs": "Connection identifier", @@ -3336,6 +3461,7 @@ "IssueCredentialModuleResponse": "map", "IssuerCredRevRecord": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Time of record creation", @@ -3410,6 +3536,7 @@ }, "IssuerRevRegRecord": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Time of record creation", @@ -3528,6 +3655,7 @@ }, "Keylist": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "List of keylist records", @@ -3540,6 +3668,7 @@ }, "KeylistQuery": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -3563,6 +3692,7 @@ }, "KeylistQueryFilter": { "docs": "Query dictionary object", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -3570,6 +3700,7 @@ }, "KeylistQueryPaginate": { "docs": undefined, + "inline": undefined, "properties": { "limit": { "docs": "Limit for keylist query", @@ -3586,6 +3717,7 @@ }, "KeylistUpdate": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -3606,6 +3738,7 @@ }, "KeylistUpdateRule": { "docs": undefined, + "inline": undefined, "properties": { "action": { "docs": "Action for specific key", @@ -3638,6 +3771,7 @@ }, "LDProofVCDetail": { "docs": undefined, + "inline": undefined, "properties": { "credential": "LdProofVcDetailCredential", "options": "LdProofVcDetailOptions", @@ -3648,6 +3782,7 @@ }, "LDProofVCDetailOptions": { "docs": undefined, + "inline": undefined, "properties": { "challenge": { "docs": "A challenge to include in the proof. SHOULD be provided by the requesting party of the credential (=holder)", @@ -3697,6 +3832,7 @@ }, "LedgerConfigInstance": { "docs": undefined, + "inline": undefined, "properties": { "genesis_file": { "docs": "genesis_file", @@ -3725,6 +3861,7 @@ }, "LedgerConfigList": { "docs": undefined, + "inline": undefined, "properties": { "ledger_config_list": "list", }, @@ -3735,6 +3872,7 @@ "LedgerModulesResult": "map", "LinkedDataProof": { "docs": undefined, + "inline": undefined, "properties": { "challenge": { "docs": "Associates a challenge with a proof, for use with a proofPurpose such as authentication", @@ -3797,6 +3935,7 @@ }, "MediationDeny": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -3819,6 +3958,7 @@ }, "MediationGrant": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -3842,6 +3982,7 @@ }, "MediationList": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "List of mediation records", @@ -3854,6 +3995,7 @@ }, "MediationRecord": { "docs": undefined, + "inline": undefined, "properties": { "connection_id": "string", "created_at": { @@ -3903,6 +4045,7 @@ }, "Menu": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -3935,6 +4078,7 @@ }, "MenuForm": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "Additional descriptive text for menu form", @@ -3959,6 +4103,7 @@ }, "MenuFormParam": { "docs": undefined, + "inline": undefined, "properties": { "default": { "docs": "Default parameter value", @@ -3991,6 +4136,7 @@ }, "MenuJson": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "Introductory text for the menu", @@ -4015,6 +4161,7 @@ }, "MenuOption": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "Additional descriptive text for menu option", @@ -4043,6 +4190,7 @@ "MultitenantModuleResponse": "map", "OobRecord": { "docs": undefined, + "inline": undefined, "properties": { "attach_thread_id": { "docs": "Connection record identifier", @@ -4144,6 +4292,7 @@ }, "PingRequestResponse": { "docs": undefined, + "inline": undefined, "properties": { "thread_id": { "docs": "Thread ID of the ping message", @@ -4156,6 +4305,7 @@ }, "PresentationDefinition": { "docs": undefined, + "inline": undefined, "properties": { "format": { "type": "optional", @@ -4191,6 +4341,7 @@ }, "PresentationProposal": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -4214,6 +4365,7 @@ }, "PresentationRequest": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -4237,6 +4389,7 @@ }, "ProtocolDescriptor": { "docs": undefined, + "inline": undefined, "properties": { "pid": "string", "roles": { @@ -4250,6 +4403,7 @@ }, "PublishRevocations": { "docs": undefined, + "inline": undefined, "properties": { "rrid2crid": { "docs": "Credential revocation ids by revocation registry id", @@ -4262,6 +4416,7 @@ }, "Queries": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -4281,6 +4436,7 @@ }, "Query": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -4301,6 +4457,7 @@ }, "QueryItem": { "docs": undefined, + "inline": undefined, "properties": { "feature-type": { "docs": "feature type", @@ -4330,6 +4487,7 @@ }, "RawEncoded": { "docs": undefined, + "inline": undefined, "properties": { "encoded": { "docs": "Encoded value", @@ -4352,6 +4510,7 @@ }, "ResolutionResult": { "docs": undefined, + "inline": undefined, "properties": { "did_document": { "docs": "DID Document", @@ -4368,6 +4527,7 @@ }, "ResolutionResultDidDocument": { "docs": "DID Document", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4375,6 +4535,7 @@ }, "ResolutionResultMetadata": { "docs": "Resolution metadata", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4382,6 +4543,7 @@ }, "RevRegIssuedResult": { "docs": undefined, + "inline": undefined, "properties": { "result": { "docs": "Number of credentials issued against revocation registry", @@ -4401,6 +4563,7 @@ }, "RevRegResult": { "docs": undefined, + "inline": undefined, "properties": { "result": { "type": "optional", @@ -4412,6 +4575,7 @@ }, "RevRegWalletUpdatedResult": { "docs": undefined, + "inline": undefined, "properties": { "accum_calculated": { "docs": "Calculated accumulator for phantom revocations", @@ -4432,6 +4596,7 @@ }, "RevRegWalletUpdatedResultAccumCalculated": { "docs": "Calculated accumulator for phantom revocations", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4439,6 +4604,7 @@ }, "RevRegWalletUpdatedResultAccumFixed": { "docs": "Applied ledger transaction to fix revocations", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4446,6 +4612,7 @@ }, "RevRegWalletUpdatedResultRevRegDelta": { "docs": "Indy revocation registry delta", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4453,6 +4620,7 @@ }, "RevRegsCreated": { "docs": undefined, + "inline": undefined, "properties": { "rev_reg_ids": { "type": "optional>", @@ -4465,6 +4633,7 @@ "RevocationModuleResponse": "map", "RouteRecord": { "docs": undefined, + "inline": undefined, "properties": { "connection_id": { "type": "optional", @@ -4510,6 +4679,7 @@ }, "Schema": { "docs": undefined, + "inline": undefined, "properties": { "attrNames": { "docs": "Schema attribute names", @@ -4567,6 +4737,7 @@ }, "SchemaGetResult": { "docs": undefined, + "inline": undefined, "properties": { "schema": { "type": "optional", @@ -4578,6 +4749,7 @@ }, "SchemaInputDescriptor": { "docs": undefined, + "inline": undefined, "properties": { "required": { "docs": "Required", @@ -4594,6 +4766,7 @@ }, "SchemaSendResult": { "docs": undefined, + "inline": undefined, "properties": { "schema": { "type": "optional", @@ -4619,6 +4792,7 @@ }, "SchemasCreatedResult": { "docs": undefined, + "inline": undefined, "properties": { "schema_ids": { "type": "optional>", @@ -4630,6 +4804,7 @@ }, "SchemasInputDescriptorFilter": { "docs": undefined, + "inline": undefined, "properties": { "oneof_filter": { "docs": "oneOf", @@ -4649,6 +4824,7 @@ }, "ServiceDecorator": { "docs": undefined, + "inline": undefined, "properties": { "recipientKeys": { "docs": "List of recipient keys", @@ -4669,6 +4845,7 @@ }, "SignResponse": { "docs": undefined, + "inline": undefined, "properties": { "error": { "docs": "Error text", @@ -4685,6 +4862,7 @@ }, "SignResponseSignedDoc": { "docs": "Signed document", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4692,6 +4870,7 @@ }, "SignatureOptions": { "docs": undefined, + "inline": undefined, "properties": { "challenge": { "type": "optional", @@ -4711,6 +4890,7 @@ }, "SignedDoc": { "docs": undefined, + "inline": undefined, "properties": { "proof": "SignedDocProof", }, @@ -4724,6 +4904,7 @@ }, "SubmissionRequirements": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "Count Value", @@ -4763,6 +4944,7 @@ }, "TAAAcceptance": { "docs": undefined, + "inline": undefined, "properties": { "mechanism": { "type": "optional", @@ -4784,6 +4966,7 @@ }, "TAAInfo": { "docs": undefined, + "inline": undefined, "properties": { "aml_record": { "type": "optional", @@ -4804,6 +4987,7 @@ }, "TAARecord": { "docs": undefined, + "inline": undefined, "properties": { "digest": { "type": "optional", @@ -4821,6 +5005,7 @@ }, "TAAResult": { "docs": undefined, + "inline": undefined, "properties": { "result": { "type": "optional", @@ -4832,6 +5017,7 @@ }, "TailsDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "message": { "type": "optional", @@ -4843,6 +5029,7 @@ }, "TransactionJobs": { "docs": undefined, + "inline": undefined, "properties": { "transaction_my_job": { "docs": "My transaction related job", @@ -4881,6 +5068,7 @@ }, "TransactionList": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "List of transaction records", @@ -4893,6 +5081,7 @@ }, "TransactionRecord": { "docs": undefined, + "inline": undefined, "properties": { "_type": { "docs": "Transaction type", @@ -4967,6 +5156,7 @@ }, "TransactionRecordMessagesAttachItem": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4974,6 +5164,7 @@ }, "TransactionRecordMetaData": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4981,6 +5172,7 @@ }, "TransactionRecordSignatureRequestItem": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4988,6 +5180,7 @@ }, "TransactionRecordSignatureResponseItem": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4995,6 +5188,7 @@ }, "TransactionRecordTiming": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -5002,6 +5196,7 @@ }, "TxnOrCredentialDefinitionSendResult": { "docs": undefined, + "inline": undefined, "properties": { "sent": { "type": "optional", @@ -5020,6 +5215,7 @@ }, "TxnOrPublishRevocationsResult": { "docs": undefined, + "inline": undefined, "properties": { "sent": { "type": "optional", @@ -5038,6 +5234,7 @@ }, "TxnOrRegisterLedgerNymResponse": { "docs": undefined, + "inline": undefined, "properties": { "success": { "docs": "Success of nym registration operation", @@ -5057,6 +5254,7 @@ }, "TxnOrRevRegResult": { "docs": undefined, + "inline": undefined, "properties": { "sent": { "type": "optional", @@ -5075,6 +5273,7 @@ }, "TxnOrSchemaSendResult": { "docs": undefined, + "inline": undefined, "properties": { "sent": { "type": "optional", @@ -5101,6 +5300,7 @@ }, "V10CredentialExchange": { "docs": undefined, + "inline": undefined, "properties": { "auto_issue": { "docs": "Issuer choice to issue to request in this credential exchange", @@ -5251,6 +5451,7 @@ }, "V10CredentialExchangeCredentialRequestMetadata": { "docs": "(Indy) credential request metadata", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -5268,6 +5469,7 @@ }, "V10CredentialExchangeListResult": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "Aries#0036 v1.0 credential exchange records", @@ -5294,6 +5496,7 @@ }, "V10DiscoveryExchangeListResult": { "docs": undefined, + "inline": undefined, "properties": { "results": { "type": "optional>", @@ -5309,6 +5512,7 @@ }, "V10DiscoveryRecord": { "docs": undefined, + "inline": undefined, "properties": { "connection_id": { "docs": "Connection identifier", @@ -5372,6 +5576,7 @@ "V10PresentProofModuleResponse": "map", "V10PresentationExchange": { "docs": undefined, + "inline": undefined, "properties": { "auto_present": { "docs": "Prover choice to auto-present proof as verifier requests", @@ -5469,6 +5674,7 @@ }, "V10PresentationExchangeList": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "Aries RFC 37 v1.0 presentation exchange records", @@ -5517,6 +5723,7 @@ }, "V20CredAttrSpec": { "docs": undefined, + "inline": undefined, "properties": { "mime-type": { "docs": "MIME type: omit for (null) default", @@ -5545,6 +5752,7 @@ }, "V20CredExFree": { "docs": undefined, + "inline": undefined, "properties": { "auto_remove": { "docs": "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", @@ -5583,6 +5791,7 @@ }, "V20CredExRecord": { "docs": undefined, + "inline": undefined, "properties": { "auto_issue": { "docs": "Issuer choice to issue to request in this credential exchange", @@ -5677,6 +5886,7 @@ }, "V20CredExRecordByFormat": { "docs": undefined, + "inline": undefined, "properties": { "cred_issue": { "type": "optional", @@ -5697,6 +5907,7 @@ }, "V20CredExRecordByFormatCredIssue": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -5704,6 +5915,7 @@ }, "V20CredExRecordByFormatCredOffer": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -5711,6 +5923,7 @@ }, "V20CredExRecordByFormatCredProposal": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -5718,6 +5931,7 @@ }, "V20CredExRecordByFormatCredRequest": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -5745,6 +5959,7 @@ }, "V20CredExRecordDetail": { "docs": undefined, + "inline": undefined, "properties": { "cred_ex_record": { "type": "optional", @@ -5766,6 +5981,7 @@ }, "V20CredExRecordIndy": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Time of record creation", @@ -5834,6 +6050,7 @@ }, "V20CredExRecordIndyCredRequestMetadata": { "docs": "Credential request metadata for indy holder", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -5851,6 +6068,7 @@ }, "V20CredExRecordLdProof": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Time of record creation", @@ -5895,6 +6113,7 @@ }, "V20CredExRecordListResult": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "Credential exchange records and corresponding detail records", @@ -5964,6 +6183,7 @@ }, "V20CredFilter": { "docs": undefined, + "inline": undefined, "properties": { "indy": { "type": "optional", @@ -5978,6 +6198,7 @@ }, "V20CredFilterIndy": { "docs": undefined, + "inline": undefined, "properties": { "cred_def_id": { "docs": "Credential definition identifier", @@ -6044,6 +6265,7 @@ }, "V20CredFormat": { "docs": undefined, + "inline": undefined, "properties": { "attach_id": { "docs": "Attachment identifier", @@ -6060,6 +6282,7 @@ }, "V20CredIssue": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -6092,6 +6315,7 @@ }, "V20CredOffer": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -6127,6 +6351,7 @@ }, "V20CredPreview": { "docs": undefined, + "inline": undefined, "properties": { "@type": { "docs": "Message type identifier", @@ -6140,6 +6365,7 @@ }, "V20CredProposal": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -6175,6 +6401,7 @@ }, "V20CredRequest": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -6207,6 +6434,7 @@ }, "V20DiscoveryExchangeListResult": { "docs": undefined, + "inline": undefined, "properties": { "results": { "type": "optional>", @@ -6222,6 +6450,7 @@ }, "V20DiscoveryExchangeResult": { "docs": undefined, + "inline": undefined, "properties": { "results": { "type": "optional", @@ -6233,6 +6462,7 @@ }, "V20DiscoveryRecord": { "docs": undefined, + "inline": undefined, "properties": { "connection_id": { "docs": "Connection identifier", @@ -6296,6 +6526,7 @@ "V20IssueCredentialModuleResponse": "map", "V20Pres": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -6323,6 +6554,7 @@ }, "V20PresExRecord": { "docs": undefined, + "inline": undefined, "properties": { "auto_present": { "docs": "Prover choice to auto-present proof as verifier requests", @@ -6410,6 +6642,7 @@ }, "V20PresExRecordByFormat": { "docs": undefined, + "inline": undefined, "properties": { "pres": { "type": "optional", @@ -6427,6 +6660,7 @@ }, "V20PresExRecordByFormatPresProposal": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -6434,6 +6668,7 @@ }, "V20PresExRecordByFormatPresRequest": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -6451,6 +6686,7 @@ }, "V20PresExRecordList": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "Presentation exchange records", @@ -6530,6 +6766,7 @@ }, "V20PresFormat": { "docs": undefined, + "inline": undefined, "properties": { "attach_id": { "docs": "Attachment identifier", @@ -6546,6 +6783,7 @@ }, "V20PresProposal": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -6573,6 +6811,7 @@ }, "V20PresProposalByFormat": { "docs": undefined, + "inline": undefined, "properties": { "dif": { "type": "optional", @@ -6595,6 +6834,7 @@ }, "V20PresRequest": { "docs": undefined, + "inline": undefined, "properties": { "@id": { "docs": "Message identifier", @@ -6626,6 +6866,7 @@ }, "V20PresRequestByFormat": { "docs": undefined, + "inline": undefined, "properties": { "dif": { "type": "optional", @@ -6657,6 +6898,7 @@ "V20PresentProofModuleResponse": "map", "VCRecord": { "docs": undefined, + "inline": undefined, "properties": { "contexts": { "type": "optional>", @@ -6699,6 +6941,7 @@ }, "VCRecordList": { "docs": undefined, + "inline": undefined, "properties": { "results": { "type": "optional>", @@ -6710,6 +6953,7 @@ }, "VcRecordCredValue": { "docs": "(JSON-serializable) credential value", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -6721,6 +6965,7 @@ }, "VerifyResponse": { "docs": undefined, + "inline": undefined, "properties": { "error": { "docs": "Error text", @@ -6734,6 +6979,7 @@ }, "WalletList": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "List of wallet records", @@ -6747,6 +6993,7 @@ "WalletModuleResponse": "map", "WalletRecord": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Time of record creation", @@ -6801,6 +7048,7 @@ }, "WalletRecordSettings": { "docs": "Settings for this wallet.", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -6808,6 +7056,7 @@ }, "WriteLedgerRequest": { "docs": undefined, + "inline": undefined, "properties": { "ledger_id": { "type": "optional", @@ -6839,6 +7088,7 @@ }, "jwt": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -6846,6 +7096,7 @@ }, "ldp": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -6853,6 +7104,7 @@ }, "metadata": { "docs": "Metadata dictionary", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -6870,6 +7122,7 @@ }, "pres": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -6887,6 +7140,7 @@ }, "signature": { "docs": "Credential signature", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -6894,6 +7148,7 @@ }, "witness": { "docs": "Witness for revocation proof", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -6978,6 +7233,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true AdminConfig: properties: config: @@ -6999,11 +7255,13 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true AdminStatusTiming: docs: Timing results properties: {} source: openapi: ../openapi.yml + inline: true AdminStatus: properties: conductor: @@ -7159,26 +7417,32 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true ClaimFormatJwtVc: properties: {} source: openapi: ../openapi.yml + inline: true ClaimFormatJwtVp: properties: {} source: openapi: ../openapi.yml + inline: true ldp: properties: {} source: openapi: ../openapi.yml + inline: true ClaimFormatLdpVc: properties: {} source: openapi: ../openapi.yml + inline: true ClaimFormatLdpVp: properties: {} source: openapi: ../openapi.yml + inline: true ClaimFormat: properties: jwt: @@ -7361,6 +7625,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true ConnectionMetadata: properties: results: @@ -7465,6 +7730,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true CreateWalletResponse: properties: created_at: @@ -7585,6 +7851,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true CredRevIndyRecordsResult: properties: rev_reg_delta: @@ -7929,6 +8196,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true DifPresSpecRevealDoc: docs: >- reveal doc [JSON-LD frame] dict used to derive the credential when @@ -7936,6 +8204,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true DIFPresSpec: properties: issuer_id: @@ -8004,6 +8273,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true Doc: properties: credential: @@ -8214,11 +8484,13 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true IndyCredRequestBlindedMsCorrectnessProof: docs: Blinded master secret correctness proof properties: {} source: openapi: ../openapi.yml + inline: true IndyCredRequest: properties: blinded_ms: @@ -8251,21 +8523,25 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true signature: docs: Credential signature properties: {} source: openapi: ../openapi.yml + inline: true IndyCredentialSignatureCorrectnessProof: docs: Credential signature correctness proof properties: {} source: openapi: ../openapi.yml + inline: true witness: docs: Witness for revocation proof properties: {} source: openapi: ../openapi.yml + inline: true IndyCredential: properties: cred_def_id: @@ -8690,11 +8966,13 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true IndyProofRequestedProofUnrevealedAttrs: docs: Unrevealed attributes properties: {} source: openapi: ../openapi.yml + inline: true IndyProofRequestedProof: properties: predicates: @@ -8871,6 +9149,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true InputDescriptors: properties: constraints: @@ -9105,6 +9384,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true KeylistQuery: properties: '@id': @@ -9642,11 +9922,13 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true ResolutionResultMetadata: docs: Resolution metadata properties: {} source: openapi: ../openapi.yml + inline: true ResolutionResult: properties: did_document: @@ -9677,16 +9959,19 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true RevRegWalletUpdatedResultAccumFixed: docs: Applied ledger transaction to fix revocations properties: {} source: openapi: ../openapi.yml + inline: true RevRegWalletUpdatedResultRevRegDelta: docs: Indy revocation registry delta properties: {} source: openapi: ../openapi.yml + inline: true RevRegWalletUpdatedResult: properties: accum_calculated: @@ -9829,6 +10114,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true SignResponse: properties: error: @@ -9971,22 +10257,27 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true TransactionRecordMetaData: properties: {} source: openapi: ../openapi.yml + inline: true TransactionRecordSignatureRequestItem: properties: {} source: openapi: ../openapi.yml + inline: true TransactionRecordSignatureResponseItem: properties: {} source: openapi: ../openapi.yml + inline: true TransactionRecordTiming: properties: {} source: openapi: ../openapi.yml + inline: true TransactionRecord: properties: _type: @@ -10084,6 +10375,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true V10CredentialExchangeInitiator: enum: - self @@ -10477,18 +10769,22 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true V20CredExRecordByFormatCredOffer: properties: {} source: openapi: ../openapi.yml + inline: true V20CredExRecordByFormatCredProposal: properties: {} source: openapi: ../openapi.yml + inline: true V20CredExRecordByFormatCredRequest: properties: {} source: openapi: ../openapi.yml + inline: true V20CredExRecordByFormat: properties: cred_issue: @@ -10516,6 +10812,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true V20CredExRecordIndy: properties: created_at: @@ -10922,14 +11219,17 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true V20PresExRecordByFormatPresProposal: properties: {} source: openapi: ../openapi.yml + inline: true V20PresExRecordByFormatPresRequest: properties: {} source: openapi: ../openapi.yml + inline: true V20PresExRecordByFormat: properties: pres: @@ -11018,6 +11318,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true VCRecord: properties: contexts: @@ -11080,6 +11381,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true WalletRecord: properties: created_at: @@ -12737,6 +13039,7 @@ docs: Simple messaging "types": { "ConnectionMetadataSetRequestMetadata": { "docs": "Dictionary of metadata to set for connection.", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -12744,6 +13047,7 @@ docs: Simple messaging }, "CreateInvitationRequestMetadata": { "docs": "Optional metadata to attach to the connection created with the invitation", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -12828,11 +13132,13 @@ docs: Simple messaging properties: {} source: openapi: ../openapi.yml + inline: true ConnectionMetadataSetRequestMetadata: docs: Dictionary of metadata to set for connection. properties: {} source: openapi: ../openapi.yml + inline: true imports: root: __package__.yml service: @@ -29200,6 +29506,7 @@ docs: Interaction with ledger }, "KeylistQueryFilterRequestFilter": { "docs": "Filter for keylist query", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -29741,6 +30048,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true GetMatchingMediationRecordsRequestState: enum: - request @@ -30888,6 +31196,7 @@ docs: Multitenant wallet management "types": { "InvitationCreateRequestMetadata": { "docs": "Optional metadata to attach to the connection created with the invitation", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -30903,6 +31212,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true service: auth: false base-path: '' diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/assembly.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/assembly.json index 873ec3fce50..08c5dad13a5 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/assembly.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/assembly.json @@ -100,6 +100,7 @@ }, "AutoHighlightResult": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of times the key phrase appears in the audio file", @@ -126,6 +127,7 @@ "docs": "An array of results for the Key Phrases model, if it was enabled during the transcription request. See [Key phrases](https://www.assemblyai.com/docs/Models/key_phrases) for more information. ", + "inline": undefined, "properties": { "results": { "docs": "A temporally-sequential array of Key Phrases", @@ -138,6 +140,7 @@ See [Key phrases](https://www.assemblyai.com/docs/Models/key_phrases) for more i }, "Chapter": { "docs": "Chapter of the audio file", + "inline": undefined, "properties": { "end": { "docs": "The starting time, in milliseconds, for the chapter", @@ -166,6 +169,7 @@ See [Key phrases](https://www.assemblyai.com/docs/Models/key_phrases) for more i }, "ContentSafetyLabel": { "docs": undefined, + "inline": undefined, "properties": { "confidence": { "docs": "The confidence score for the topic being discussed, from 0 to 1", @@ -200,6 +204,7 @@ See [Key phrases](https://www.assemblyai.com/docs/Models/key_phrases) for more i }, "ContentSafetyLabelResult": { "docs": undefined, + "inline": undefined, "properties": { "labels": { "docs": "An array of objects, one per sensitive topic that was detected in the section", @@ -236,6 +241,7 @@ See [Key phrases](https://www.assemblyai.com/docs/Models/key_phrases) for more i }, "CreateTranscriptOptionalParameters": { "docs": "The parameters for creating a transcript", + "inline": undefined, "properties": { "audio_end_at": { "docs": "The point in time, in milliseconds, to stop transcribing in your media file", @@ -385,6 +391,7 @@ Valid values are in the range [0, 1] inclusive. }, "Entity": { "docs": "A detected entity", + "inline": undefined, "properties": { "end": { "docs": "The ending time, in milliseconds, for the detected entity in the audio file", @@ -536,6 +543,7 @@ Valid values are in the range [0, 1] inclusive. }, "Error": { "docs": undefined, + "inline": undefined, "properties": { "error": { "docs": "Error message", @@ -553,6 +561,7 @@ Valid values are in the range [0, 1] inclusive. "extends": [ "LemurBaseResponse", ], + "inline": undefined, "properties": { "response": { "docs": "The response generated by LeMUR.", @@ -565,6 +574,7 @@ Valid values are in the range [0, 1] inclusive. }, "LemurBaseParameters": { "docs": undefined, + "inline": undefined, "properties": { "context": { "docs": "Context to provide the model. This can be a string or a free-form JSON value.", @@ -595,6 +605,7 @@ Can be any value between 0.0 and 1.0 inclusive. "discriminated": false, "docs": "Context to provide the model. This can be a string or a free-form JSON value.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -605,6 +616,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "LemurBaseResponse": { "docs": undefined, + "inline": undefined, "properties": { "request_id": { "docs": "The ID of the LeMUR request", @@ -628,6 +640,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "LemurQuestion": { "docs": undefined, + "inline": undefined, "properties": { "answer_format": { "docs": "How you want the answer to be returned. This can be any text. Can't be used with answer_options. Examples: "short sentence", "bullet points" @@ -654,6 +667,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "LemurQuestionAnswer": { "docs": "An answer generated by LeMUR and its question.", + "inline": undefined, "properties": { "answer": { "docs": "The answer generated by LeMUR.", @@ -673,6 +687,7 @@ Can be any value between 0.0 and 1.0 inclusive. "extends": [ "LemurBaseResponse", ], + "inline": undefined, "properties": { "response": { "docs": "The answers generated by LeMUR and their questions.", @@ -687,6 +702,7 @@ Can be any value between 0.0 and 1.0 inclusive. "discriminated": false, "docs": "Any context about the transcripts you wish to provide. This can be a string, or free-form JSON.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -700,6 +716,7 @@ Can be any value between 0.0 and 1.0 inclusive. "extends": [ "LemurBaseResponse", ], + "inline": undefined, "properties": { "response": { "docs": "The response generated by LeMUR.", @@ -715,6 +732,7 @@ Can be any value between 0.0 and 1.0 inclusive. "extends": [ "LemurBaseResponse", ], + "inline": undefined, "properties": { "response": { "docs": "The response generated by LeMUR.", @@ -727,6 +745,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "PageDetails": { "docs": undefined, + "inline": undefined, "properties": { "current_url": "string", "limit": "integer", @@ -740,6 +759,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "ParagraphsResponse": { "docs": undefined, + "inline": undefined, "properties": { "audio_duration": "double", "confidence": { @@ -795,6 +815,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "PurgeLemurRequestDataResponse": { "docs": undefined, + "inline": undefined, "properties": { "deleted": { "docs": "Whether the request data was deleted.", @@ -815,6 +836,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "RealtimeTemporaryTokenResponse": { "docs": undefined, + "inline": undefined, "properties": { "token": { "docs": "The temporary authentication token for real-time transcription", @@ -827,6 +849,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "RedactedAudioResponse": { "docs": undefined, + "inline": undefined, "properties": { "redacted_audio_url": { "docs": "The URL of the redacted audio file", @@ -847,6 +870,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "SentencesResponse": { "docs": undefined, + "inline": undefined, "properties": { "audio_duration": "double", "confidence": { @@ -878,6 +902,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "SentimentAnalysisResult": { "docs": "The result of the sentiment analysis model.", + "inline": undefined, "properties": { "confidence": { "docs": "The confidence score for the detected sentiment of the sentence, from 0 to 1", @@ -917,6 +942,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "SeverityScoreSummary": { "docs": undefined, + "inline": undefined, "properties": { "high": { "type": "double", @@ -1001,6 +1027,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "Timestamp": { "docs": "Timestamp containing a start and end property in milliseconds.", + "inline": undefined, "properties": { "end": { "docs": "The end time in milliseconds", @@ -1017,6 +1044,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "TopicDetectionResult": { "docs": "THe result of the topic detection model.", + "inline": undefined, "properties": { "labels": "optional>", "text": { @@ -1031,6 +1059,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "TopicDetectionResultLabelsItem": { "docs": undefined, + "inline": true, "properties": { "label": { "docs": "The IAB taxonomical label for the label of the detected topic, where > denotes supertopic/subtopic relationship", @@ -1054,6 +1083,7 @@ Can be any value between 0.0 and 1.0 inclusive. }, "Transcript": { "docs": "A transcript object", + "inline": undefined, "properties": { "acoustic_model": { "availability": "deprecated", @@ -1332,6 +1362,7 @@ See [Speech recognition](https://www.assemblyai.com/docs/Models/speech_recogniti "docs": "An array of results for the Content Moderation model, if it was enabled during the transcription request. See [Content moderation](https://www.assemblyai.com/docs/Models/content_moderation) for more information. ", + "inline": true, "properties": { "results": "list", "status": { @@ -1345,6 +1376,7 @@ See [Content moderation](https://www.assemblyai.com/docs/Models/content_moderati }, "TranscriptCustomSpelling": { "docs": "Object containing words or phrases to replace, and the word or phrase to replace with", + "inline": undefined, "properties": { "from": { "docs": "Words or phrases to replace", @@ -1363,6 +1395,7 @@ See [Content moderation](https://www.assemblyai.com/docs/Models/content_moderati "docs": "An array of results for the Topic Detection model, if it was enabled during the transcription request. See [Topic Detection](https://www.assemblyai.com/docs/Models/iab_classification) for more information. ", + "inline": true, "properties": { "results": { "docs": "An array of results for the Topic Detection model.", @@ -1414,6 +1447,7 @@ The default value is 'en_us'. }, "TranscriptList": { "docs": undefined, + "inline": undefined, "properties": { "page_details": "PageDetails", "transcripts": "list", @@ -1424,6 +1458,7 @@ The default value is 'en_us'. }, "TranscriptListItem": { "docs": undefined, + "inline": undefined, "properties": { "audio_url": "string", "completed": "optional", @@ -1438,6 +1473,7 @@ The default value is 'en_us'. }, "TranscriptListParameters": { "docs": undefined, + "inline": undefined, "properties": { "after_id": { "docs": "Get transcripts that were created after this transcript ID", @@ -1477,6 +1513,7 @@ The default value is 'en_us'. }, "TranscriptParagraph": { "docs": undefined, + "inline": undefined, "properties": { "confidence": { "type": "double", @@ -1499,6 +1536,7 @@ The default value is 'en_us'. }, "TranscriptSentence": { "docs": undefined, + "inline": undefined, "properties": { "confidence": { "type": "double", @@ -1545,6 +1583,7 @@ The default value is 'en_us'. }, "TranscriptUtterance": { "docs": undefined, + "inline": undefined, "properties": { "channel": "string", "confidence": { @@ -1568,6 +1607,7 @@ The default value is 'en_us'. }, "TranscriptWord": { "docs": undefined, + "inline": undefined, "properties": { "confidence": { "type": "double", @@ -1590,6 +1630,7 @@ The default value is 'en_us'. }, "UploadedFile": { "docs": undefined, + "inline": undefined, "properties": { "upload_url": { "docs": "A URL that points to your audio file, accessible only by AssemblyAI's servers", @@ -1602,6 +1643,7 @@ The default value is 'en_us'. }, "WordSearchMatch": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total amount of times the word is in the transcript", @@ -1626,6 +1668,7 @@ The default value is 'en_us'. }, "WordSearchResponse": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the transcript", @@ -2107,6 +2150,7 @@ types: results: list source: openapi: ../openapi.yml + inline: true TranscriptIabCategoriesResult: docs: > An array of results for the Topic Detection model, if it was enabled @@ -2129,6 +2173,7 @@ types: docs: The overall relevance of topic to the entire audio file source: openapi: ../openapi.yml + inline: true Transcript: docs: A transcript object properties: @@ -2637,6 +2682,7 @@ types: denotes supertopic/subtopic relationship source: openapi: ../openapi.yml + inline: true TopicDetectionResult: docs: THe result of the topic detection model. properties: @@ -2962,6 +3008,7 @@ types: - map source: openapi: ../openapi.yml + inline: true LemurBaseParameters: properties: transcript_ids: @@ -2999,6 +3046,7 @@ types: - map source: openapi: ../openapi.yml + inline: true LemurQuestion: properties: question: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/availability.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/availability.json index c64a46f497d..e7f1fccca1e 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/availability.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/availability.json @@ -261,6 +261,7 @@ "DeprecatedParam": "string", "NotDeprecatedSettings": { "docs": undefined, + "inline": undefined, "properties": { "not_deprecated_setting": "optional", }, @@ -271,6 +272,7 @@ "WholeDeprecatedSettings": { "availability": "deprecated", "docs": undefined, + "inline": undefined, "properties": { "fine_setting": "optional", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/axle.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/axle.json index e30fe4b42d1..c894a317c7d 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/axle.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/axle.json @@ -8,6 +8,7 @@ "types": { "Address": { "docs": undefined, + "inline": undefined, "properties": { "addressLine1": { "type": "optional", @@ -34,6 +35,7 @@ }, "Carrier": { "docs": undefined, + "inline": undefined, "properties": { "address": { "type": "Address", @@ -53,6 +55,7 @@ }, "Coverage": { "docs": undefined, + "inline": undefined, "properties": { "code": "CoverageCode", "deductible": { @@ -90,6 +93,7 @@ }, "Error": { "docs": undefined, + "inline": undefined, "properties": { "message": { "docs": "Provides a reason for why the operation failed, if available.", @@ -105,6 +109,7 @@ }, "Insured": { "docs": undefined, + "inline": undefined, "properties": { "dateOfBirth": { "type": "optional", @@ -136,6 +141,7 @@ }, "Property": { "docs": undefined, + "inline": undefined, "properties": { "data": { "type": "Vehicle", @@ -153,6 +159,7 @@ }, "ThirdParty": { "docs": undefined, + "inline": undefined, "properties": { "address": { "type": "optional
", @@ -183,6 +190,7 @@ }, "User": { "docs": "User to attach to Ignition session. If user is set, unique `id` must be provided.", + "inline": undefined, "properties": { "email": { "docs": "User's email address.", @@ -211,6 +219,7 @@ }, "Vehicle": { "docs": undefined, + "inline": undefined, "properties": { "bodyStyle": { "type": "optional", @@ -451,6 +460,7 @@ "types": { "Account": { "docs": "An Account represents an account with an insurance carrier and includes high-level account information (e.g. name) and any Policy objects associated with the Account.", + "inline": undefined, "properties": { "carrier": "string", "createdAt": "string", @@ -473,6 +483,7 @@ }, "GetAccountResponse": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional", "success": "optional", @@ -483,6 +494,7 @@ }, "Policy": { "docs": "A Policy represents a specific policy associated with an Account and includes high-level policy information (e.g. policy number) and any children objects (e.g., coverages) associated with the policy.", + "inline": undefined, "properties": { "account": "string", "address": { @@ -758,6 +770,7 @@ service: "types": { "GetCarrierResponse": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional", "success": "optional", @@ -768,6 +781,7 @@ service: }, "GetCarriersResponse": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional>", "success": "optional", @@ -940,6 +954,7 @@ service: "types": { "StartIgnitionResponse": { "docs": "", + "inline": undefined, "properties": { "data": "StartIgnitionResponseData", "success": { @@ -952,6 +967,7 @@ service: }, "StartIgnitionResponseData": { "docs": undefined, + "inline": true, "properties": { "ignitionToken": { "docs": "The unique ID for the ignition session.", @@ -981,6 +997,7 @@ types: docs: The unique ID for the ignition session. source: openapi: ../openapi.yml + inline: true StartIgnitionResponse: docs: '' properties: @@ -1170,6 +1187,7 @@ service: "types": { "GetPolicyResponse": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional", "success": "optional", @@ -1355,6 +1373,7 @@ Auth codes are ephemeral and expire after 10 minutes, while accessTokens do not "types": { "ExchangeTokenResponse": { "docs": "", + "inline": undefined, "properties": { "data": "ExchangeTokenResponseData", "success": { @@ -1367,6 +1386,7 @@ Auth codes are ephemeral and expire after 10 minutes, while accessTokens do not }, "ExchangeTokenResponseData": { "docs": undefined, + "inline": true, "properties": { "accessToken": { "docs": "The token required for access to the requested Account and Policy objects.", @@ -1408,6 +1428,7 @@ types: type: list source: openapi: ../openapi.yml + inline: true ExchangeTokenResponse: docs: '' properties: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/belvo.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/belvo.json index 2654a04520c..0d85935ecd3 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/belvo.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/belvo.json @@ -139,6 +139,7 @@ "types": { "AccessToResourceDenied": { "docs": "This error occurs when you try to access Belvo's resource without the correct permissions.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`access_to_resource_denied`) that allows you to classify and handle the error programmatically. @@ -174,6 +175,7 @@ For `access_to_resource_denied` errors, the description is: **Note**: For our recurring expenses resource, this account relates to the account that was analyzed to generate the recurring expenses report. ", + "inline": undefined, "properties": { "balance": "AccountsBalance", "balance_type": { @@ -276,6 +278,7 @@ For example: `0444/45722-0`. "AccountsBalance": { "docs": "Details regarding the current and available balances for the account. ", + "inline": undefined, "properties": { "available": { "docs": "The balance that the account owner can use. @@ -313,6 +316,7 @@ The amount remaining to pay on the users's loan (same as `loan_data.outstanding_ }, "AccountsCreditData": { "docs": "The credit options associated with this account.", + "inline": undefined, "properties": { "collected_at": { "docs": "The ISO-8601 timestamp when the data point was collected.", @@ -372,6 +376,7 @@ The amount remaining to pay on the users's loan (same as `loan_data.outstanding_ }, "AccountsFundsData": { "docs": undefined, + "inline": undefined, "properties": { "balance": { "docs": "The amount in the fund.", @@ -404,6 +409,7 @@ The amount remaining to pay on the users's loan (same as `loan_data.outstanding_ }, "AccountsFundsDataPublicIdentifications": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "The type of identification number for the fund.", @@ -420,6 +426,7 @@ The amount remaining to pay on the users's loan (same as `loan_data.outstanding_ }, "AccountsLoanData": { "docs": "The loan options associated with this account.", + "inline": undefined, "properties": { "collected_at": { "docs": "The ISO-8601 timestamp when the data point was collected.", @@ -565,6 +572,7 @@ The minimum amount required to pay to avoid generating interest. }, "AccountsLoanDataFees": { "docs": "Breakdown of the fees applied to the loan.", + "inline": undefined, "properties": { "type": "EnumLoanDataFeeType", "value": { @@ -579,6 +587,7 @@ The minimum amount required to pay to avoid generating interest. }, "AccountsLoanDataInterestRate": { "docs": "Breakdown of the interest applied to the loan.", + "inline": undefined, "properties": { "name": { "docs": "The name of the type of interest rate applied to the loan.", @@ -596,6 +605,7 @@ The minimum amount required to pay to avoid generating interest. }, "AccountsPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -623,6 +633,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "AccountsReceivablesData": { "docs": "Additional details regarding the receivables account, if applicable.", + "inline": undefined, "properties": { "anticipated": { "docs": "The amount that the owner of the account received earlier than contracted.", @@ -647,6 +658,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "AnnualCostsAndDeductionsStatementBusiness": { "docs": "Object containing the reported annual costs and applicable deductions.", + "inline": undefined, "properties": { "administration_expenses": { "docs": "Total costs of the company related to training, company offsites, or similar.", @@ -675,6 +687,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "AnnualIncomeStatementBusiness": { "docs": "Object containing the reported annual incomes, deductions, and final balances of the tax payer.", + "inline": undefined, "properties": { "dividends": { "docs": "Total income that the company generated from dividends.", @@ -707,6 +720,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "AnnualIncomeStatementIndividual": { "docs": "Object containing the reported annual incomes, deductions, and final balances of the tax payer.", + "inline": undefined, "properties": { "annual_totals": "AnnualTotalsIndividual", "gross_income": "GrossIncomeIndividual", @@ -719,6 +733,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "AnnualTotalsIndividual": { "docs": "Object containing the tax payers total exempt, deducted, and ordinary net incomes.", + "inline": undefined, "properties": { "total_applicable_deductions": { "docs": "Total deductions that the taxpayer can apply to their income, according to the institution.", @@ -743,6 +758,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "AsynchronousAccepted202": { "docs": undefined, + "inline": undefined, "properties": { "request_id": { "docs": "The unique ID for this request. We recommend you store this value to later identify which webhook event relates to an asynchronous request.", @@ -755,6 +771,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "BUSINESS": { "docs": "Details about the OFPI payment method.", + "inline": undefined, "properties": { "open_finance": "PaymentIntentPaymentMethodDetailsBodyBusinessOfpi", }, @@ -766,6 +783,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -807,6 +825,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "Balance": { "docs": undefined, + "inline": undefined, "properties": { "account": "optional", "balance": { @@ -862,6 +881,7 @@ The ISO-8601 timestamp when the data point was collected. }, "BalancesPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -889,6 +909,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "BankAccountBusinessPse": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "The ISO-8601 timestamp of when the data point was first created in Belvo's database.", @@ -961,6 +982,7 @@ For `BUSINESS` bank accounts that Belvo creates for organizations, this field is }, "BankAccountDetailsOfpi": { "docs": undefined, + "inline": undefined, "properties": { "account_type": "EnumBankAccountPixAccountTypeOfpi", "agency": { @@ -979,6 +1001,7 @@ For `BUSINESS` bank accounts that Belvo creates for organizations, this field is }, "BankAccountDetailsOfpiPix": { "docs": undefined, + "inline": undefined, "properties": { "country": "EnumPaymentsCountry", "pix_key": { @@ -992,6 +1015,7 @@ For `BUSINESS` bank accounts that Belvo creates for organizations, this field is }, "BankAccountDetailsOpenFinance": { "docs": undefined, + "inline": undefined, "properties": { "account_type": "EnumBankAccountPixAccountTypeOfpi", "agency": { @@ -1010,6 +1034,7 @@ For `BUSINESS` bank accounts that Belvo creates for organizations, this field is }, "BankAccountDetailsOpenFinancePix": { "docs": undefined, + "inline": undefined, "properties": { "country": "EnumPaymentsCountry", "pix_key": { @@ -1025,6 +1050,7 @@ For `BUSINESS` bank accounts that Belvo creates for organizations, this field is "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1039,6 +1065,7 @@ For `BUSINESS` bank accounts that Belvo creates for organizations, this field is }, "BankAccountInformationContentPse": { "docs": "Information about the payer's institution", + "inline": undefined, "properties": { "payer_institution": { "docs": "Belvo's unique identifier for the payer’s institution.", @@ -1057,6 +1084,7 @@ For `BUSINESS` bank accounts that Belvo creates for organizations, this field is }, "BankAccountInformationPse": { "docs": "Information about the payer's bank account. Belvo returns this object when the payer's bank account information is not saved in the Belvo database.", + "inline": undefined, "properties": { "bank_account_information": { "type": "optional", @@ -1068,6 +1096,7 @@ For `BUSINESS` bank accounts that Belvo creates for organizations, this field is }, "BankAccountOfpiResponse": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database.", @@ -1128,6 +1157,7 @@ For `BUSINESS` bank accounts that Belvo creates for organizations, this field is "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1142,6 +1172,7 @@ For `BUSINESS` bank accounts that Belvo creates for organizations, this field is }, "BankAccountPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -1171,6 +1202,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1186,6 +1218,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "BeneficiaryBankAccountOfpi": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "The ISO-8601 timestamp of when the data point was last updated in Belvo's database.", @@ -1227,6 +1260,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1241,6 +1275,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "BeneficiaryBankAccountPse": { "docs": undefined, + "inline": undefined, "properties": { "holder": { "type": "optional", @@ -1276,6 +1311,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "Business": { "docs": "Details regarding the business bank account holder.", + "inline": undefined, "properties": { "Information": { "type": "optional", @@ -1288,6 +1324,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "Categorization": { "docs": undefined, + "inline": undefined, "properties": { "transactions": { "docs": "An array of enriched transaction objects.", @@ -1300,6 +1337,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "CategorizationBody": { "docs": undefined, + "inline": undefined, "properties": { "account_category": "EnumCategorizationAccountCategory", "account_holder_id": { @@ -1361,6 +1399,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "CategorizationBodyRequest": { "docs": undefined, + "inline": undefined, "properties": { "account_category": "EnumCategorizationAccountCategory", "account_holder_id": { @@ -1417,6 +1456,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "CategorizationMerchantData": { "docs": "Additional data regarding the merchant involved in the transaction. ", + "inline": undefined, "properties": { "logo": { "docs": "The URL to the merchant's logo.", @@ -1437,6 +1477,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "Charge": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "The amount of the charge. @@ -1548,6 +1589,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1562,6 +1604,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "ChargePaymentMethodDetailsOfpiContent": { "docs": "Information about the payer of a PSE payment.", + "inline": undefined, "properties": { "beneficiary_bank_account": { "docs": "Belvo's unique ID used to identify the beneficiary's bank account.", @@ -1590,6 +1633,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "ChargePaymentMethodDetailsPseContent": { "docs": "Information about the payer of a PSE payment.", + "inline": undefined, "properties": { "payer_bank_account": { "docs": "Belvo's unique ID used to identify the customer’s bank account.", @@ -1630,6 +1674,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "CreateBankAccountOfpi": { "docs": undefined, + "inline": undefined, "properties": { "details": { "docs": "Information regarding the bank account.", @@ -1658,6 +1703,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "discriminated": false, "docs": "Information regarding the bank account.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1672,6 +1718,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "CreateBankAccountPse": { "docs": undefined, + "inline": undefined, "properties": { "holder": { "docs": "Information regarding the business bank account holder.", @@ -1699,6 +1746,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "CreateCustomerOfpi": { "docs": undefined, + "inline": undefined, "properties": { "address": { "docs": "The customer's physical address. @@ -1747,6 +1795,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "CreateCustomerPse": { "docs": undefined, + "inline": undefined, "properties": { "address": { "docs": "The customer's physical address. @@ -1795,6 +1844,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "CreatePaymentLinkOfpi": { "docs": undefined, + "inline": undefined, "properties": { "allowed_payment_method_types": { "docs": "A list of payment method types allowed in this payment intent. For OFPI, this value must be set to `open_finance`.", @@ -1853,6 +1903,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro **Note:** You can send through this value either as a string or an float. Regardless of the type you choose to send the `amount` as, Belvo returns a string with two decimal points, separated by a period ( `.`). For example, `1234.12`. ", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1871,6 +1922,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "CreatePaymentLinkPse": { "docs": undefined, + "inline": undefined, "properties": { "allowed_payment_method_types": { "docs": "A list of payment method types allowed in this payment intent. For PSE, this value must be set to `pse`.", @@ -1929,6 +1981,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro **Note:** You can send this value either as a string or an integer. Regardless of the type you choose to send the `amount` as, Belvo returns a string with two decimal points, separated by a period ( `.`). For example, `350000.00`. ", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1947,6 +2000,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "CustomerOfpi": { "docs": undefined, + "inline": undefined, "properties": { "address": { "docs": "The customers physical address. @@ -2019,6 +2073,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "CustomerPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -2048,6 +2103,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -2062,6 +2118,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "CustomerPse": { "docs": undefined, + "inline": undefined, "properties": { "address": { "docs": "The customers physical address. @@ -2140,6 +2197,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DisplayConfirmationRequiredContentPse": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "payer_institution": { "type": "optional", @@ -2151,6 +2209,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DisplayConfirmationRequiredOfpi": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "beneficiary_bank_account": { "type": "optional", @@ -2173,6 +2232,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DisplayCredentialsRequiredContentPse": { "docs": "Object containing form fields for the required credentials (for example, `username` or `password`) in this step.", + "inline": undefined, "properties": { "payer_institution": { "type": "optional", @@ -2184,6 +2244,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DisplayCustomerBankAccountsContentPse": { "docs": "Object detailing what payment method information you need to display.", + "inline": undefined, "properties": { "beneficiary_bank_account": { "type": "optional", @@ -2199,6 +2260,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DisplayPaymentFailed": { "docs": "Details regarding the payer institution.", + "inline": undefined, "properties": { "payer_institution": "optional", }, @@ -2208,6 +2270,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DisplayPaymentMethodInformationContentOfpi": { "docs": "Object detailing what payment method information you need to display.", + "inline": undefined, "properties": { "institutions": { "docs": "An array of institution objects.", @@ -2220,6 +2283,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DisplayPaymentMethodInformationContentPse": { "docs": "Object detailing what payment method information you need to display.", + "inline": undefined, "properties": { "customer_bank_accounts": { "docs": "Array of bank account objects. @@ -2238,6 +2302,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DisplayPaymentProcessing": { "docs": "Details regarding the payer institution.", + "inline": undefined, "properties": { "payer_institution": "optional", }, @@ -2247,6 +2312,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DisplayPaymentSucceeded": { "docs": "Details regarding the payer institution.", + "inline": undefined, "properties": { "payer_institution": "optional", }, @@ -2256,6 +2322,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DisplayTokenRequiredContentPse": { "docs": undefined, + "inline": undefined, "properties": { "payer_institution": "optional", }, @@ -2265,6 +2332,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DocumentIdBusiness": { "docs": "Object containing information about the ID document of the tax payer.", + "inline": undefined, "properties": { "document_number": { "docs": "The number of the ID document.", @@ -2281,6 +2349,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DocumentIdIndividual": { "docs": "Object containing information about the ID document of the tax payer.", + "inline": undefined, "properties": { "document_number": { "docs": "The number of the ID document.", @@ -2297,6 +2366,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DocumentInformationBusiness": { "docs": "Object containing detailed information about the fiscal document.", + "inline": undefined, "properties": { "form_number": { "docs": "The institution-provided identifier for the tax declaration.", @@ -2322,6 +2392,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "DocumentInformationIndividual": { "docs": "Object containing detailed information about the fiscal document.", + "inline": undefined, "properties": { "form_number": { "docs": "Institution-provided identifier for the tax declaration.", @@ -2347,6 +2418,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "EmploymentRecord": { "docs": "Emploment record response payload", + "inline": undefined, "properties": { "collected_at": { "docs": "The ISO-8601 timestamp when the data point was collected.", @@ -2407,6 +2479,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "EmploymentRecordDetail": { "docs": "Details regarding the individual's employment history.", + "inline": undefined, "properties": { "collected_at": { "docs": "The ISO-8601 timestamp when the data point was collected.", @@ -2482,6 +2555,7 @@ For Mexico, this is the *daily* rate that the individual earned, including the p }, "EmploymentRecordDocumentId": { "docs": "Details regarding the individual's ID documents.", + "inline": undefined, "properties": { "document_number": { "docs": "The ID document's number (as a string). @@ -2496,6 +2570,7 @@ For Mexico, this is the *daily* rate that the individual earned, including the p }, "EmploymentRecordEmploymentStatusUpdates": { "docs": "Details regarding any employment changes of the individual.", + "inline": undefined, "properties": { "base_salary": { "docs": "The base salary of the individual, current as of the `update_date`. @@ -2521,6 +2596,7 @@ For Mexico, this is the *daily* rate that the individual earned, including the p }, "EmploymentRecordEntitlement": { "docs": "Details regarding the benefits the individual is entitled to.", + "inline": undefined, "properties": { "entitled_to_company_benefits": { "docs": "Indicates whether or not the individual is entitled to company benefits. @@ -2551,6 +2627,7 @@ For Mexico, this is the *daily* rate that the individual earned, including the p }, "EmploymentRecordFile": { "docs": "Additional PDF binary files relating to the individual's employment.", + "inline": undefined, "properties": { "type": { "docs": "The title of the document. @@ -2569,6 +2646,7 @@ For Mexico, this is the *daily* rate that the individual earned, including the p }, "EmploymentRecordPersonalData": { "docs": "Details regarding the personal information of the individual.", + "inline": undefined, "properties": { "birth_date": { "docs": "The date of the birth of the individual, in `YYYY-MM-DD` format. @@ -2613,6 +2691,7 @@ For Mexico, this is the *daily* rate that the individual earned, including the p }, "EmploymentRecordSocialSecuritySummary": { "docs": "Details regarding the individual's social security contributions.", + "inline": undefined, "properties": { "weeks_contributed": { "docs": "Number of weeks the individual has contributed to their social security, based on the number of weeks the individual has worked according to IMSS. @@ -2636,6 +2715,7 @@ For Mexico, this is the *daily* rate that the individual earned, including the p }, "EmploymentRecordsPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -3745,6 +3825,7 @@ We return one of the following enum values: }, "EquityStatementBusiness": { "docs": "Object containing the general fiscal situation of the taxpayer.", + "inline": undefined, "properties": { "accounts_documents_and_finance_leases_receivable": { "docs": "Total of all payments the company expects to receive (for example, from partial invoices that have not been paid yet).", @@ -3785,6 +3866,7 @@ We return one of the following enum values: }, "EquityStatementIndividual": { "docs": "Object containing the general fiscal situation of the taxpayer.", + "inline": undefined, "properties": { "total_debts": { "docs": "The total debts of the tax_payer", @@ -3805,6 +3887,7 @@ We return one of the following enum values: }, "EyodIncomeVerificationBodyRequest": { "docs": undefined, + "inline": undefined, "properties": { "account_category": "EnumIncomeVerificationAccountCategory", "account_holder_id": { @@ -3866,6 +3949,7 @@ We return one of the following enum values: }, "GrossIncomeIndividual": { "docs": "Object containing the declared gross income of the tax payer.", + "inline": undefined, "properties": { "capital_income": { "docs": "Income received from an investment (such as dividends or from renting a property).", @@ -3890,6 +3974,7 @@ We return one of the following enum values: }, "HolderBankAccountInformationPse": { "docs": "Object with additional information about the individual that holds the bank account.", + "inline": undefined, "properties": { "first_name": { "docs": "The account holder's first name.", @@ -3906,6 +3991,7 @@ We return one of the following enum values: }, "HolderBankAccountPse": { "docs": "Details regarding the bank account holder.", + "inline": undefined, "properties": { "information": "optional", "type": "optional", @@ -3918,6 +4004,7 @@ We return one of the following enum values: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3932,6 +4019,7 @@ We return one of the following enum values: }, "INDIVIDUAL": { "docs": "Details about the OFPI payment method.", + "inline": undefined, "properties": { "open_finance": "PaymentIntentPaymentMethodDetailsBodyIndividualOfpi", }, @@ -3941,6 +4029,7 @@ We return one of the following enum values: }, "Income": { "docs": "Income insights", + "inline": undefined, "properties": { "created_at": { "docs": "The ISO-8601 timestamp of when the data point was created in Belvo's database.", @@ -4071,6 +4160,7 @@ For each income stream, we provide additional insights such as: - Key metrics about the transaction amounts. ℹ️ If no income sources are found, we return an empty array. ", + "inline": undefined, "properties": { "account_id": { "docs": "Unique ID for the bank account to be verified for income streams.", @@ -4170,6 +4260,7 @@ For each income stream, we provide additional insights such as: }, "IncomesPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -4197,6 +4288,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "Institution": { "docs": undefined, + "inline": undefined, "properties": { "country_codes": { "docs": "The country codes where the institution is available, for example: @@ -4277,6 +4369,7 @@ Please see our [Institutions](https://developers.belvo.com/docs/institution) Dev }, "InstitutionAccount": { "docs": "Details regarding the institution.", + "inline": undefined, "properties": { "name": { "docs": "The name of the institution, as designated by Belvo. @@ -4291,6 +4384,7 @@ Please see our [Institutions](https://developers.belvo.com/docs/institution) Dev }, "InstitutionDownError": { "docs": "This error occurs when the institution's website that you're trying to access is down due to maintenance or other issues, which means Belvo is unable to create new links or retrieve new data.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`institution_down`) that allows you to classify and handle the error programmatically. @@ -4323,6 +4417,7 @@ For `institution_down` errors, the description is: }, "InstitutionFormField": { "docs": undefined, + "inline": undefined, "properties": { "label": { "docs": "The label of the form field. For example: @@ -4371,6 +4466,7 @@ For `institution_down` errors, the description is: }, "InstitutionInactiveError": { "docs": "This error occurs when we (Belvo) have deactivated the institution in our API.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`institution_inactive`) that allows you to classify and handle the error programmatically. @@ -4403,6 +4499,7 @@ For `institution_inactive` errors, the description is: }, "InstitutionUnavailableError": { "docs": "This error occurs when the institution's website that you're trying to access is down due to maintenance or other issues, which means Belvo is unable to create new links or retrieve new data.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`institution_unavailable`) that allows you to classify and handle the error programmatically. @@ -4435,6 +4532,7 @@ For `institution_unavailable` errors, the description is: }, "InstitutionsFeature": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "The description of the feature.", @@ -4451,6 +4549,7 @@ For `institution_unavailable` errors, the description is: }, "InstitutionsFormField": { "docs": undefined, + "inline": undefined, "properties": { "label": { "docs": "The label of the form field. For example: @@ -4491,6 +4590,7 @@ For `institution_unavailable` errors, the description is: }, "InstitutionsFormFieldValues": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "The code of the document.", @@ -4523,6 +4623,7 @@ For `institution_unavailable` errors, the description is: }, "InstitutionsPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -4550,6 +4651,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "InvalidAccessMode": { "docs": "This error occurs when you try to update a link from single to recurrent, but there are no login credentials stored for the user.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`invalid_access_mode_switch`) that allows you to classify and handle the error programmatically. @@ -4582,6 +4684,7 @@ For `invalid_access_mode_switch` errors, the description is: }, "InvalidLinkError": { "docs": "This error occurs when you try to access an account but the user credentials are no longer valid, prompting an error from the institution.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`invalid_link`) that allows you to classify and handle the error programmatically. @@ -4614,6 +4717,7 @@ For `invalid_link` errors, the description is: }, "InvalidPeriodError": { "docs": "This error occurs when you request incomes for a link within a given date range, however, the period between `date_from` and `date_to` is less than 90 days.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`invalid_period`) that allows you to classify and handle the error programmatically. @@ -4646,6 +4750,7 @@ For `invalid_period` errors, the description is: }, "InvestmentsPortfolio": { "docs": undefined, + "inline": undefined, "properties": { "balance_gross": { "docs": "The current gross total value of the entire portfolio and all its underlying instruments, as given by the institution. @@ -4704,6 +4809,7 @@ Please note that other currencies other than in the list above may be returned. }, "InvestmentsPortfolioInstrument": { "docs": undefined, + "inline": undefined, "properties": { "average_acquisition_price": { "docs": "The average price of each share acquired in the instrument.", @@ -4797,6 +4903,7 @@ For example, the due date, the liquidity date, the previdencia type, and so on. }, "InvestmentsPortfolioInstrumentFees": { "docs": undefined, + "inline": undefined, "properties": { "type": { "docs": "The fee type incurred when making the purchase of the instrument.", @@ -4813,6 +4920,7 @@ For example, the due date, the liquidity date, the previdencia type, and so on. }, "InvestmentsPortfolioInstrumentInterestRate": { "docs": undefined, + "inline": undefined, "properties": { "index": { "docs": "If applicable, the index type that the `interest_rates.value` is calculated against.", @@ -4837,6 +4945,7 @@ For example, the due date, the liquidity date, the previdencia type, and so on. }, "InvestmentsPortfolioInstrumentPublicId": { "docs": "The public identifiers for the instrument.", + "inline": undefined, "properties": { "type": { "docs": "The type of public identifier for the instrument.", @@ -4853,6 +4962,7 @@ For example, the due date, the liquidity date, the previdencia type, and so on. }, "InvestmentsPortfolioInstrumentRedemptionConditions": { "docs": undefined, + "inline": undefined, "properties": { "type": { "docs": "The name of the redemption condition.", @@ -4869,6 +4979,7 @@ For example, the due date, the liquidity date, the previdencia type, and so on. }, "InvestmentsPortfoliosPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -4896,6 +5007,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "InvoiceDetailDian": { "docs": undefined, + "inline": undefined, "properties": { "collected_at": { "docs": "The ISO-8601 timestamp when the data point was collected.", @@ -4955,6 +5067,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "InvoiceDetailRetainedTaxSat": { "docs": undefined, + "inline": undefined, "properties": { "collected_at": { "docs": "The ISO-8601 timestamp when the data point was collected.", @@ -4984,6 +5097,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "InvoiceDetailSat": { "docs": undefined, + "inline": undefined, "properties": { "collected_at": { "docs": "The ISO-8601 timestamp when the data point was collected.", @@ -5051,6 +5165,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "InvoiceDian": { "docs": undefined, + "inline": undefined, "properties": { "cancelation_status": { "docs": "**Note**: This field is not applicable for DIAN Colombia and will return `null`.", @@ -5275,6 +5390,7 @@ For detailed information regarding DIAN's payment types, please see their [offic "InvoiceSenderDetailsDian": { "docs": "Details regarding the sender. ", + "inline": undefined, "properties": { "address": { "docs": "The sender's address. @@ -5330,6 +5446,7 @@ For detailed information regarding DIAN's tax schemes, please see their [officia "InvoiceWarningsDian": { "docs": "**Note**: This field is not applicable for DIAN Colombia and will return `null`. ", + "inline": undefined, "properties": { "code": { "docs": "**Note**: This field is not applicable for DIAN Colombia and will return `null`. @@ -5349,6 +5466,7 @@ For detailed information regarding DIAN's tax schemes, please see their [officia "InvoiceWarningsSat": { "docs": "Object containing information about any warnings related to this invoice. ", + "inline": undefined, "properties": { "code": { "docs": "The warning code. @@ -5367,6 +5485,7 @@ For detailed information regarding DIAN's tax schemes, please see their [officia }, "InvoiceWithIdSat": { "docs": undefined, + "inline": undefined, "properties": { "cancelation_status": { "docs": "If the invoice is cancelled, this field indicates the status of the cancellation.", @@ -5591,6 +5710,7 @@ Possible statuses are: }, "InvoicesPaymentsDian": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "**Note**: This field is not applicable for DIAN Colombia and will return `null`. @@ -5659,6 +5779,7 @@ Possible statuses are: }, "InvoicesPaymentsRelatedDocumentsDian": { "docs": "List of all the related deferred invoices affected by the payment.", + "inline": undefined, "properties": { "amount_paid": { "docs": "**Note**: This field is not applicable for DIAN Colombia and will return `null`. @@ -5702,6 +5823,7 @@ Possible statuses are: }, "InvoicesPaymentsRelatedDocumentsSat": { "docs": "List of all the related deferred invoices affected by the payment.", + "inline": undefined, "properties": { "amount_paid": { "docs": "The amount paid in this installment. @@ -5751,6 +5873,7 @@ Possible statuses are: }, "InvoicesPaymentsSat": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "The invoice amount, in the currency of the original invoice. @@ -5828,6 +5951,7 @@ Please note that other currencies other than in the list above may be returned. "InvoicesPayrollDian": { "docs": "**Note**: This field is not applicable for DIAN Colombia and will return `null`. ", + "inline": undefined, "properties": { "amount": { "docs": "**Note**: This field is not applicable for DIAN Colombia and will return `null`. @@ -5894,6 +6018,7 @@ Please note that other currencies other than in the list above may be returned. "InvoicesPayrollSat": { "docs": "Details regarding the payroll payment. Only applicable for payroll invoices. ", + "inline": undefined, "properties": { "amount": { "docs": "The total amount of the payroll payment. @@ -5962,6 +6087,7 @@ Please note that other currencies other than in the list above may be returned. "InvoicesReceiverDetailsDian": { "docs": "Details regarding the receiver. ", + "inline": undefined, "properties": { "address": { "docs": "The receiver's address. @@ -6016,6 +6142,7 @@ For detailed information regarding DIAN's tax schemes, please see their [officia }, "InvoicesResponsePaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -6045,6 +6172,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -6059,6 +6187,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "LastErrorInvalidCredentials": { "docs": "Information about the error you ran into in the previous step of the payment intent, if applicable. This error can occur when the credentials that your customer provides are incorrect.", + "inline": undefined, "properties": { "error_code": { "docs": "A unique error code (`invalid_credentials`) that allows you to classify and handle the error programmatically.", @@ -6075,6 +6204,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "LastErrorInvalidToken": { "docs": "Information about the error you ran into in the previous step of the payment intent, if applicable. This error can occur when the MFA token your customer provides is invalid.", + "inline": undefined, "properties": { "error_code": { "docs": "A unique error code (`invalid_token`) that allows you to classify and handle the error programmatically.", @@ -6091,6 +6221,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "LastErrorLoginError": { "docs": "Information about the error you ran into in the previous step of the payment intent, if applicable. This error can occur when something unexpected happened in the `pse_display_credentials_required` next step.", + "inline": undefined, "properties": { "error_code": { "docs": "A unique error code (`login_error`) that allows you to classify and handle the error programmatically.", @@ -6107,6 +6238,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "LastErrorPaymentError": { "docs": "Information about the error you ran into in the previous step of the payment intent, if applicable. This error can occur when something unexpected happened during the payment intent process.", + "inline": undefined, "properties": { "error_code": { "docs": "A unique error code (`payment_error`) that allows you to classify and handle the error programmatically.", @@ -6123,6 +6255,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "LastErrorSessionExpired": { "docs": "Information about the error you ran into in the previous step of the payment intent, if applicable. This error occurs when you try to send a PATCH request after the session has already expired (the session expires after 10 minutes).", + "inline": undefined, "properties": { "error_code": { "docs": "A unique error code (`session_expired`) that allows you to classify and handle the error programmatically.", @@ -6139,6 +6272,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "LastErrorTwoFactor": { "docs": "Information about the error you ran into in the previous step of the payment intent, if applicable. This error can occur when something unexpected happened in the `pse_display_token_required` next step.", + "inline": undefined, "properties": { "error_code": { "docs": "A unique error code (`login_two_factor_error`) that allows you to classify and handle the error programmatically.", @@ -6155,6 +6289,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "Link": { "docs": undefined, + "inline": undefined, "properties": { "access_mode": "optional", "created_at": { @@ -6228,6 +6363,7 @@ A unique 44-character string that can be used to identify a user at a given inst - the MFA token your user provides is not supported by Belvo. - there is an issue with the institution that prevents logins. - the user's account is either locked or the user does not have permission to access their internet banking.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`login_error`) that allows you to classify and handle the error programmatically. @@ -6266,6 +6402,7 @@ For `login_error` errors, the description can be one of the following: }, "NeedsRedirectContent": { "docs": "Details regarding the payer institution.", + "inline": undefined, "properties": { "payer_institution": "optional", }, @@ -6275,6 +6412,7 @@ For `login_error` errors, the description can be one of the following: }, "NeedsRedirectContentPse": { "docs": "Details regarding the payer institution.", + "inline": undefined, "properties": { "payer_institution": "optional", }, @@ -6284,6 +6422,7 @@ For `login_error` errors, the description can be one of the following: }, "NetIncomeIndividual": { "docs": "Object containing the declared net income of the tax payer. The values are calculated as the `gross_income` - `non_taxable_income`.", + "inline": undefined, "properties": { "capital_income": { "docs": "Income received from an investment (such as dividends or from renting a property).", @@ -6308,6 +6447,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepDisplayConfirmationRequiredOfpi": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "open_finance_display_confirmation_required": { "type": "optional", @@ -6326,6 +6466,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepDisplayConfirmationRequiredPse": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "pse_display_confirmation_required": { "type": "optional", @@ -6344,6 +6485,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepDisplayCredentialsRequiredPse": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "pse_display_credentials_required": { "type": "optional", @@ -6362,6 +6504,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepDisplayCustomerBankAccountsPse": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "pse_display_customer_bank_accounts": { "type": "optional", @@ -6380,6 +6523,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepDisplayNeedsRedirectPse": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "pse_display_needs_redirect": { "type": "optional", @@ -6398,6 +6542,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepDisplayPaymentFailed": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "open_finance_display_payment_failed": { "type": "optional", @@ -6416,6 +6561,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepDisplayPaymentMethodInformation": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "open_finance_display_payment_method_information": { "type": "optional", @@ -6434,6 +6580,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepDisplayPaymentMethodInformationPse": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type. You'll need to send a PATCH request with the institution selected by the customer or their bank accounts (if there are accounts already saved in the Belvo database).", + "inline": undefined, "properties": { "pse_display_payment_method_information": { "type": "optional", @@ -6452,6 +6599,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepDisplayPaymentProcessing": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "open_finance_display_payment_processing": { "type": "optional", @@ -6470,6 +6618,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepDisplayPaymentSucceeded": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "open_finance_display_payment_succeeded": { "type": "optional", @@ -6488,6 +6637,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepDisplayTokenRequiredPse": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "pse_display_token_required": { "type": "optional", @@ -6509,6 +6659,7 @@ For `login_error` errors, the description can be one of the following: }, "NextStepNeedsRedirect": { "docs": "Object detailing the next steps you should follow for a specific `next_step` type.", + "inline": undefined, "properties": { "open_finance_display_needs_redirect": { "type": "optional", @@ -6527,6 +6678,7 @@ For `login_error` errors, the description can be one of the following: }, "NonTaxableIncomeIndividual": { "docs": "Object containing the declared non-taxable income of the tax payer.", + "inline": undefined, "properties": { "capital_income": { "docs": "Income received from an investment (such as dividends or from renting a property).", @@ -6551,6 +6703,7 @@ For `login_error` errors, the description can be one of the following: }, "NotFoundErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`not_found`) that allows you to classify and handle the error programmatically. @@ -6583,6 +6736,7 @@ For `not_found` errors, the description is: }, "OFPB": { "docs": "Details about the organization's bank account that will receive the payment.", + "inline": undefined, "properties": { "beneficiary_bank_account": { "docs": "Belvo's unique ID used to identify the beneficiary's bank account.", @@ -6605,6 +6759,7 @@ For `not_found` errors, the description is: }, "OFPI": { "docs": "Details about the payment method.", + "inline": undefined, "properties": { "open_finance": { "type": "optional", @@ -6616,6 +6771,7 @@ For `not_found` errors, the description is: }, "Owner": { "docs": undefined, + "inline": undefined, "properties": { "address": { "docs": "The accounts owners registered address.", @@ -6709,6 +6865,7 @@ For `not_found` errors, the description is: }, "OwnerDocumentId": { "docs": "Information regarding the identification document the owner provided to the bank.", + "inline": undefined, "properties": { "document_number": { "docs": "The document's identification number.", @@ -6738,6 +6895,7 @@ For `not_found` errors, the description is: }, "OwnersPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -6765,6 +6923,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PSE": { "docs": "Object with payment method details to create a payment intent.", + "inline": undefined, "properties": { "pse": { "type": "PSE", @@ -6776,6 +6935,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaginatedResponseLink": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -6800,6 +6960,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PatchBody": { "docs": "A JSON object containing a session UUID and a MFA token", + "inline": undefined, "properties": { "link": { "docs": "The `link.id` you want to resume. Must be the same `link.id` as the one you receive in the 428 Token Required response that contains the `session` ID.", @@ -6838,6 +6999,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response }, "PatchBodyWithoutSaveData": { "docs": "A JSON object containing a session UUID and a MFA token", + "inline": undefined, "properties": { "link": { "docs": "The `link.id` you want to resume. Must be the same `link.id` as the one you receive in the 428 Token Required response that contains the `session` ID.", @@ -6870,6 +7032,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response }, "PatchPaymentIntentsBodyPse": { "docs": undefined, + "inline": undefined, "properties": { "pse": { "type": "optional", @@ -6881,6 +7044,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response }, "PatchPaymentMethodDetailsPse": { "docs": "Object with required fields to fill information in the payment intent object. The information you need to send through depends on the next step Belvo returns in the response.", + "inline": undefined, "properties": { "password": { "docs": "The password used to log in to the institution. @@ -6931,6 +7095,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response }, "PaymentInstitution": { "docs": undefined, + "inline": undefined, "properties": { "active": { "docs": "Indicates whether this institution is available for use or not.", @@ -6987,6 +7152,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response }, "PaymentIntentOfpi": { "docs": undefined, + "inline": undefined, "properties": { "allowed_payment_method_types": { "docs": "A list of payment method types allowed in this payment intent. For OFPI, the value will be `open_finance`.", @@ -7115,6 +7281,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -7129,6 +7296,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response }, "PaymentIntentPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -7156,6 +7324,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentIntentPaymentMethodDetailsBodyBusinessOfpi": { "docs": "Payment method type selected.", + "inline": undefined, "properties": { "beneficiary_bank_account": { "docs": "Belvo's unique ID used to identify the beneficiary's bank account.", @@ -7194,6 +7363,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentIntentPaymentMethodDetailsBodyIndividualOfpi": { "docs": "Payment method type selected.", + "inline": undefined, "properties": { "beneficiary_bank_account": { "docs": "Belvo's unique ID used to identify the beneficiary's bank account.", @@ -7232,6 +7402,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentIntentPaymentMethodDetailsBodyPse": { "docs": "Details about the payment method type selected.", + "inline": undefined, "properties": { "belvo_flow": { "default": true, @@ -7287,6 +7458,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentIntentPse": { "docs": undefined, + "inline": undefined, "properties": { "allowed_payment_method_types": { "docs": "A list of payment method types allowed in this payment intent. For PSE, the value will be `pse`.", @@ -7385,6 +7557,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -7441,6 +7614,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentLinkCallbackUrls": { "docs": undefined, + "inline": undefined, "properties": { "cancel": { "docs": "The URL that the user should be redirected to if they decide to cancel the payment process or if an error occurs. @@ -7463,6 +7637,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "docs": "The URLs that the user should be redirected to. **Note:** This field will return an empty object if your integration only generates payment links through the [Belvo Dashboard](https://dashboard.belvo.com/).", + "inline": undefined, "properties": { "cancel": { "docs": "The URL that the user should be redirected to if they decide to cancel the payment process or if an error occurs.", @@ -7479,6 +7654,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentLinkListOfpi": { "docs": undefined, + "inline": undefined, "properties": { "access_token": { "docs": "The Belvo-generated access token for the payment link. @@ -7555,6 +7731,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentLinkListPse": { "docs": undefined, + "inline": undefined, "properties": { "access_token": { "docs": "The Belvo-generated access token for the payment link. @@ -7631,6 +7808,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentLinkOfpi": { "docs": undefined, + "inline": undefined, "properties": { "access_token": { "docs": "The Belvo-generated access token for the payment link. @@ -7700,6 +7878,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentLinkPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -7729,6 +7908,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -7743,6 +7923,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentLinkPse": { "docs": undefined, + "inline": undefined, "properties": { "access_token": { "docs": "The Belvo-generated access token for the payment link. @@ -7812,6 +7993,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentMethodInfoCustomerBankAccountsPse": { "docs": undefined, + "inline": undefined, "properties": { "customer": { "docs": "Belvo's unique ID for the current customer.", @@ -7847,6 +8029,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentMethodInformationBodyOfpi": { "docs": "Payment method type selected.", + "inline": undefined, "properties": { "end_to_end_id": { "docs": "A unique ID for the transaction in the Brazil's PIX payment system.", @@ -7867,6 +8050,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentMethodInformationBodyPse": { "docs": "Payment method type selected.", + "inline": undefined, "properties": { "bank_payment_id": { "docs": "Unique payment ID provided the institution.", @@ -7891,6 +8075,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentMethodInformationDetailsPse": { "docs": undefined, + "inline": undefined, "properties": { "account_type": { "docs": "The type of bank account. For example, `Ahorros` or `Corriente`.", @@ -7904,6 +8089,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentTransaction": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "The transaction amount. @@ -7984,6 +8170,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -7998,6 +8185,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentWebhook": { "docs": undefined, + "inline": undefined, "properties": { "auth_header": { "docs": "The authentication header for the request. **Must** be set to `Authorization`.", @@ -8044,6 +8232,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentsInstitutionsPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -8071,6 +8260,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentsTransactionsPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -8098,6 +8288,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentsWay": { "docs": undefined, + "inline": undefined, "properties": { "form_id": { "docs": "Your unique Payments Way form ID. @@ -8118,6 +8309,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PaymentsWebhooksPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -8145,6 +8337,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "PensionIncomeStatementIndividual": { "docs": "Object containing the tax payer's total pension income.", + "inline": undefined, "properties": { "net_pension_income": { "docs": "The total net pension of the taxpayer.", @@ -8161,6 +8354,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "ReceivablesTransaction": { "docs": undefined, + "inline": undefined, "properties": { "account": "ReceivablesTransactionAccount", "collected_at": { @@ -8228,6 +8422,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "ReceivablesTransactionAccount": { "docs": "Basic information about the account associated with the transaction.", + "inline": undefined, "properties": { "id": { "docs": "Belvo's unique ID for the account associated with the transaction.", @@ -8247,6 +8442,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "ReceivablesTransactionNumberOfInstallments": { "docs": "Details regarding the number of installments for the transaction, if applicable.", + "inline": undefined, "properties": { "paid": { "docs": "The number of payments already made to pay the cost of the transaction.", @@ -8263,6 +8459,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "ReceivablesTransactionsPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -8290,6 +8487,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "RecevablesTransactionFees": { "docs": "Details regarding the fees applied to the transaction.", + "inline": undefined, "properties": { "type": "optional", "value": { @@ -8303,6 +8501,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "RecurringExpenseSourceTransaction": { "docs": "An array of minified transaction objects used to evaluate the recurring expense. If no transactions were found, we return an empty array.", + "inline": undefined, "properties": { "amount": { "docs": "The transaction amount.", @@ -8333,6 +8532,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro ℹ️ If no recurring expense insights are found, we return an empty array. ", + "inline": undefined, "properties": { "account": "optional", "average_transaction_amount": { @@ -8381,6 +8581,7 @@ Based on the frequency, you can infer how many days until the next charge will o }, "RecurringExpensesPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -8408,6 +8609,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "ReportingId": { "docs": "Object containing information about where the tax payer reports their income.", + "inline": undefined, "properties": { "reporting_type": { "docs": "The type of reporting ID. For DIAN, this is the sectional address code (*Codigo Dirrecion Seccional*)", @@ -8424,6 +8626,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "RequestTimeoutErrorBody": { "docs": "Belvo has a limit regarding the time it takes to log in, retrieve account data, and log out. A timeout occurs when there is a very high amount of data and everything could not be obtained within the allotted time.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`request_timeout`) that allows you to classify and handle the error programmatically. @@ -8456,6 +8659,7 @@ For `request_timeout` errors, the description is: }, "RetentionBreakdown": { "docs": "A breakdown of the retained taxes", + "inline": undefined, "properties": { "base_amount": { "docs": "The base amount that was used to calculate the tax retention. @@ -8480,6 +8684,7 @@ For `request_timeout` errors, the description is: }, "RiskInsights": { "docs": undefined, + "inline": undefined, "properties": { "accounts": { "docs": "An array of Belvo-generated account numbers (UUIDs) that were used during the risk insights analysis. If no accounts were found, we return an empty array.", @@ -8521,6 +8726,7 @@ For `request_timeout` errors, the description is: }, "RiskInsightsBalanceMetrics": { "docs": "Balance metrics calculated based on the user's balances from checking and savings accounts.", + "inline": undefined, "properties": { "balance_threshold_x": { "docs": "The threshold used to compute `days_balance_below_x_period`. Please note, this is value is country specific (both in terms of the amount and the currency). @@ -8602,6 +8808,7 @@ For `request_timeout` errors, the description is: However, internal transfers (transfers between accounts belonging to the same link) are not used in the calculation. ", + "inline": undefined, "properties": { "positive_to_negative_ratio_1m": { "docs": "The ratio between sum_positive / sum_negative in the last month (counted from the time of the request). @@ -8663,6 +8870,7 @@ However, internal transfers (transfers between accounts belonging to the same li }, "RiskInsightsCreditCardMetrics": { "docs": "Aggregated metrics calculated based on the link's credit card accounts.", + "inline": undefined, "properties": { "num_accounts": { "docs": "Number of credit cards accounts associated to the link. @@ -8693,6 +8901,7 @@ However, internal transfers (transfers between accounts belonging to the same li }, "RiskInsightsLoansMetrics": { "docs": "Aggregated metrics calculated based on the user's loan accounts.", + "inline": undefined, "properties": { "num_accounts": { "docs": "Number of loan accounts associated with the link. @@ -8721,6 +8930,7 @@ However, internal transfers (transfers between accounts belonging to the same li }, "RiskInsightsPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -8748,6 +8958,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "RiskInsightsTransactionMetrics": { "docs": "Aggregated metrics calculated band on the user's transactions from checking, savings, credit card, and loan accounts.", + "inline": undefined, "properties": { "max_incoming_amount_1m": { "docs": "The highest value inflow transaction in the last month. @@ -8924,6 +9135,7 @@ If the account has not been open long enough to have the transaction data for a }, "SecretKeys": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "The ISO-8601 timestamp of when the secret key was created. @@ -8956,6 +9168,7 @@ If the account has not been open long enough to have the transaction data for a }, "SecretKeysPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -8983,6 +9196,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "SessionExpiredError": { "docs": "This error occurs when you try to resume a request session that has already expired. This is usually because the user took too long to provide their authentication token.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`session_expired`) that allows you to classify and handle the error programmatically. @@ -9015,6 +9229,7 @@ For `session_expired` errors, the description is: }, "StandardRequest": { "docs": undefined, + "inline": undefined, "properties": { "link": { "docs": "The `link.id` that you want to get information for.", @@ -9043,6 +9258,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response }, "TaxAssessmentBusiness": { "docs": "Object containing the calculated tax assessment of the tax payer. This includes the total taxable income, the income tax applied, and taxes already withheld.", + "inline": undefined, "properties": { "fortuitous_profit_tax": { "docs": "The tax applied on your unexpected income (such as lottery wins or house sales).", @@ -9087,6 +9303,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response }, "TaxAssessmentIndividual": { "docs": "Object containing the calculated tax assessment of the tax payer. This includes the total taxable income, the income tax applied, and taxes already withheld.", + "inline": undefined, "properties": { "balance_payable": { "docs": "How much the tax payer is required to pay.", @@ -9135,6 +9352,7 @@ The amount the tax payer has as a "credit" fromt he previous year (this is equal }, "TaxComplianceStatus": { "docs": undefined, + "inline": undefined, "properties": { "collected_at": { "docs": "The ISO-8601 timestamp when the data point was collected.", @@ -9180,6 +9398,7 @@ The amount the tax payer has as a "credit" fromt he previous year (this is equal }, "TaxComplianceStatusPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -9207,6 +9426,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxDeclarationBusiness": { "docs": undefined, + "inline": undefined, "properties": { "annual_costs_and_deductions_statement": "AnnualCostsAndDeductionsStatementBusiness", "annual_income_statement": "AnnualIncomeStatementBusiness", @@ -9263,6 +9483,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxDeclarationBusinessPaginated": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -9290,6 +9511,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxDeclarationIndividual": { "docs": undefined, + "inline": undefined, "properties": { "annual_income_statement": "AnnualIncomeStatementIndividual", "collected_at": { @@ -9346,6 +9568,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxDeclarationIndividualPaginated": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -9373,6 +9596,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxPayerInformationBusiness": { "docs": "Object containing information about the tax payer.", + "inline": undefined, "properties": { "company_name": { "docs": "The name of the company, as registered at the institution.", @@ -9407,6 +9631,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxPayerInformationIndividual": { "docs": "Object containing information about the tax payer.", + "inline": undefined, "properties": { "document_id": "DocumentIdIndividual", "first_last_name": { @@ -9437,6 +9662,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxRetentions": { "docs": undefined, + "inline": undefined, "properties": { "cancelled_at": { "docs": "The ISO-8601 timestamp of when the tax retention was canceled (if applicable). @@ -9561,6 +9787,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxRetentionsPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -9589,6 +9816,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "TaxReturnBusiness": { "docs": undefined, "extra-properties": true, + "inline": undefined, "properties": { "cifras_cierre_ejercicio": { "docs": "Details regarding key numbers at the end of the fiscal exercise.", @@ -9676,6 +9904,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "TaxReturnBusinessMonthly": { "docs": undefined, "extra-properties": true, + "inline": undefined, "properties": { "collected_at": { "docs": "The ISO-8601 timestamp when the data point was collected.", @@ -9747,6 +9976,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "TaxReturnPersonal": { "docs": undefined, "extra-properties": true, + "inline": undefined, "properties": { "collected_at": { "docs": "The ISO-8601 timestamp when the data point was collected.", @@ -9836,6 +10066,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "TaxReturnPersonalMonthly": { "docs": undefined, "extra-properties": true, + "inline": undefined, "properties": { "collected_at": { "docs": "The ISO-8601 timestamp when the data point was collected.", @@ -9899,6 +10130,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "TaxReturnsBusinessMonthlyPaginated": { "docs": undefined, "extra-properties": true, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -9927,6 +10159,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "TaxReturnsBusinessPaginated": { "docs": undefined, "extra-properties": true, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -9954,6 +10187,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxReturnsMonthlyRequest": { "docs": "Request body for monthly tax returns", + "inline": undefined, "properties": { "attach_pdf": { "default": false, @@ -10002,6 +10236,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response "TaxReturnsPersonalMonthlyPaginated": { "docs": undefined, "extra-properties": true, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -10030,6 +10265,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "TaxReturnsPersonalPaginated": { "docs": undefined, "extra-properties": true, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -10057,6 +10293,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxReturnsYearlyRequest": { "docs": "Request body for yearly tax returns", + "inline": undefined, "properties": { "attach_pdf": { "default": false, @@ -10104,6 +10341,7 @@ By default, Belvo returns the yearly (annual) tax returns. }, "TaxStatusAddressBetweenStreetDian": { "docs": undefined, + "inline": undefined, "properties": { "street_one": { "docs": "**Note**: This field is not applicable for DIAN Colombia and will return `null`. @@ -10122,6 +10360,7 @@ By default, Belvo returns the yearly (annual) tax returns. }, "TaxStatusAddressBetweenStreetSat": { "docs": undefined, + "inline": undefined, "properties": { "street_one": { "docs": "The first street that `street` is located between.", @@ -10138,6 +10377,7 @@ By default, Belvo returns the yearly (annual) tax returns. }, "TaxStatusAddressDian": { "docs": "The tax payer's address details.", + "inline": undefined, "properties": { "between_street": { "docs": "**Note**: This field is not applicable for DIAN Colombia and will return `null`. @@ -10190,6 +10430,7 @@ By default, Belvo returns the yearly (annual) tax returns. }, "TaxStatusAddressSat": { "docs": "The tax payer's address details.", + "inline": undefined, "properties": { "between_street": { "docs": "Additional information about where the `street` is located. @@ -10242,6 +10483,7 @@ By default, Belvo returns the yearly (annual) tax returns. }, "TaxStatusDian": { "docs": undefined, + "inline": undefined, "properties": { "address": "optional", "collected_at": { @@ -10332,6 +10574,7 @@ Note: For individuals in Colombia, this field will return `null`. }, "TaxStatusEconomicActivityDian": { "docs": undefined, + "inline": undefined, "properties": { "economic_activity": { "docs": "The economic activity code, according to the fiscal institution. @@ -10377,6 +10620,7 @@ For detailed information regarding DIAN's economic activities, please see their }, "TaxStatusEconomicActivitySat": { "docs": undefined, + "inline": undefined, "properties": { "economic_activity": { "docs": "The description of the economic activity.", @@ -10422,6 +10666,7 @@ For detailed information regarding DIAN's economic activities, please see their ℹ️ For non-business accounts, this field will return empty. ", + "inline": undefined, "properties": { "end_date": { "docs": "**Note**: This field is not applicable for DIAN Colombia and will return `null`. @@ -10465,6 +10710,7 @@ For detailed information regarding DIAN's economic activities, please see their ℹ️ For non-business accounts, this field will return empty. ", + "inline": undefined, "properties": { "end_date": { "docs": "The date when obligation ended. @@ -10505,6 +10751,7 @@ For detailed information regarding DIAN's economic activities, please see their }, "TaxStatusPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -10534,6 +10781,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -10548,6 +10796,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxStatusRegimensDian": { "docs": undefined, + "inline": undefined, "properties": { "end_date": { "docs": "**Note**: This field is not applicable for DIAN Colombia and will return `null`. @@ -10582,6 +10831,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxStatusRegimensSat": { "docs": undefined, + "inline": undefined, "properties": { "end_date": { "docs": "The end date of the regimen. @@ -10616,6 +10866,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxStatusSat": { "docs": undefined, + "inline": undefined, "properties": { "address": "optional", "collected_at": { @@ -10703,6 +10954,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxStatusTaxPayerInformationDian": { "docs": "Details regarding the taxpayer.", + "inline": undefined, "properties": { "commercial_name": { "docs": "The name of the business designated for consumers and the general public. @@ -10779,6 +11031,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TaxStatusTaxPayerInformationSat": { "docs": "Details regarding the taxpayer.", + "inline": undefined, "properties": { "commercial_name": { "docs": "The name of the business designated for consumers and the general public. @@ -10855,6 +11108,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TokenRequiredResponse": { "docs": "MFA Token Required", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`token_required`) that allows you to classify and handle the error programmatically. @@ -10912,6 +11166,7 @@ For `token_required` errors, the description is: }, "TokenRequiredResponseTokenGenerationData": { "docs": "Details on how to generate the token.", + "inline": undefined, "properties": { "expects_user_input": { "default": true, @@ -10943,6 +11198,7 @@ You will still need to make a PATCH call to complete the request.", - a user is attempting to log in to their institution via Belvo while also already being logged in to their institution on a web browser or mobile app. - you make a request for information while Belvo is scraping data from the institution for that user.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`too_many_sessions`) that allows you to classify and handle the error programmatically. @@ -10975,6 +11231,7 @@ For `too_many_sessions` errors, the description is: }, "Transaction": { "docs": undefined, + "inline": undefined, "properties": { "account": "optional", "accounting_date": { @@ -11072,6 +11329,7 @@ For `too_many_sessions` errors, the description is: }, "TransactionBankAccountBodyPse": { "docs": "Information about the payer's bank account. Belvo returns the bank account ID when the account is already saved in the Belvo database.", + "inline": undefined, "properties": { "bank_account": { "docs": "Belvo's unique identifier for the payer’s bank account.", @@ -11096,6 +11354,7 @@ For `too_many_sessions` errors, the description is: "discriminated": false, "docs": "Object containing the payer's bank account information.", "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -11110,6 +11369,7 @@ For `too_many_sessions` errors, the description is: }, "TransactionCreditCardData": { "docs": "Additional data provided by the institution for credit card transactions.", + "inline": undefined, "properties": { "bill_amount": { "docs": "The aggregate bill amount, as of `collected_at`.", @@ -11144,6 +11404,7 @@ We only return merchant information for new transactions made from *checking* or > **Get merchant information** We retrieve the merchant information for a transaction as part of our [Transaction categorization](https://developers.belvo.com/docs/banking#categorizing-transactions) product, turning raw data into actionable insights. To enable this product, just [reach out](https://belvo.com/contact/?utm_source=documentation) to us, and we'll get right to it. ", + "inline": undefined, "properties": { "logo": { "docs": "The URL to the merchant's logo.", @@ -11164,6 +11425,7 @@ We only return merchant information for new transactions made from *checking* or }, "TransactionsPaginatedResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "The total number of results in your Belvo account.", @@ -11191,6 +11453,7 @@ In our documentation example, we use `{endpoint}` as a placeholder value. In pro }, "TransactionsRequest": { "docs": undefined, + "inline": undefined, "properties": { "account": { "docs": "If provided, we return transactions only from this account.", @@ -11253,6 +11516,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response }, "UnauthorizedErrorBody": { "docs": "This error occurs when you try to make an API call using incorrect Belvo API credentials (either your secret key or secret password, or both, are incorrect).", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`authentication_failed`) that allows you to classify and handle the error programmatically. @@ -11286,6 +11550,7 @@ For `authentication_failed` errors, the description is: "UnconfirmedLinkError": { "docs": "This error occurs when you try to access a link that was paused previously (and as such is not active now). A Link's status is set to `unconfirmed_link` when your user has not completed the Link creation process successfully (for example, they might not provide a valid MFA token).", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`unconfirmed_link`) that allows you to classify and handle the error programmatically. @@ -11318,6 +11583,7 @@ For `unconfirmed_link` errors, the description is: }, "UnexpectedError": { "docs": "This error occurs when we (Belvo) have encountered an internal system error (sorry about that) or due to an unsupported response from the institution.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`unexpected_error`) that allows you to classify and handle the error programmatically. @@ -11350,6 +11616,7 @@ For `unexpected_error` errors, the description is: }, "UnsupportedOperationError": { "docs": "This error occurs when you try to access some data operation that Belvo does not support for an institution. For example, trying to access the Balances resource for fiscal institutions.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`unsupported_operation`) that allows you to classify and handle the error programmatically. @@ -11382,6 +11649,7 @@ For `unsupported_operation` errors, the description is: }, "ValidationError": { "docs": "This error occurs when you try to resume a request session that has already expired. This is usually because the user took too long to provide their authentication token.", + "inline": undefined, "properties": { "code": { "docs": "A unique error code (`null`, `does_not_exist`, `required`) that allows you to classify and handle the error programmatically. @@ -14657,6 +14925,7 @@ types: - type: InvoiceDian source: openapi: ../openapi.yml + inline: true InvoicesResponsePaginatedResponse: properties: count: @@ -15648,6 +15917,7 @@ types: - type: TaxStatusDian source: openapi: ../openapi.yml + inline: true TaxStatusPaginatedResponse: properties: count: @@ -18891,6 +19161,7 @@ types: - type: CustomerPse source: openapi: ../openapi.yml + inline: true CustomerPaginatedResponse: properties: count: @@ -19045,6 +19316,7 @@ types: - type: INDIVIDUAL source: openapi: ../openapi.yml + inline: true OFPI: docs: Details about the payment method. properties: @@ -19059,6 +19331,7 @@ types: - type: BankAccountDetailsOfpiPix source: openapi: ../openapi.yml + inline: true BankAccountOfpiResponse: properties: id: @@ -19183,6 +19456,7 @@ types: - BankAccountPseResponse source: openapi: ../openapi.yml + inline: true BankAccountPaginatedResponse: properties: count: @@ -19217,6 +19491,7 @@ types: - type: INDIVIDUAL source: openapi: ../openapi.yml + inline: true CreateBankAccountOfpiDetails: discriminated: false docs: Information regarding the bank account. @@ -19225,6 +19500,7 @@ types: - type: BankAccountDetailsOfpiPix source: openapi: ../openapi.yml + inline: true CreateBankAccountOfpi: properties: institution: @@ -19454,6 +19730,7 @@ types: - type: PaymentLinkListPse source: openapi: ../openapi.yml + inline: true PaymentLinkPaginatedResponse: properties: count: @@ -19562,6 +19839,7 @@ types: - float source: openapi: ../openapi.yml + inline: true CreatePaymentLinkOfpi: properties: amount: @@ -19628,6 +19906,7 @@ types: - long source: openapi: ../openapi.yml + inline: true CreatePaymentLinkPse: properties: amount: @@ -19764,6 +20043,7 @@ types: - type: BankAccountDetailsOpenFinancePix source: openapi: ../openapi.yml + inline: true BeneficiaryBankAccountOfpi: properties: id: @@ -20086,6 +20366,7 @@ types: - type: TransactionBankAccountPse source: openapi: ../openapi.yml + inline: true PaymentTransaction: properties: id: @@ -20152,6 +20433,7 @@ types: - type: OFPI source: openapi: ../openapi.yml + inline: true Charge: properties: id: @@ -20268,6 +20550,7 @@ types: - type: BUSINESS source: openapi: ../openapi.yml + inline: true PaymentIntentOfpi: properties: id: @@ -20796,6 +21079,7 @@ types: - type: LastErrorSessionExpired source: openapi: ../openapi.yml + inline: true PaymentIntentPse: properties: id: @@ -30461,6 +30745,7 @@ docs: >- "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -30477,6 +30762,7 @@ docs: >- "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -30491,6 +30777,7 @@ docs: >- "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -31616,6 +31903,7 @@ docs: >- "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -31632,6 +31920,7 @@ docs: >- "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -31648,6 +31937,7 @@ docs: >- "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -41059,6 +41349,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -41075,6 +41366,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -41091,6 +41383,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -49743,6 +50036,7 @@ During the payment intent flow, you need to fill in the payment intent with requ **Note:** You can send through this value either as a string or an integer. Regardless of the type you choose to send the `amount` as, Belvo returns a string with two decimal points, separated by a period ( `.`). For example, `350000.00`. ", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -50377,6 +50671,7 @@ types: - long source: openapi: ../openapi.yml + inline: true ", }, "paymentLinks.yml": { @@ -50786,6 +51081,7 @@ types: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -50802,6 +51098,7 @@ types: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -50818,6 +51115,7 @@ types: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -59212,6 +59510,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -59228,6 +59527,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -59244,6 +59544,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -65612,6 +65913,7 @@ client.connect() "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -65634,6 +65936,7 @@ client.connect() "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -65656,6 +65959,7 @@ client.connect() "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -65672,6 +65976,7 @@ client.connect() "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -70901,6 +71206,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -70917,6 +71223,7 @@ When set to `false`, the data won't be persisted and we return a 200 OK response "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/buzzshot.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/buzzshot.json index 52ae34cb367..fd91f1ef799 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/buzzshot.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/buzzshot.json @@ -8,6 +8,7 @@ "types": { "Game": { "docs": undefined, + "inline": undefined, "properties": { "added_at": "optional", "complete": "GameComplete", @@ -44,6 +45,7 @@ }, "GameComplete": { "docs": undefined, + "inline": true, "properties": { "completed_at": "datetime", "completion_time": "optional", @@ -57,6 +59,7 @@ }, "GameExtraFieldsItem": { "docs": undefined, + "inline": true, "properties": { "key": "string", "label": "optional", @@ -69,6 +72,7 @@ }, "GamePhotosItem": { "docs": undefined, + "inline": true, "properties": { "added_at": "optional", "photo": "string", @@ -89,6 +93,7 @@ }, "Group": { "docs": undefined, + "inline": undefined, "properties": { "added_at": "optional", "date": { @@ -124,6 +129,7 @@ }, "GroupGamesItem": { "docs": undefined, + "inline": true, "properties": { "added_at": "optional", "complete": "GroupGamesItemComplete", @@ -158,6 +164,7 @@ }, "GroupGamesItemComplete": { "docs": undefined, + "inline": true, "properties": { "completed_at": "datetime", "completion_time": "optional", @@ -171,6 +178,7 @@ }, "GroupGamesItemExtraFieldsItem": { "docs": undefined, + "inline": true, "properties": { "key": "string", "label": "optional", @@ -183,6 +191,7 @@ }, "GroupPhotosItem": { "docs": undefined, + "inline": true, "properties": { "added_at": "optional", "game": "optional", @@ -204,6 +213,7 @@ }, "GroupPlayersItem": { "docs": undefined, + "inline": true, "properties": { "added_at": "optional", "email": { @@ -245,6 +255,7 @@ }, "GroupPlayersItemExtraFieldsItem": { "docs": undefined, + "inline": true, "properties": { "key": "string", "label": "optional", @@ -257,6 +268,7 @@ }, "Photo": { "docs": undefined, + "inline": undefined, "properties": { "added_at": "optional", "id": "optional", @@ -277,6 +289,7 @@ }, "PhotoProcessedItem": { "docs": undefined, + "inline": true, "properties": { "added_at": "optional", "game": "optional", @@ -299,6 +312,7 @@ }, "Player": { "docs": undefined, + "inline": undefined, "properties": { "added_at": "optional", "email": { @@ -340,6 +354,7 @@ }, "PlayerExtraFieldsItem": { "docs": undefined, + "inline": true, "properties": { "key": "string", "label": "optional", @@ -352,6 +367,7 @@ }, "Room": { "docs": undefined, + "inline": undefined, "properties": { "hidden": "optional", "id": "optional", @@ -393,6 +409,7 @@ ready: optional source: openapi: ../openapi.yml + inline: true GameExtraFieldsItem: properties: key: string @@ -401,6 +418,7 @@ present: boolean source: openapi: ../openapi.yml + inline: true GameComplete: properties: completed_at: datetime @@ -410,6 +428,7 @@ completion_time: optional source: openapi: ../openapi.yml + inline: true Game: properties: id: optional @@ -440,6 +459,7 @@ present: boolean source: openapi: ../openapi.yml + inline: true GroupGamesItemComplete: properties: completed_at: datetime @@ -449,6 +469,7 @@ completion_time: optional source: openapi: ../openapi.yml + inline: true GroupGamesItem: properties: id: optional @@ -469,6 +490,7 @@ complete: GroupGamesItemComplete source: openapi: ../openapi.yml + inline: true GroupPlayersItemExtraFieldsItem: properties: key: string @@ -477,6 +499,7 @@ present: boolean source: openapi: ../openapi.yml + inline: true GroupPlayersItem: properties: added_at: optional @@ -499,6 +522,7 @@ signature: optional source: openapi: ../openapi.yml + inline: true GroupPhotosItem: properties: added_at: optional @@ -511,6 +535,7 @@ ready: optional source: openapi: ../openapi.yml + inline: true Group: properties: id: optional @@ -540,6 +565,7 @@ present: boolean source: openapi: ../openapi.yml + inline: true Player: properties: id: optional @@ -575,6 +601,7 @@ ready: optional source: openapi: ../openapi.yml + inline: true Photo: properties: id: optional @@ -1293,6 +1320,7 @@ "types": { "ListAccountsResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "next": { @@ -1321,6 +1349,7 @@ }, "ListGamesResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "next": { @@ -1349,6 +1378,7 @@ }, "ListGroupsResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "next": { @@ -1377,6 +1407,7 @@ }, "ListLocationsResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "next": { @@ -1405,6 +1436,7 @@ }, "ListPhotosResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "next": { @@ -1433,6 +1465,7 @@ }, "ListPlayersResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "next": { diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/deel.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/deel.json index 15bfe45a120..13cfb2c3ff7 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/deel.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/deel.json @@ -99,6 +99,7 @@ "types": { "Agreement": { "docs": undefined, + "inline": undefined, "properties": { "agreement_title": "string", "agreement_type": "string", @@ -113,6 +114,7 @@ }, "AgreementClientLegalEntity": { "docs": undefined, + "inline": true, "properties": { "id": "double", "name": "string", @@ -124,6 +126,7 @@ "AgreementList": "list", "AgreementListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "AgreementList", "page": "optional", @@ -134,6 +137,7 @@ }, "AgreementMsa": { "docs": undefined, + "inline": true, "properties": { "id": "string", "title": "string", @@ -144,6 +148,7 @@ }, "AgreementProviderLegalEntity": { "docs": undefined, + "inline": true, "properties": { "id": "double", "name": "string", @@ -162,6 +167,7 @@ }, "AgreementsSearchForm": { "docs": "Convenient model to encapsulate query parameters to get a list of agreements.", + "inline": undefined, "properties": { "contract_id": "optional", "limit": "optional", @@ -173,6 +179,7 @@ }, "AlternateEmailItem": { "docs": undefined, + "inline": undefined, "properties": { "email": "optional", "isVerified": "boolean", @@ -187,6 +194,7 @@ }, "ApiError": { "docs": undefined, + "inline": undefined, "properties": { "message": { "docs": "A description of the returned error", @@ -203,6 +211,7 @@ }, "ApiErrorContainer": { "docs": undefined, + "inline": undefined, "properties": { "errors": "optional>", "request": "optional", @@ -213,6 +222,7 @@ }, "ApiErrorRequest": { "docs": undefined, + "inline": undefined, "properties": { "api_req_id": { "docs": "The request ID of the failed request", @@ -249,6 +259,7 @@ }, "BasicContract": { "docs": undefined, + "inline": undefined, "properties": { "client": "ClientOfBasicContract", "created_at": "optional", @@ -291,6 +302,7 @@ }, "BasicInvoiceAdjustment": { "docs": undefined, + "inline": undefined, "properties": { "attachment": "optional", "contract": "BasicInvoiceAdjustmentContract", @@ -317,6 +329,7 @@ }, "BasicInvoiceAdjustmentContract": { "docs": undefined, + "inline": true, "properties": { "id": "string", "title": "string", @@ -328,6 +341,7 @@ }, "BasicInvoiceAdjustmentPaymentCycle": { "docs": undefined, + "inline": true, "properties": { "end_date": "optional", "start_date": "optional", @@ -338,6 +352,7 @@ }, "BasicInvoiceAdjustmentReportedBy": { "docs": undefined, + "inline": true, "properties": { "full_name": "string", "id": "double", @@ -348,6 +363,7 @@ }, "BasicInvoiceAdjustmentReviewedBy": { "docs": undefined, + "inline": true, "properties": { "full_name": "string", "id": "double", @@ -360,6 +376,7 @@ }, "BasicInvoiceAdjustmentWorksheet": { "docs": undefined, + "inline": true, "properties": { "days": { "type": "double", @@ -408,6 +425,7 @@ }, "BasicLegalEntity": { "docs": undefined, + "inline": undefined, "properties": { "entity_subtype": "LegalEntitySubType", "entity_type": "LegalEntityType", @@ -420,6 +438,7 @@ }, "BasicOrganization": { "docs": undefined, + "inline": undefined, "properties": { "id": "double", "name": { @@ -438,6 +457,7 @@ }, "BasicTeam": { "docs": undefined, + "inline": undefined, "properties": { "id": "double", "name": { @@ -456,6 +476,7 @@ }, "BasicTimesheet": { "docs": undefined, + "inline": undefined, "properties": { "attachment": "optional", "contract": "BasicTimesheetContract", @@ -488,6 +509,7 @@ }, "BasicTimesheetContract": { "docs": undefined, + "inline": true, "properties": { "id": "string", "title": "string", @@ -499,6 +521,7 @@ }, "BasicTimesheetPaymentCycle": { "docs": undefined, + "inline": true, "properties": { "end_date": "optional", "start_date": "optional", @@ -509,6 +532,7 @@ }, "BasicTimesheetReportedBy": { "docs": undefined, + "inline": true, "properties": { "full_name": "string", "id": "double", @@ -519,6 +543,7 @@ }, "BasicTimesheetReviewedBy": { "docs": undefined, + "inline": true, "properties": { "full_name": "string", "id": "double", @@ -531,6 +556,7 @@ }, "BasicTimesheetWorksheet": { "docs": undefined, + "inline": true, "properties": { "days": { "type": "double", @@ -579,6 +605,7 @@ }, "ClientLegalEntity": { "docs": undefined, + "inline": undefined, "properties": { "email": "optional", "id": "long", @@ -594,6 +621,7 @@ }, "ClientOfBasicContract": { "docs": undefined, + "inline": undefined, "properties": { "team": "optional", }, @@ -603,6 +631,7 @@ }, "ClientOfContract": { "docs": undefined, + "inline": undefined, "properties": { "email": "optional", "full_name": "string", @@ -616,6 +645,7 @@ }, "CompensationDetailsOfContract": { "docs": undefined, + "inline": undefined, "properties": { "amount": "string", "currency_code": "CurrencyCodeRequired", @@ -633,6 +663,7 @@ }, "CompensationDetailsOfContractToCreateOngoingTimeBased": { "docs": undefined, + "inline": undefined, "properties": { "amount": "double", "scale": "WorkStatementScaleEnum", @@ -643,6 +674,7 @@ }, "CompensationDetailsOfContractToCreatePayAsYouGoTimeBased": { "docs": undefined, + "inline": undefined, "properties": { "amount": "double", "scale": "WorkStatementScaleEnum", @@ -653,6 +685,7 @@ }, "CompensationDetailsOfContractToCreateShared": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.", @@ -708,6 +741,7 @@ }, "Contract": { "docs": undefined, + "inline": undefined, "properties": { "client": "optional", "compensation_details": "CompensationDetailsOfContract", @@ -757,6 +791,7 @@ }, "ContractContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "Contract", }, @@ -766,6 +801,7 @@ }, "ContractContainerOngoingTimeBased": { "docs": undefined, + "inline": undefined, "properties": { "data": "Contract", }, @@ -775,6 +811,7 @@ }, "ContractContainerPayAsYouGoTimeBased": { "docs": undefined, + "inline": undefined, "properties": { "data": "Contract", }, @@ -784,6 +821,7 @@ }, "ContractContainerPaygMilestones": { "docs": undefined, + "inline": undefined, "properties": { "data": "Contract", }, @@ -793,6 +831,7 @@ }, "ContractContainerPaygTasks": { "docs": undefined, + "inline": undefined, "properties": { "data": "Contract", }, @@ -802,6 +841,7 @@ }, "ContractCustomField": { "docs": "Customized attributes on contracts (Employee ID, Project code, etc).", + "inline": undefined, "properties": { "name": { "docs": "Custom field property name.", @@ -818,6 +858,7 @@ }, "ContractDetailsToAmend": { "docs": "You can specify any combination of data points that need changing.", + "inline": undefined, "properties": { "amount": { "type": "optional", @@ -897,6 +938,7 @@ }, "ContractDocumentContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional", }, @@ -906,6 +948,7 @@ }, "ContractExternalIdPatchedContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "ContractExternalIdToPatch", }, @@ -916,6 +959,7 @@ "ContractExternalIdPatchedResponseContainer": "ContractExternalIdToPatch", "ContractExternalIdToPatch": { "docs": undefined, + "inline": undefined, "properties": { "external_id": { "docs": "A unique identifier for the object provided by an external system.", @@ -938,6 +982,7 @@ }, "ContractInvitationToCreate": { "docs": undefined, + "inline": undefined, "properties": { "email": "EmailTypeRequired", "message": { @@ -958,6 +1003,7 @@ "ContractList": "list", "ContractListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "ContractList", "page": "PageInfo", @@ -971,6 +1017,7 @@ "discriminated": false, "docs": "Search form should include parameters varied based on usage of cursor for pagination. NOTE: that all query parameters are based on strings", "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -981,6 +1028,7 @@ }, "ContractSearchFormWithCursor": { "docs": "This is a model to make it easier to understand and restrict search parameters", + "inline": undefined, "properties": { "after_cursor": { "docs": "Return next page of results after given cursor.", @@ -1004,6 +1052,7 @@ }, "ContractSearchFormWithoutCursor": { "docs": "This is a model to make it easier to understand and restrict search parameters", + "inline": undefined, "properties": { "countries": "optional", "currencies": "optional", @@ -1055,6 +1104,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1067,6 +1117,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1079,6 +1130,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1091,6 +1143,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1101,6 +1154,7 @@ }, "ContractSignatureToCreate": { "docs": undefined, + "inline": undefined, "properties": { "client_signature": { "docs": "Signature of client.", @@ -1151,6 +1205,7 @@ "ContractTemplateList": "list", "ContractTemplateListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional", }, @@ -1160,6 +1215,7 @@ }, "ContractTemplateSummary": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "Unique identifier of a contract template", @@ -1176,6 +1232,7 @@ }, "ContractTerminationResult": { "docs": undefined, + "inline": undefined, "properties": { "completion_date": { "docs": "Date the contract is marked for completion", @@ -1192,6 +1249,7 @@ }, "ContractTerminationResultContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "ContractTerminationResult", }, @@ -1203,6 +1261,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -1218,6 +1277,7 @@ "extends": [ "ContractToCreateShared", ], + "inline": undefined, "properties": { "compensation_details": "ContractToCreateOngoingTimeBasedCompensationDetails", "type": "literal<"ongoing_time_based">", @@ -1228,6 +1288,7 @@ }, "ContractToCreateOngoingTimeBasedCompensationDetails": { "docs": undefined, + "inline": true, "properties": { "amount": { "docs": "Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.", @@ -1287,6 +1348,7 @@ "extends": [ "ContractToCreateShared", ], + "inline": undefined, "properties": { "compensation_details": "ContractToCreatePayAsYouGoTimeBasedCompensationDetails", "type": "literal<"pay_as_you_go_time_based">", @@ -1297,6 +1359,7 @@ }, "ContractToCreatePayAsYouGoTimeBasedCompensationDetails": { "docs": undefined, + "inline": true, "properties": { "amount": { "docs": "Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.", @@ -1356,6 +1419,7 @@ "extends": [ "ContractToCreateShared", ], + "inline": undefined, "properties": { "compensation_details": "CompensationDetailsOfContractToCreateShared", "type": "literal<"payg_milestones">", @@ -1369,6 +1433,7 @@ "extends": [ "ContractToCreateShared", ], + "inline": undefined, "properties": { "compensation_details": "CompensationDetailsOfContractToCreateShared", "type": "literal<"payg_tasks">", @@ -1379,6 +1444,7 @@ }, "ContractToCreateShared": { "docs": "Details of contract to create", + "inline": undefined, "properties": { "client": "ContractToCreateSharedClient", "country_code": "optional", @@ -1426,6 +1492,7 @@ }, "ContractToCreateSharedClient": { "docs": undefined, + "inline": true, "properties": { "legal_entity": { "docs": "Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization.", @@ -1442,6 +1509,7 @@ }, "ContractToCreateSharedClientLegalEntity": { "docs": "Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization.", + "inline": true, "properties": { "id": "double", }, @@ -1451,6 +1519,7 @@ }, "ContractToCreateSharedClientTeam": { "docs": "Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization.", + "inline": true, "properties": { "id": "double", }, @@ -1460,6 +1529,7 @@ }, "ContractToCreateSharedJobTitle": { "docs": "Worker's job title. You can enter a custom job title or use a pre-defiled job title using the Id retrieved in job-titles endpoint.", + "inline": true, "properties": { "id": { "docs": "Id of an predefined job title.", @@ -1482,6 +1552,7 @@ }, "ContractToCreateSharedSeniority": { "docs": "Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.", + "inline": true, "properties": { "id": "optional", }, @@ -1491,6 +1562,7 @@ }, "ContractToCreateSharedWorker": { "docs": "Worker properties", + "inline": true, "properties": { "expected_email": "optional", "first_name": { @@ -1520,6 +1592,7 @@ }, "ContractToTerminate": { "docs": undefined, + "inline": undefined, "properties": { "completion_date": "optional", "message": { @@ -1581,6 +1654,7 @@ }, "Contractor": { "docs": undefined, + "inline": undefined, "properties": { "name": { "default": "", @@ -1605,6 +1679,7 @@ }, "Country": { "docs": undefined, + "inline": undefined, "properties": { "code": "CountryCode", "eor_support": { @@ -1659,6 +1734,7 @@ "CountryList": "list", "CountryListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "CountryList", }, @@ -1668,6 +1744,7 @@ }, "CreateTimeoff": { "docs": undefined, + "inline": undefined, "properties": { "end_date": { "docs": "End date of employee's time off.", @@ -1708,6 +1785,7 @@ }, "CreateTimeoffContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "CreateTimeoff", }, @@ -1728,6 +1806,7 @@ }, "Currency": { "docs": undefined, + "inline": undefined, "properties": { "code": "CurrencyCodeRequired", "name": { @@ -1767,6 +1846,7 @@ "CurrencyList": "list", "CurrencyListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "CurrencyList", }, @@ -1834,6 +1914,7 @@ }, "EmployeeList": { "docs": undefined, + "inline": undefined, "properties": { "birth_date": "optional", "client_legal_entity": "optional", @@ -1865,6 +1946,7 @@ }, "EmployeeListClientLegalEntity": { "docs": undefined, + "inline": true, "properties": { "id": "optional", "name": "optional", @@ -1875,6 +1957,7 @@ }, "EmployeeListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "list", }, @@ -1884,6 +1967,7 @@ }, "EmployeeListMonthlyPayment": { "docs": undefined, + "inline": true, "properties": { "count": "optional", }, @@ -1893,6 +1977,7 @@ }, "EmployeeListPaymentsItem": { "docs": undefined, + "inline": true, "properties": { "contract_name": "optional", "currency": "optional", @@ -1905,6 +1990,7 @@ }, "Employment": { "docs": undefined, + "inline": undefined, "properties": { "client_legal_entity": { "docs": "The client legal entity associated with the employment.", @@ -1997,6 +2083,7 @@ }, "EmploymentDetailsOfContract": { "docs": undefined, + "inline": undefined, "properties": { "country": "optional", "days_per_week": "double", @@ -2015,6 +2102,7 @@ }, "EorClientTimeoffRequests": { "docs": undefined, + "inline": undefined, "properties": { "current_approved": { "docs": "Days off approved.", @@ -2048,6 +2136,7 @@ }, "EorClientTimeoffs": { "docs": undefined, + "inline": undefined, "properties": { "employees": { "docs": "List of employee time offs.", @@ -2061,6 +2150,7 @@ }, "EorClientTimeoffsContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "EorClientTimeoffs", }, @@ -2070,6 +2160,7 @@ }, "EorContractCreated": { "docs": undefined, + "inline": undefined, "properties": { "client": "optional", "compensation_details": "optional", @@ -2095,6 +2186,7 @@ }, "EorContractCreatedClient": { "docs": undefined, + "inline": true, "properties": { "legal_entity": "optional", }, @@ -2104,6 +2196,7 @@ }, "EorContractCreatedClientLegalEntity": { "docs": undefined, + "inline": true, "properties": { "name": { "docs": "Legal entity name.", @@ -2116,6 +2209,7 @@ }, "EorContractCreatedCompensationDetails": { "docs": undefined, + "inline": true, "properties": { "currency": { "docs": "Currency of gross annual salary.", @@ -2140,6 +2234,7 @@ }, "EorContractCreatedContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "EorContractCreated", }, @@ -2149,6 +2244,7 @@ }, "EorContractCreatedEmployee": { "docs": undefined, + "inline": true, "properties": { "email": { "docs": "Employee's email.", @@ -2173,6 +2269,7 @@ }, "EorContractCreatedEmployment": { "docs": undefined, + "inline": true, "properties": { "calculated_holidays": { "docs": "Number of calculate holidays for this contract.", @@ -2211,6 +2308,7 @@ }, "EorContractCreatedHealthPlan": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "Health plan ID", @@ -2227,6 +2325,7 @@ }, "EorContractToCreate": { "docs": undefined, + "inline": undefined, "properties": { "client": "EorContractToCreateClient", "compensation_details": "EorContractToCreateCompensationDetails", @@ -2252,6 +2351,7 @@ }, "EorContractToCreateClient": { "docs": undefined, + "inline": true, "properties": { "legal_entity": "optional", "team": "optional", @@ -2262,6 +2362,7 @@ }, "EorContractToCreateClientLegalEntity": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "Enter the Id of legal entity under which you want to hire this person. Use /legal-entities endpoint to retrieve a list of legal entities in your organization.", @@ -2274,6 +2375,7 @@ }, "EorContractToCreateClientTeam": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "Enter the Id of team this person will be hired in. Use /teams endpoint to retrieve a list of teams in your organization.", @@ -2286,6 +2388,7 @@ }, "EorContractToCreateCompensationDetails": { "docs": undefined, + "inline": true, "properties": { "currency": { "docs": "Salary currency.", @@ -2310,6 +2413,7 @@ }, "EorContractToCreateEmployee": { "docs": undefined, + "inline": true, "properties": { "address": "optional", "email": { @@ -2335,6 +2439,7 @@ }, "EorContractToCreateEmployeeAddress": { "docs": undefined, + "inline": true, "properties": { "city": { "docs": "City name.", @@ -2360,6 +2465,7 @@ }, "EorContractToCreateEmployment": { "docs": undefined, + "inline": true, "properties": { "country": "optional", "end_date": "optional", @@ -2426,6 +2532,7 @@ }, "EorContractToCreateQuoteAdditionalFields": { "docs": "Some countries require additional employee information for employment contracts.", + "inline": true, "properties": { "dob": { "docs": "Employee's date of birth.", @@ -2456,6 +2563,7 @@ }, "EorContractToCreateSeniority": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "Enter the Id retrieved from the seniority lookup endpoint. Enter 34 for "Not Applicable".", @@ -2468,6 +2576,7 @@ }, "EorCountryValidations": { "docs": undefined, + "inline": undefined, "properties": { "adjustments_information_box": { "docs": "Country specific notes and information.", @@ -2526,6 +2635,7 @@ }, "EorCountryValidationsContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "EorCountryValidations", }, @@ -2535,6 +2645,7 @@ }, "EorCountryValidationsDefiniteContract": { "docs": "Conditions to make definitive contract.", + "inline": true, "properties": { "maximum_limitation": "optional", "type": "optional", @@ -2555,6 +2666,7 @@ }, "EorCountryValidationsHealthInsurance": { "docs": undefined, + "inline": true, "properties": { "providers": "optional>", "status": "optional", @@ -2565,6 +2677,7 @@ }, "EorCountryValidationsHoliday": { "docs": "Range of the number of holidays.", + "inline": true, "properties": { "min": { "docs": "Minimum number of holidays required for a legally compliant contract.", @@ -2577,6 +2690,7 @@ }, "EorCountryValidationsPartTimeHoliday": { "docs": "Holiday type and range for part-time contracts.", + "inline": true, "properties": { "min": { "docs": "Minimum number of holidays required for a legally compliant contract.", @@ -2600,6 +2714,7 @@ }, "EorCountryValidationsPartTimeProbation": { "docs": "Probation period range for part-time contracts.", + "inline": true, "properties": { "max": { "docs": "Maximum probation days allowed for a legally compliant contract.", @@ -2616,6 +2731,7 @@ }, "EorCountryValidationsProbation": { "docs": "Probation period range.", + "inline": true, "properties": { "max": { "docs": "Maximum probation days allowed for a legally compliant contract.", @@ -2632,6 +2748,7 @@ }, "EorCountryValidationsSalary": { "docs": "Salary range.", + "inline": true, "properties": { "max": { "docs": "Maximum wage allowed for a legally compliant contract.", @@ -2648,6 +2765,7 @@ }, "EorCountryValidationsSickDays": { "docs": undefined, + "inline": true, "properties": { "max": { "docs": "Maximum number of sick days allowed for a legally compliant contract.", @@ -2664,6 +2782,7 @@ }, "EorCountryValidationsWorkSchedule": { "docs": "Employee's Work schedule in days and hours.", + "inline": true, "properties": { "days": "optional", "hours": "optional", @@ -2674,6 +2793,7 @@ }, "EorCountryValidationsWorkScheduleDays": { "docs": undefined, + "inline": true, "properties": { "max": "optional", }, @@ -2683,6 +2803,7 @@ }, "EorCountryValidationsWorkScheduleHours": { "docs": undefined, + "inline": true, "properties": { "max": "optional", }, @@ -2692,6 +2813,7 @@ }, "EorEntitlementListItem": { "docs": "Entitlement Item for a given year.", + "inline": undefined, "properties": { "max_rollover_yearly": "optional", "other_leave_approved": { @@ -2759,6 +2881,7 @@ }, "EorEntitlements": { "docs": "Time-off Entitlements for EOR contracts.", + "inline": undefined, "properties": { "entitlements": { "docs": "List of entitlements.", @@ -2771,6 +2894,7 @@ }, "EorEntitlementsContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "EorEntitlements", }, @@ -2796,6 +2920,7 @@ }, "EorTimeoffsBaseItem": { "docs": undefined, + "inline": undefined, "properties": { "attachments": "optional", "date_is_half_day": { @@ -2870,6 +2995,7 @@ }, "EorTimeoffsContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "EorTimeoffs", }, @@ -2879,6 +3005,7 @@ }, "EorTimeoffsEmployeeItem": { "docs": undefined, + "inline": undefined, "properties": { "contract_id": "string", "eor_contract_id": "double", @@ -2907,6 +3034,7 @@ "extends": [ "EorTimeoffsBaseItem", ], + "inline": undefined, "properties": { "applied_changes": { "docs": "List of changes applied to the time off.", @@ -2937,6 +3065,7 @@ }, "EorTimeoffsItemContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "EorTimeoffsItem", }, @@ -2946,6 +3075,7 @@ }, "EstimateFirstPayment": { "docs": "Details of pro rata payment to create.", + "inline": undefined, "properties": { "compensation_details": "EstimateFirstPaymentCompensationDetails", "country_code": "CountryCode", @@ -2958,6 +3088,7 @@ }, "EstimateFirstPaymentCompensationDetails": { "docs": undefined, + "inline": true, "properties": { "amount": { "docs": "Amount to be paid. Must be a positive number.", @@ -3020,6 +3151,7 @@ }, "ExchangeRates": { "docs": undefined, + "inline": undefined, "properties": { "rates": "optional>", "risk": "optional", @@ -3030,6 +3162,7 @@ }, "FileAttachmentInfo": { "docs": "This object is used for linking file attachments to your records.", + "inline": undefined, "properties": { "filename": { "docs": "Original filename you used to upload using attachments end-point.", @@ -3046,6 +3179,7 @@ }, "FileObject": { "docs": "This is the file you will upload in a multi-part form.", + "inline": undefined, "properties": { "file": { "docs": "Upload the file you want to attach to this entry.", @@ -3092,6 +3226,7 @@ }, "FinalPaymentCalculated": { "docs": undefined, + "inline": undefined, "properties": { "calculation_type": { "docs": "Either works days or calendar days", @@ -3142,6 +3277,7 @@ }, "FinalPaymentCalculatedContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "FinalPaymentCalculated", }, @@ -3151,6 +3287,7 @@ }, "FinalPaymentCalculatedLastCycle": { "docs": "The last payment cycle.", + "inline": true, "properties": { "completion_date": "optional", "end": "optional", @@ -3162,6 +3299,7 @@ }, "FirstPaymentDate": { "docs": "First payment date", + "inline": undefined, "properties": { "due": "optional", }, @@ -3171,6 +3309,7 @@ }, "GenericReportReviewCreated": { "docs": undefined, + "inline": undefined, "properties": { "id": "UniqueObjectIdentifier", "public_id": "optional", @@ -3182,6 +3321,7 @@ }, "GenericReportReviewCreatedContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "GenericReportReviewCreatedList", }, @@ -3192,6 +3332,7 @@ "GenericReportReviewCreatedList": "list", "GenericResultCreated": { "docs": undefined, + "inline": undefined, "properties": { "data": "GenericResultCreatedData", }, @@ -3201,6 +3342,7 @@ }, "GenericResultCreatedData": { "docs": undefined, + "inline": true, "properties": { "created": "boolean", }, @@ -3210,6 +3352,7 @@ }, "GenericResultDeleted": { "docs": undefined, + "inline": undefined, "properties": { "data": "GenericResultDeletedData", }, @@ -3219,6 +3362,7 @@ }, "GenericResultDeletedData": { "docs": undefined, + "inline": true, "properties": { "deleted": { "docs": "Confirms the deletion.", @@ -3231,6 +3375,7 @@ }, "GenericResultUpdated": { "docs": undefined, + "inline": undefined, "properties": { "data": "GenericResultUpdatedData", }, @@ -3240,6 +3385,7 @@ }, "GenericResultUpdatedData": { "docs": undefined, + "inline": true, "properties": { "updated": "boolean", }, @@ -3249,6 +3395,7 @@ }, "HealthInsuranceProvider": { "docs": "Health insurance provider.", + "inline": undefined, "properties": { "attachments": { "docs": "File attachments.", @@ -3300,6 +3447,7 @@ }, "HealthInsuranceProviderAttachmentsItem": { "docs": undefined, + "inline": true, "properties": { "id": "optional", "label": "optional", @@ -3310,6 +3458,7 @@ }, "HealthInsuranceProviderPlansItem": { "docs": undefined, + "inline": true, "properties": { "currency": { "docs": "Insurance payment currency.", @@ -3346,6 +3495,7 @@ }, "HrisCompensation": { "docs": undefined, + "inline": undefined, "properties": { "currency": { "type": "string", @@ -3364,6 +3514,7 @@ }, "HrisContractBase": { "docs": undefined, + "inline": undefined, "properties": { "contract_oid": { "docs": "The Hris Direct employee contract ID", @@ -3382,6 +3533,7 @@ "extends": [ "HrisContractBase", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -3392,6 +3544,7 @@ "extends": [ "HrisContractBase", ], + "inline": undefined, "properties": { "part_time_percentage": { "docs": "required if employmentType is "PART_TIME"", @@ -3411,6 +3564,7 @@ }, "HrisDirectEmployee": { "docs": undefined, + "inline": undefined, "properties": { "compensation": "HrisCompensation", "contract": "HrisDirectEmployeeContract", @@ -3425,6 +3579,7 @@ }, "HrisDirectEmployeeContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "HrisDirectEmployeeResponse", }, @@ -3448,6 +3603,7 @@ }, "HrisDirectEmployeeDetails": { "docs": undefined, + "inline": undefined, "properties": { "country": { "type": "string", @@ -3521,6 +3677,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3534,6 +3691,7 @@ "extends": [ "HrisDirectEmployee", ], + "inline": undefined, "properties": { "id": { "docs": "The Hris Direct employee ID", @@ -3546,6 +3704,7 @@ }, "HrisDirectEmployeeVacationInfo": { "docs": undefined, + "inline": true, "properties": { "vacation_accrual_start_date": { "type": "string", @@ -3573,6 +3732,7 @@ }, "HrisJobInformationBase": { "docs": undefined, + "inline": undefined, "properties": { "seniority_id": "double", }, @@ -3585,6 +3745,7 @@ "extends": [ "HrisJobInformationBase", ], + "inline": undefined, "properties": { "job_title_id": "double", }, @@ -3597,6 +3758,7 @@ "extends": [ "HrisJobInformationBase", ], + "inline": undefined, "properties": { "job_title_name": "string", }, @@ -3606,6 +3768,7 @@ }, "HrisTeamInformation": { "docs": undefined, + "inline": undefined, "properties": { "legal_entity_id": "double", "team_id": "double", @@ -3616,6 +3779,7 @@ }, "InputToDeletePgoTask": { "docs": undefined, + "inline": undefined, "properties": { "data": "PgoTaskToDelete", }, @@ -3625,6 +3789,7 @@ }, "InputToShieldContract": { "docs": undefined, + "inline": undefined, "properties": { "data": "InputToShieldContractData", }, @@ -3634,6 +3799,7 @@ }, "InputToShieldContractData": { "docs": undefined, + "inline": true, "properties": { "agreement_id": { "docs": "MSA contract id (agreement).", @@ -3646,6 +3812,7 @@ }, "InvitationsOfBasicContract": { "docs": undefined, + "inline": undefined, "properties": { "client_email": "optional", "worker_email": "optional", @@ -3656,6 +3823,7 @@ }, "Invoice": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "Billed amount.", @@ -3718,6 +3886,7 @@ "BasicInvoiceAdjustment", "InvoiceAdjustmentApproversContainer", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -3725,6 +3894,7 @@ }, "InvoiceAdjustmentApprover": { "docs": undefined, + "inline": undefined, "properties": { "approved": "boolean", "email": "string", @@ -3737,6 +3907,7 @@ "InvoiceAdjustmentApproverList": "list", "InvoiceAdjustmentApproversContainer": { "docs": undefined, + "inline": undefined, "properties": { "approvers": "InvoiceAdjustmentApproverList", }, @@ -3746,6 +3917,7 @@ }, "InvoiceAdjustmentContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "InvoiceAdjustment", }, @@ -3755,6 +3927,7 @@ }, "InvoiceAdjustmentCreated": { "docs": "Details of invoice adjustment created.", + "inline": undefined, "properties": { "created": "boolean", "created_at": "optional", @@ -3768,6 +3941,7 @@ }, "InvoiceAdjustmentCreatedContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "InvoiceAdjustmentCreated", }, @@ -3778,6 +3952,7 @@ "InvoiceAdjustmentList": "list", "InvoiceAdjustmentListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "InvoiceAdjustmentList", "page": "PageInfoWithoutCursorNew", @@ -3788,6 +3963,7 @@ }, "InvoiceAdjustmentReviewToCreate": { "docs": undefined, + "inline": undefined, "properties": { "reason": "optional", "status": "InvoiceAdjustmentReviewToCreateStatus", @@ -3807,6 +3983,7 @@ }, "InvoiceAdjustmentReviewsToCreate": { "docs": undefined, + "inline": undefined, "properties": { "ids": "TimesheetIdItems", "reason": "optional", @@ -3827,6 +4004,7 @@ }, "InvoiceAdjustmentSearchContainer": { "docs": "This is a model to make it easier to understand and restrict search parameters", + "inline": undefined, "properties": { "contract_id": "optional", "contract_types": "optional", @@ -3883,6 +4061,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3895,6 +4074,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3907,6 +4087,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3922,6 +4103,7 @@ "InvoiceAdjustmentStatusEnumList": "list>", "InvoiceAdjustmentToCreate": { "docs": "Details of invoice adjustment to create.", + "inline": undefined, "properties": { "amount": { "docs": "Amount to be paid. Must be a positive number.", @@ -3959,6 +4141,7 @@ "InvoiceAdjustmentToCreate", "FileObject", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -3966,6 +4149,7 @@ }, "InvoiceAdjustmentToUpdate": { "docs": "Details of invoice adjustment to update.", + "inline": undefined, "properties": { "amount": { "type": "optional", @@ -4042,6 +4226,7 @@ }, "InvoiceContract": { "docs": undefined, + "inline": undefined, "properties": { "contract_type": { "docs": "Type of Deel contract.", @@ -4077,6 +4262,7 @@ }, "InvoiceDownloadContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "InvoiceDownloadObject", }, @@ -4086,6 +4272,7 @@ }, "InvoiceDownloadObject": { "docs": undefined, + "inline": undefined, "properties": { "expires_at": { "docs": "Expiration date time of download URL.", @@ -4107,6 +4294,7 @@ "InvoiceList": "list", "InvoiceListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "InvoiceObject", }, @@ -4116,6 +4304,7 @@ }, "InvoiceObject": { "docs": undefined, + "inline": undefined, "properties": { "rows": "optional", "total": "optional", @@ -4165,6 +4354,7 @@ }, "JobTitle": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "Unique identifier for the job title in Deel platform.", @@ -4182,6 +4372,7 @@ "JobTitleList": "list", "JobTitleListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "JobTitleList", "page": "JobTitleListContainerPage", @@ -4192,6 +4383,7 @@ }, "JobTitleListContainerPage": { "docs": undefined, + "inline": true, "properties": { "cursor": { "docs": "Use for pagination to get next set of records after the given cursor.", @@ -4206,6 +4398,7 @@ "LegalEntityList": "list", "LegalEntityListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional", }, @@ -4225,6 +4418,7 @@ }, "MetaDataOfContractToCreate": { "docs": "Additional custom info about a contract", + "inline": undefined, "properties": { "documents_required": { "docs": "Require the contractor to upload necessary compliance documents as per their country’s labor laws.", @@ -4238,6 +4432,7 @@ }, "Milestone": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "Amount to be paid for the milestone.", @@ -4279,6 +4474,7 @@ }, "MilestoneContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "Milestone", }, @@ -4289,6 +4485,7 @@ "MilestoneList": "list", "MilestoneListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "MilestoneList", }, @@ -4298,6 +4495,7 @@ }, "MilestoneProperties": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "Amount to be paid for the milestone.", @@ -4318,6 +4516,7 @@ }, "MilestoneReportedBy": { "docs": "Milestone creator.", + "inline": true, "properties": { "full_name": { "docs": "Reporter's full name.", @@ -4334,6 +4533,7 @@ }, "MilestoneReviewToCreate": { "docs": undefined, + "inline": undefined, "properties": { "reason": "optional", "status": "MilestoneReviewToCreateStatus", @@ -4353,6 +4553,7 @@ }, "MilestoneReviewedBy": { "docs": "Reviewer's information.", + "inline": true, "properties": { "full_name": { "docs": "Reviewer's full name.", @@ -4369,6 +4570,7 @@ }, "MilestoneReviewsToCreate": { "docs": undefined, + "inline": undefined, "properties": { "ids": "list", "reason": "optional", @@ -4394,6 +4596,7 @@ "MilestoneProperties", "FileObject", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4401,6 +4604,7 @@ }, "MonthlyPayment": { "docs": "Monthly payment details for the user", + "inline": undefined, "properties": { "count": { "docs": "The number of monthly payments", @@ -4506,6 +4710,7 @@ }, "OffCyclePayment": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "Amount of off-cycle payment.", @@ -4530,6 +4735,7 @@ }, "OffCyclePaymentContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "OffCyclePayment", }, @@ -4540,6 +4746,7 @@ "OffCyclePaymentList": "list", "OffCyclePaymentListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "OffCyclePaymentList", }, @@ -4549,6 +4756,7 @@ }, "OffCyclePaymentReportedBy": { "docs": undefined, + "inline": true, "properties": { "full_name": { "docs": "Full name of the creator.", @@ -4565,6 +4773,7 @@ }, "OffCyclePaymentReviewedBy": { "docs": undefined, + "inline": true, "properties": { "full_name": { "docs": "Full name of the reviewer.", @@ -4589,6 +4798,7 @@ }, "OffCyclePaymentToCreate": { "docs": "Details of invoice adjustment to create.", + "inline": undefined, "properties": { "amount": { "docs": "Amount to be paid. Must be a positive number.", @@ -4618,6 +4828,7 @@ "OrganizationList": "list", "OrganizationListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "OrganizationList", }, @@ -4627,6 +4838,7 @@ }, "OutputToCreateFileRef": { "docs": undefined, + "inline": undefined, "properties": { "key": "string", "url": "string", @@ -4637,6 +4849,7 @@ }, "OutputToCreateFileRefContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "OutputToCreateFileRef", }, @@ -4646,6 +4859,7 @@ }, "PageInfo": { "docs": undefined, + "inline": undefined, "properties": { "cursor": "string", "total_rows": "double", @@ -4656,6 +4870,7 @@ }, "PageInfoWithoutCursor": { "docs": undefined, + "inline": undefined, "properties": { "total_rows": "double", }, @@ -4665,6 +4880,7 @@ }, "PageInfoWithoutCursorNew": { "docs": undefined, + "inline": undefined, "properties": { "items_per_page": { "type": "double", @@ -4694,6 +4910,7 @@ }, "Payment": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Timestamp when the record was created.", @@ -4723,6 +4940,7 @@ }, "PaymentBreakDown": { "docs": undefined, + "inline": undefined, "properties": { "adjustment": "optional", "approve_date": "optional", @@ -4789,6 +5007,7 @@ }, "PaymentBreakDownContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "list", }, @@ -4799,6 +5018,7 @@ "PaymentList": "list", "PaymentListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "PaymentObject", }, @@ -4808,6 +5028,7 @@ }, "PaymentMethod": { "docs": undefined, + "inline": undefined, "properties": { "type": "PaymentMethodEnum", }, @@ -4843,6 +5064,7 @@ }, "PaymentObject": { "docs": undefined, + "inline": undefined, "properties": { "rows": "optional", "total": "optional", @@ -4853,6 +5075,7 @@ }, "PaymentStatementInitiatedWebhook": { "docs": undefined, + "inline": undefined, "properties": { "billing_invoices": "list", "invoices": "list", @@ -4874,6 +5097,7 @@ "PaymentStatusEnumList": "list", "PaymentWorker": { "docs": undefined, + "inline": undefined, "properties": { "contract_id": { "docs": "The worker's Deel contract Id.", @@ -4896,6 +5120,7 @@ "PaymentWorkerList": "list", "People": { "docs": "People object representing a Deel", + "inline": undefined, "properties": { "birth_date": { "docs": "Date of birth of the user in ISO format (yyyy-mm-dd)", @@ -5036,6 +5261,7 @@ }, "PeopleClientLegalEntity": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The unique identifier for the client legal entity.", @@ -5052,6 +5278,7 @@ }, "PeopleContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "list", }, @@ -5061,6 +5288,7 @@ }, "PeopleMe": { "docs": "People object representing a Deel", + "inline": undefined, "properties": { "avatar_url": { "docs": "URL of the user's avatar", @@ -5125,6 +5353,7 @@ "PeopleMeContainer": "PeopleMe", "PeoplePayment": { "docs": undefined, + "inline": undefined, "properties": { "contract_name": { "docs": "The name of the contract associated with the payment", @@ -5149,6 +5378,7 @@ }, "PgoTask": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "Fixed rate for this task.", @@ -5172,6 +5402,7 @@ }, "PgoTaskReviewsByIdToCreate": { "docs": undefined, + "inline": undefined, "properties": { "reason": { "docs": "Review comments.", @@ -5198,6 +5429,7 @@ }, "PgoTaskReviewsToCreate": { "docs": undefined, + "inline": undefined, "properties": { "ids": "list", "reason": { @@ -5225,6 +5457,7 @@ }, "PgoTaskToCreate": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "Fixed rate for this task.", @@ -5249,6 +5482,7 @@ }, "PgoTaskToDelete": { "docs": undefined, + "inline": undefined, "properties": { "delete_recurring_report": { "docs": "Request to delete recurring report.", @@ -5265,6 +5499,7 @@ }, "PremiumResultAdded": { "docs": undefined, + "inline": undefined, "properties": { "calculated_premium": { "docs": "Cost for Deel Premium.", @@ -5284,6 +5519,7 @@ }, "PremiumResultAddedContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "PremiumResultAdded", }, @@ -5293,6 +5529,7 @@ }, "PremiumResultAddedMisclassificationGuarantee": { "docs": undefined, + "inline": true, "properties": { "description": { "docs": "Cover your legal defense costs.", @@ -5309,6 +5546,7 @@ }, "PremiumResultAddedPenalties": { "docs": undefined, + "inline": true, "properties": { "description": { "docs": "Get indemnity against tax authority penalties, liabilities and fines.", @@ -5325,6 +5563,7 @@ }, "PremiumResultAddedThirdPartyLiabilities": { "docs": undefined, + "inline": true, "properties": { "description": { "docs": "Get indemnity against third parties up to $10k depending on the court's decision.", @@ -5341,6 +5580,7 @@ }, "PremiumToAdd": { "docs": undefined, + "inline": undefined, "properties": { "agreement_reflects_relation": { "docs": "Is the Contractor Agreement selected on the Deel Platform perfectly reflecting your organizations relation and actual working practices with the contractor?", @@ -5357,6 +5597,7 @@ }, "ProRata": { "docs": "Details of the pro rata for the first payment", + "inline": undefined, "properties": { "calculation_type": { "docs": "Either works days or calendar days", @@ -5446,6 +5687,7 @@ }, "ResponseEstimateFirstPayment": { "docs": undefined, + "inline": undefined, "properties": { "first_payment_dates": "optional>", "pro_rata": "optional", @@ -5456,6 +5698,7 @@ }, "ResponseEstimateFirstPaymentContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "ResponseEstimateFirstPayment", }, @@ -5465,6 +5708,7 @@ }, "Seniority": { "docs": "Seniority describes level of expertise at a job e.g. junior", + "inline": undefined, "properties": { "id": { "docs": "Unique identifier for seniority record", @@ -5492,6 +5736,7 @@ "SeniorityList": "list", "SeniorityListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "SeniorityList", }, @@ -5501,6 +5746,7 @@ }, "SeniorityRequired": { "docs": "Seniority describes level of expertise at a job e.g. junior", + "inline": undefined, "properties": { "id": { "docs": "Unique identifier for seniority record.", @@ -5527,6 +5773,7 @@ }, "SignaturesOfBasicContract": { "docs": undefined, + "inline": undefined, "properties": { "client_signed_at": "optional", "worker_signature": { @@ -5541,6 +5788,7 @@ }, "SignaturesOfContract": { "docs": undefined, + "inline": undefined, "properties": { "client_signature": { "docs": "normally name of client is used as signature", @@ -5569,6 +5817,7 @@ }, "StateOfCountry": { "docs": "It may be called states, provinces, prefectures or regions, or none at all", + "inline": undefined, "properties": { "code": { "docs": "Territory code.", @@ -5598,6 +5847,7 @@ "TaskList": "list", "TaskListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "TaskList", }, @@ -5607,6 +5857,7 @@ }, "Team": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The unique identifier for the team.", @@ -5624,6 +5875,7 @@ "TeamList": "list", "TeamListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "TeamList", }, @@ -5633,6 +5885,7 @@ }, "TeamOfBasicContract": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "Unique reference of a team", @@ -5649,6 +5902,7 @@ }, "TeamOfContract": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "Unique reference of a team", @@ -5665,6 +5919,7 @@ }, "TimeoffReview": { "docs": undefined, + "inline": undefined, "properties": { "denial_reason": { "docs": "Denial reason for the time off requested.", @@ -5682,6 +5937,7 @@ "TimeoffTypeList": "list", "TimeoffTypeListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "TimeoffTypeList", }, @@ -5695,6 +5951,7 @@ }, "TimeoffsAttachmentsItem": { "docs": "A item in attachments array. 2022-09-08 FE only allows for "SICK LEAVE"", + "inline": undefined, "properties": { "file_extension": { "docs": "The file name extension", @@ -5712,6 +5969,7 @@ }, "TimeoffsProfile": { "docs": undefined, + "inline": undefined, "properties": { "id": "double", "is_employee": { @@ -5755,6 +6013,7 @@ "BasicTimesheet", "TimesheetApproversContainer", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -5763,6 +6022,7 @@ "TimesheetAccountingRefs": "optional>", "TimesheetAccountingRefsItem": { "docs": undefined, + "inline": undefined, "properties": { "integration": "string", "mapping_category": "optional", @@ -5773,6 +6033,7 @@ }, "TimesheetAccountingRefsItemMappingCategory": { "docs": undefined, + "inline": true, "properties": { "id": "string", "name": "string", @@ -5783,6 +6044,7 @@ }, "TimesheetApprover": { "docs": undefined, + "inline": undefined, "properties": { "approved": "boolean", "email": "string", @@ -5795,6 +6057,7 @@ "TimesheetApproverList": "list", "TimesheetApproversContainer": { "docs": undefined, + "inline": undefined, "properties": { "approvers": "TimesheetApproverList", }, @@ -5804,6 +6067,7 @@ }, "TimesheetContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "Timesheet", }, @@ -5816,6 +6080,7 @@ "discriminated": false, "docs": "ID of an existing timesheet record", "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -5827,6 +6092,7 @@ "TimesheetList": "list", "TimesheetListContainer": { "docs": undefined, + "inline": undefined, "properties": { "data": "TimesheetList", "page": "PageInfoWithoutCursor", @@ -5837,6 +6103,7 @@ }, "TimesheetReviewToCreate": { "docs": undefined, + "inline": undefined, "properties": { "reason": "optional", "status": "TimesheetReviewToCreateStatus", @@ -5856,6 +6123,7 @@ }, "TimesheetReviewsToCreate": { "docs": undefined, + "inline": undefined, "properties": { "ids": "TimesheetIdItems", "reason": "optional", @@ -5876,6 +6144,7 @@ }, "TimesheetSearchContainer": { "docs": "This is a model to make it easier to understand and restrict search parameters", + "inline": undefined, "properties": { "contract_id": "optional", "contract_types": "optional", @@ -5932,6 +6201,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -5944,6 +6214,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -5956,6 +6227,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -5966,6 +6238,7 @@ }, "TimesheetSharedProperties": { "docs": "Details of timesheet to create; a client, contractor or EOR may create a timesheet", + "inline": undefined, "properties": { "contract_id": { "docs": "Id of a Deel contract.", @@ -5998,6 +6271,7 @@ "TimesheetSharedProperties", "FileObject", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -6005,6 +6279,7 @@ }, "TimesheetToUpdate": { "docs": "Details of timesheet to create; a client, contractor or EOR may update a timesheet", + "inline": undefined, "properties": { "description": "string", "quantity": "double", @@ -6022,6 +6297,7 @@ "discriminated": false, "docs": "Unique identifier of this resource.", "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -6050,6 +6326,7 @@ }, "WebhookItem": { "docs": undefined, + "inline": undefined, "properties": { "api_version": { "default": "v1", @@ -6103,6 +6380,7 @@ }, "WebhookItemResponse": { "docs": undefined, + "inline": undefined, "properties": { "data": "WebhookItem", }, @@ -6122,6 +6400,7 @@ }, "WebhookListResponse": { "docs": undefined, + "inline": undefined, "properties": { "data": "list", }, @@ -6224,6 +6503,7 @@ }, "WorkerLegalEntity": { "docs": undefined, + "inline": undefined, "properties": { "personal_name": "string", "registration_number": "string", @@ -6235,6 +6515,7 @@ }, "WorkerOfBasicContract": { "docs": undefined, + "inline": undefined, "properties": { "alternate_email": "optional", "email": "optional", @@ -6256,6 +6537,7 @@ }, "WorkerOfContract": { "docs": undefined, + "inline": undefined, "properties": { "alternate_email": "optional", "date_of_birth": "optional", @@ -6448,6 +6730,7 @@ - ContractTypeEnumList source: openapi: ../openapi.yml + inline: true ContractSearchFormWithoutCursorStatuses: discriminated: false union: @@ -6455,6 +6738,7 @@ - ContractStatusEnum source: openapi: ../openapi.yml + inline: true ContractSearchFormWithoutCursorCountries: discriminated: false union: @@ -6462,6 +6746,7 @@ - CountryCode source: openapi: ../openapi.yml + inline: true ContractSearchFormWithoutCursorCurrencies: discriminated: false union: @@ -6469,6 +6754,7 @@ - CurrencyCodeRequired source: openapi: ../openapi.yml + inline: true ContractSearchFormWithoutCursor: docs: >- This is a model to make it easier to understand and restrict search @@ -6875,6 +7161,7 @@ scale: WorkStatementScaleEnum source: openapi: ../openapi.yml + inline: true ContractToCreatePayAsYouGoTimeBased: properties: type: literal<"pay_as_you_go_time_based"> @@ -6935,6 +7222,7 @@ scale: WorkStatementScaleEnum source: openapi: ../openapi.yml + inline: true ContractToCreateOngoingTimeBased: properties: type: literal<"ongoing_time_based"> @@ -6951,6 +7239,7 @@ id: double source: openapi: ../openapi.yml + inline: true ContractToCreateSharedClientTeam: docs: >- Choose the Deel team for this contract. Use teams endpoint to retrieve a @@ -6959,6 +7248,7 @@ id: double source: openapi: ../openapi.yml + inline: true ContractToCreateSharedClient: properties: legal_entity: @@ -6973,6 +7263,7 @@ a list of teams in your organization. source: openapi: ../openapi.yml + inline: true ContractToCreateSharedJobTitle: docs: >- Worker's job title. You can enter a custom job title or use a pre-defiled @@ -6988,6 +7279,7 @@ maxLength: 255 source: openapi: ../openapi.yml + inline: true ContractToCreateSharedSeniority: docs: >- Job seniority level. Please use the seniority levels endpoint to retrieve @@ -6996,6 +7288,7 @@ id: optional source: openapi: ../openapi.yml + inline: true ContractToCreateSharedWorker: docs: Worker properties properties: @@ -7012,6 +7305,7 @@ maxLength: 255 source: openapi: ../openapi.yml + inline: true ContractToCreateShared: docs: Details of contract to create properties: @@ -7279,6 +7573,7 @@ min: 0 source: openapi: ../openapi.yml + inline: true BasicTimesheetReviewedBy: properties: id: double @@ -7287,6 +7582,7 @@ remarks: string source: openapi: ../openapi.yml + inline: true BasicTimesheetContract: properties: id: string @@ -7294,18 +7590,21 @@ type: ContractTypeEnum source: openapi: ../openapi.yml + inline: true BasicTimesheetPaymentCycle: properties: start_date: optional end_date: optional source: openapi: ../openapi.yml + inline: true BasicTimesheetReportedBy: properties: id: double full_name: string source: openapi: ../openapi.yml + inline: true BasicTimesheet: properties: id: UniqueObjectIdentifier @@ -7476,6 +7775,7 @@ - ContractTypeEnum source: openapi: ../openapi.yml + inline: true TimesheetSearchContainerTypes: discriminated: false union: @@ -7483,6 +7783,7 @@ - TimesheetTypeEnum source: openapi: ../openapi.yml + inline: true TimesheetSearchContainerStatuses: discriminated: false union: @@ -7490,6 +7791,7 @@ - optional source: openapi: ../openapi.yml + inline: true TimesheetSearchContainer: docs: >- This is a model to make it easier to understand and restrict search @@ -7533,6 +7835,7 @@ name: string source: openapi: ../openapi.yml + inline: true TimesheetAccountingRefsItem: properties: integration: string @@ -7547,6 +7850,7 @@ - ContractTypeEnum source: openapi: ../openapi.yml + inline: true InvoiceAdjustmentSearchContainerTypes: discriminated: false union: @@ -7554,6 +7858,7 @@ - InvoiceAdjustmentTypeEnum source: openapi: ../openapi.yml + inline: true InvoiceAdjustmentSearchContainerStatuses: discriminated: false union: @@ -7561,6 +7866,7 @@ - optional source: openapi: ../openapi.yml + inline: true InvoiceAdjustmentSearchContainer: docs: >- This is a model to make it easier to understand and restrict search @@ -7625,6 +7931,7 @@ min: 0 source: openapi: ../openapi.yml + inline: true BasicInvoiceAdjustmentReviewedBy: properties: id: double @@ -7633,6 +7940,7 @@ remarks: string source: openapi: ../openapi.yml + inline: true BasicInvoiceAdjustmentContract: properties: id: string @@ -7640,18 +7948,21 @@ type: ContractTypeEnum source: openapi: ../openapi.yml + inline: true BasicInvoiceAdjustmentPaymentCycle: properties: start_date: optional end_date: optional source: openapi: ../openapi.yml + inline: true BasicInvoiceAdjustmentReportedBy: properties: id: double full_name: string source: openapi: ../openapi.yml + inline: true BasicInvoiceAdjustment: properties: id: UniqueObjectIdentifier @@ -7791,6 +8102,7 @@ created: boolean source: openapi: ../openapi.yml + inline: true GenericResultCreated: properties: data: GenericResultCreatedData @@ -7807,6 +8119,7 @@ updated: boolean source: openapi: ../openapi.yml + inline: true GenericResultUpdated: properties: data: GenericResultUpdatedData @@ -7819,6 +8132,7 @@ docs: Confirms the deletion. source: openapi: ../openapi.yml + inline: true GenericResultDeleted: properties: data: GenericResultDeletedData @@ -8083,6 +8397,7 @@ docs: Use for pagination to get next set of records after the given cursor. source: openapi: ../openapi.yml + inline: true JobTitleListContainer: properties: data: JobTitleList @@ -8307,6 +8622,7 @@ docs: Reviewer's full name. source: openapi: ../openapi.yml + inline: true MilestoneReportedBy: docs: Milestone creator. properties: @@ -8318,6 +8634,7 @@ docs: Reporter's full name. source: openapi: ../openapi.yml + inline: true Milestone: properties: id: @@ -8431,6 +8748,7 @@ work_week_end: optional source: openapi: ../openapi.yml + inline: true EstimateFirstPayment: docs: Details of pro rata payment to create. properties: @@ -8509,6 +8827,7 @@ docs: Remarks made during review process. source: openapi: ../openapi.yml + inline: true OffCyclePaymentReportedBy: properties: id: @@ -8519,6 +8838,7 @@ docs: Full name of the creator. source: openapi: ../openapi.yml + inline: true OffCyclePayment: properties: id: UniqueObjectIdentifier @@ -8677,18 +8997,21 @@ title: string source: openapi: ../openapi.yml + inline: true AgreementClientLegalEntity: properties: id: double name: string source: openapi: ../openapi.yml + inline: true AgreementProviderLegalEntity: properties: id: double name: string source: openapi: ../openapi.yml + inline: true Agreement: properties: id: double @@ -8706,6 +9029,7 @@ docs: MSA contract id (agreement). source: openapi: ../openapi.yml + inline: true InputToShieldContract: properties: data: InputToShieldContractData @@ -8768,6 +9092,7 @@ completion_date: optional source: openapi: ../openapi.yml + inline: true FinalPaymentCalculatedCalculationType: enum: - CUSTOM_AMOUNT @@ -8814,6 +9139,7 @@ docs: Cover your legal defense costs. source: openapi: ../openapi.yml + inline: true PremiumResultAddedPenalties: properties: name: @@ -8824,6 +9150,7 @@ docs: Get indemnity against tax authority penalties, liabilities and fines. source: openapi: ../openapi.yml + inline: true PremiumResultAddedThirdPartyLiabilities: properties: name: @@ -8836,6 +9163,7 @@ court's decision. source: openapi: ../openapi.yml + inline: true PremiumResultAdded: properties: id: @@ -9001,6 +9329,7 @@ country: optional source: openapi: ../openapi.yml + inline: true EorContractToCreateEmployee: properties: first_name: @@ -9018,6 +9347,7 @@ address: optional source: openapi: ../openapi.yml + inline: true EorContractToCreateEmploymentType: enum: - value: Full-time @@ -9073,6 +9403,7 @@ chooseing "STANDARD" time_off_type. source: openapi: ../openapi.yml + inline: true EorContractToCreateSeniority: properties: id: @@ -9082,6 +9413,7 @@ for "Not Applicable". source: openapi: ../openapi.yml + inline: true EorContractToCreateClientLegalEntity: properties: id: @@ -9092,6 +9424,7 @@ your organization. source: openapi: ../openapi.yml + inline: true EorContractToCreateClientTeam: properties: id: @@ -9101,12 +9434,14 @@ to retrieve a list of teams in your organization. source: openapi: ../openapi.yml + inline: true EorContractToCreateClient: properties: legal_entity: optional team: optional source: openapi: ../openapi.yml + inline: true EorContractToCreateCompensationDetails: properties: salary: @@ -9127,6 +9462,7 @@ PERCENTAGE or FIXED. source: openapi: ../openapi.yml + inline: true EorContractToCreateQuoteAdditionalFieldsWorkerType: enum: - Skilled @@ -9150,6 +9486,7 @@ docs: Employee's date of birth. source: openapi: ../openapi.yml + inline: true EorContractToCreate: properties: employee: optional @@ -9204,6 +9541,7 @@ docs: Number of calculate holidays for this contract. source: openapi: ../openapi.yml + inline: true EorContractCreatedClientLegalEntity: properties: name: @@ -9211,11 +9549,13 @@ docs: Legal entity name. source: openapi: ../openapi.yml + inline: true EorContractCreatedClient: properties: legal_entity: optional source: openapi: ../openapi.yml + inline: true EorContractCreatedCompensationDetails: properties: salary: @@ -9232,6 +9572,7 @@ docs: Type fo variable compensation. source: openapi: ../openapi.yml + inline: true EorContractCreatedEmployee: properties: legal_name: @@ -9248,6 +9589,7 @@ docs: Employee's email. source: openapi: ../openapi.yml + inline: true EorContractCreatedHealthPlan: properties: id: @@ -9258,6 +9600,7 @@ docs: Health plan name source: openapi: ../openapi.yml + inline: true EorContractCreated: properties: id: @@ -9285,6 +9628,7 @@ docs: Minimum number of holidays required for a legally compliant contract. source: openapi: ../openapi.yml + inline: true EorCountryValidationsPartTimeHolidayType: enum: - PRORATED @@ -9301,6 +9645,7 @@ docs: Minimum number of holidays required for a legally compliant contract. source: openapi: ../openapi.yml + inline: true EorCountryValidationsSickDays: properties: min: @@ -9311,6 +9656,7 @@ docs: Maximum number of sick days allowed for a legally compliant contract. source: openapi: ../openapi.yml + inline: true EorCountryValidationsSalary: docs: Salary range. properties: @@ -9322,6 +9668,7 @@ docs: Maximum wage allowed for a legally compliant contract. source: openapi: ../openapi.yml + inline: true EorCountryValidationsProbation: docs: Probation period range. properties: @@ -9333,6 +9680,7 @@ docs: Maximum probation days allowed for a legally compliant contract. source: openapi: ../openapi.yml + inline: true EorCountryValidationsPartTimeProbation: docs: Probation period range for part-time contracts. properties: @@ -9344,16 +9692,19 @@ docs: Maximum probation days allowed for a legally compliant contract. source: openapi: ../openapi.yml + inline: true EorCountryValidationsWorkScheduleDays: properties: max: optional source: openapi: ../openapi.yml + inline: true EorCountryValidationsWorkScheduleHours: properties: max: optional source: openapi: ../openapi.yml + inline: true EorCountryValidationsWorkSchedule: docs: Employee's Work schedule in days and hours. properties: @@ -9361,6 +9712,7 @@ hours: optional source: openapi: ../openapi.yml + inline: true EorCountryValidationsDefiniteContractType: enum: - ALLOWED_WITHOUT_LIMITATION @@ -9375,12 +9727,14 @@ maximum_limitation: optional source: openapi: ../openapi.yml + inline: true EorCountryValidationsHealthInsurance: properties: status: optional providers: optional> source: openapi: ../openapi.yml + inline: true EorCountryValidations: properties: holiday: @@ -9432,6 +9786,7 @@ label: optional source: openapi: ../openapi.yml + inline: true HealthInsuranceProviderPlansItem: properties: id: @@ -9449,6 +9804,7 @@ is_enabled: optional source: openapi: ../openapi.yml + inline: true HealthInsuranceProvider: docs: Health insurance provider. properties: @@ -9766,17 +10122,20 @@ contract_name: optional source: openapi: ../openapi.yml + inline: true EmployeeListClientLegalEntity: properties: id: optional name: optional source: openapi: ../openapi.yml + inline: true EmployeeListMonthlyPayment: properties: count: optional source: openapi: ../openapi.yml + inline: true EmployeeList: properties: id: optional @@ -10178,6 +10537,7 @@ - HrisJobInformationTitleName source: openapi: ../openapi.yml + inline: true HrisDirectEmployeeContract: discriminant: employment_type base-properties: {} @@ -10199,6 +10559,7 @@ max: 365 source: openapi: ../openapi.yml + inline: true HrisDirectEmployee: properties: employee_details: HrisDirectEmployeeDetails @@ -11224,6 +11585,7 @@ docs: End-points to retrieve paid invoices and reciepts. "types": { "InputToCreateFileRefData": { "docs": undefined, + "inline": true, "properties": { "content_type": "root.FileRefTypeEnum", }, @@ -11241,6 +11603,7 @@ types: content_type: root.FileRefTypeEnum source: openapi: ../openapi.yml + inline: true service: auth: false base-path: '' diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/default-content.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/default-content.json index 1954cba0fbe..4368af83af9 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/default-content.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/default-content.json @@ -8,6 +8,7 @@ "types": { "GenerateContentResponse": { "docs": undefined, + "inline": undefined, "properties": { "bar": "optional", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/devrev.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/devrev.json index eb425cf5e35..5d4a3ddaf8a 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/devrev.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/devrev.json @@ -97,6 +97,7 @@ }, "ArtifactsLocateResponse": { "docs": "The response to getting an artifact's download URL.", + "inline": undefined, "properties": { "expires_at": { "docs": "The expiration timestamp of the URL.", @@ -113,6 +114,7 @@ }, "ArtifactsPrepareResponse": { "docs": "The response to preparing a URL to upload a file.", + "inline": undefined, "properties": { "form_data": { "docs": "The POST policy form data.", @@ -133,6 +135,7 @@ }, "ArtifactsPrepareResponseFormData": { "docs": undefined, + "inline": undefined, "properties": { "key": { "docs": "Key of the form field.", @@ -149,6 +152,7 @@ }, "AtomBase": { "docs": undefined, + "inline": undefined, "properties": { "created_by": { "type": "optional", @@ -179,6 +183,7 @@ }, "AtomBaseSummary": { "docs": undefined, + "inline": undefined, "properties": { "display_id": { "docs": "Human-readable object ID unique to the Dev organization.", @@ -246,6 +251,7 @@ authentication connection that is set up for a Dev organization. "docs": "Object encapsulating the configuration parameters for an Azure AD authentication connection. ", + "inline": undefined, "properties": { "client_id": { "docs": "Client ID for the Azure authentication connection.", @@ -268,6 +274,7 @@ authentication connection. "docs": "Object encapsulating the configuration parameters for a Google Apps authentication connection. ", + "inline": undefined, "properties": { "client_id": { "docs": "Client ID for the Google Apps authentication connection.", @@ -292,6 +299,7 @@ authentication connection. "docs": "Object encapsulating the configuration parameters for an OIDC authentication connection. ", + "inline": undefined, "properties": { "client_id": { "docs": "Client ID for the OIDC authentication connection.", @@ -314,6 +322,7 @@ authentication connection. "docs": "Object encapsulating the configuration parameters for a SAML authentication connection. ", + "inline": undefined, "properties": { "sign_in_endpoint": { "docs": "Sign In endpoint for the SAML authentication connection.", @@ -361,6 +370,7 @@ for each authentication connection will depend on the type value. "extends": [ "AtomBase", ], + "inline": undefined, "properties": { "client_id": { "docs": "An identifier that represents the application that requested the @@ -511,6 +521,7 @@ token. Only applicable for application access tokens. "docs": "Response for the request to create a new token corresponding to the requested token type. ", + "inline": undefined, "properties": { "access_token": { "docs": "The issued JSON Web Token (JWT) corresponding to the requested @@ -549,6 +560,7 @@ of values in which the order of values does not matter. }, "AuthTokensGetResponse": { "docs": "The response to get the token metadata.", + "inline": undefined, "properties": { "token": { "type": "AuthToken", @@ -560,6 +572,7 @@ of values in which the order of values does not matter. }, "AuthTokensListResponse": { "docs": "The response to list the token metadata.", + "inline": undefined, "properties": { "tokens": { "docs": "The list of token metadata.", @@ -572,6 +585,7 @@ of values in which the order of values does not matter. }, "AuthTokensOrgTraits": { "docs": "Carries Rev org info.", + "inline": undefined, "properties": { "display_name": { "docs": "The display name of the Rev org.", @@ -590,6 +604,7 @@ of values in which the order of values does not matter. "docs": "Carries info corresponding to the Rev user to be provisioned and/or issue a Rev session token. ", + "inline": undefined, "properties": { "org_ref": { "docs": "An identifier which uniquely identifies a Rev org.", @@ -616,6 +631,7 @@ issue a Rev session token. }, "AuthTokensUpdateResponse": { "docs": "Response for the request to update the token metadata.", + "inline": undefined, "properties": { "token": { "type": "AuthToken", @@ -627,6 +643,7 @@ issue a Rev session token. }, "AuthTokensUserTraits": { "docs": "Carries Rev user info.", + "inline": undefined, "properties": { "display_name": { "docs": "The display name of the Rev user.", @@ -703,6 +720,7 @@ authentication connections have different configuration parameters. "docs": "Response for the request to create a new enterprise authentication connection. ", + "inline": undefined, "properties": { "auth_connection": { "type": "AuthConnection", @@ -716,6 +734,7 @@ connection. "docs": "Response object encapsulating the configuration details of an authentication connection. ", + "inline": undefined, "properties": { "auth_connection": { "type": "AuthConnection", @@ -729,6 +748,7 @@ authentication connection. "docs": "Response object for the request to list all the social and enterprise authentication connections configured for a Dev organization. ", + "inline": undefined, "properties": { "auth_connections": { "docs": "List of all the authentication connections currently configured for @@ -804,6 +824,7 @@ that can be updated. "docs": "Response for the request to update an enterprise authentication connection. ", + "inline": undefined, "properties": { "auth_connection": { "type": "AuthConnection", @@ -818,6 +839,7 @@ connection. "extends": [ "UserBase", ], + "inline": undefined, "properties": { "external_identities": { "docs": "IDs of the Dev User outside the DevRev SOR.", @@ -833,6 +855,7 @@ connection. }, "DevUsersListResponse": { "docs": "The response to listing the Dev users.", + "inline": undefined, "properties": { "dev_users": { "docs": "The list of Dev users.", @@ -858,6 +881,7 @@ sort order. If not set, then no prior elements exist. "DevUsersSelfResponse": { "docs": "The response to getting the information for the authenticated user. ", + "inline": undefined, "properties": { "dev_user": { "type": "DevUser", @@ -875,6 +899,7 @@ sort order. If not set, then no prior elements exist. "extends": [ "ErrorBase", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -885,6 +910,7 @@ sort order. If not set, then no prior elements exist. }, "ErrorBadRequestInvalidEnumValue": { "docs": undefined, + "inline": undefined, "properties": { "allowed_values": { "docs": "The allowed values for the field.", @@ -905,6 +931,7 @@ sort order. If not set, then no prior elements exist. }, "ErrorBadRequestMissingRequiredField": { "docs": undefined, + "inline": undefined, "properties": { "field_name": { "docs": "The missing field's name.", @@ -932,6 +959,7 @@ sort order. If not set, then no prior elements exist. }, "ErrorBadRequestValueNotPermitted": { "docs": undefined, + "inline": undefined, "properties": { "field_name": { "docs": "The field whose value is not permitted.", @@ -948,6 +976,7 @@ sort order. If not set, then no prior elements exist. }, "ErrorBase": { "docs": undefined, + "inline": undefined, "properties": { "message": { "docs": "The message associated with the error.", @@ -963,6 +992,7 @@ sort order. If not set, then no prior elements exist. "extends": [ "ErrorBase", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -977,6 +1007,7 @@ sort order. If not set, then no prior elements exist. "extends": [ "ErrorBase", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -991,6 +1022,7 @@ sort order. If not set, then no prior elements exist. "extends": [ "ErrorBase", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -1005,6 +1037,7 @@ sort order. If not set, then no prior elements exist. "extends": [ "ErrorBase", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -1019,6 +1052,7 @@ sort order. If not set, then no prior elements exist. "extends": [ "ErrorBase", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -1033,6 +1067,7 @@ sort order. If not set, then no prior elements exist. "extends": [ "ErrorBase", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -1044,6 +1079,7 @@ sort order. If not set, then no prior elements exist. }, "EventPartCreated": { "docs": undefined, + "inline": undefined, "properties": { "part": { "type": "part", @@ -1055,6 +1091,7 @@ sort order. If not set, then no prior elements exist. }, "EventPartDeleted": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the part that was deleted.", @@ -1067,6 +1104,7 @@ sort order. If not set, then no prior elements exist. }, "EventPartUpdated": { "docs": undefined, + "inline": undefined, "properties": { "part": { "type": "part", @@ -1078,6 +1116,7 @@ sort order. If not set, then no prior elements exist. }, "EventRevOrgCreated": { "docs": undefined, + "inline": undefined, "properties": { "rev_org": { "type": "RevOrg", @@ -1089,6 +1128,7 @@ sort order. If not set, then no prior elements exist. }, "EventRevOrgDeleted": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the Rev organization that was deleted.", @@ -1101,6 +1141,7 @@ sort order. If not set, then no prior elements exist. }, "EventRevOrgUpdated": { "docs": undefined, + "inline": undefined, "properties": { "rev_org": { "type": "RevOrg", @@ -1112,6 +1153,7 @@ sort order. If not set, then no prior elements exist. }, "EventTagCreated": { "docs": undefined, + "inline": undefined, "properties": { "tag": { "type": "tag", @@ -1123,6 +1165,7 @@ sort order. If not set, then no prior elements exist. }, "EventTagDeleted": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the tag that was deleted.", @@ -1135,6 +1178,7 @@ sort order. If not set, then no prior elements exist. }, "EventTagUpdated": { "docs": undefined, + "inline": undefined, "properties": { "tag": { "type": "tag", @@ -1146,6 +1190,7 @@ sort order. If not set, then no prior elements exist. }, "EventTimelineEntryCreated": { "docs": undefined, + "inline": undefined, "properties": { "entry": { "type": "TimelineEntry", @@ -1157,6 +1202,7 @@ sort order. If not set, then no prior elements exist. }, "EventTimelineEntryDeleted": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the timeline entry that was deleted.", @@ -1169,6 +1215,7 @@ sort order. If not set, then no prior elements exist. }, "EventTimelineEntryUpdated": { "docs": undefined, + "inline": undefined, "properties": { "entry": { "type": "TimelineEntry", @@ -1180,6 +1227,7 @@ sort order. If not set, then no prior elements exist. }, "EventWebhookCreated": { "docs": undefined, + "inline": undefined, "properties": { "webhook": { "type": "webhook", @@ -1191,6 +1239,7 @@ sort order. If not set, then no prior elements exist. }, "EventWebhookDeleted": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the webhook that was deleted.", @@ -1203,6 +1252,7 @@ sort order. If not set, then no prior elements exist. }, "EventWebhookUpdated": { "docs": undefined, + "inline": undefined, "properties": { "webhook": { "type": "webhook", @@ -1214,6 +1264,7 @@ sort order. If not set, then no prior elements exist. }, "EventWorkCreated": { "docs": undefined, + "inline": undefined, "properties": { "work": { "type": "work", @@ -1225,6 +1276,7 @@ sort order. If not set, then no prior elements exist. }, "EventWorkDeleted": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the work that was deleted.", @@ -1237,6 +1289,7 @@ sort order. If not set, then no prior elements exist. }, "EventWorkUpdated": { "docs": undefined, + "inline": undefined, "properties": { "work": { "type": "work", @@ -1291,6 +1344,7 @@ always be returned in the specified sort-by order. "extends": [ "AtomBase", ], + "inline": undefined, "properties": { "display_name": { "docs": "Name of the Organization.", @@ -1306,6 +1360,7 @@ always be returned in the specified sort-by order. "extends": [ "AtomBaseSummary", ], + "inline": undefined, "properties": { "display_name": { "docs": "Name of the Organization.", @@ -1347,6 +1402,7 @@ always be returned in the specified sort-by order. "extends": [ "AtomBase", ], + "inline": undefined, "properties": { "artifacts": { "docs": "The attached artifacts.", @@ -1378,6 +1434,7 @@ always be returned in the specified sort-by order. "extends": [ "AtomBaseSummary", ], + "inline": undefined, "properties": { "name": { "docs": "Name of the part.", @@ -1454,6 +1511,7 @@ always be returned in the specified sort-by order. }, "PartsCreateRequestCapability": { "docs": undefined, + "inline": undefined, "properties": { "parent_part": { "docs": "ID of the parent product for the capability.", @@ -1466,6 +1524,7 @@ always be returned in the specified sort-by order. }, "PartsCreateRequestEnhancement": { "docs": undefined, + "inline": undefined, "properties": { "parent_part": { "docs": "ID of the parent part on which the enhancement is to be created. @@ -1484,6 +1543,7 @@ always be returned in the specified sort-by order. }, "PartsCreateRequestFeature": { "docs": undefined, + "inline": undefined, "properties": { "parent_part": { "docs": "ID of the parent capability/feature for the feature.", @@ -1499,6 +1559,7 @@ always be returned in the specified sort-by order. }, "PartsCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "part": { "type": "part", @@ -1513,6 +1574,7 @@ always be returned in the specified sort-by order. }, "PartsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "part": { "type": "part", @@ -1524,6 +1586,7 @@ always be returned in the specified sort-by order. }, "PartsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "next_cursor": { "docs": "The cursor used to iterate subsequent results in accordance to the @@ -1592,6 +1655,7 @@ sort order. If not set, then no prior elements exist. }, "PartsUpdateRequestEnhancement": { "docs": undefined, + "inline": undefined, "properties": { "target_close_date": { "docs": "Updates the target close date of the enhancement.", @@ -1607,6 +1671,7 @@ sort order. If not set, then no prior elements exist. }, "PartsUpdateRequestOwnedBy": { "docs": undefined, + "inline": undefined, "properties": { "set": { "docs": "Sets the owner IDs to the provided user IDs. This must not be @@ -1624,6 +1689,7 @@ empty. }, "PartsUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "part": { "type": "part", @@ -1644,6 +1710,7 @@ empty. "extends": [ "OrgBase", ], + "inline": undefined, "properties": { "description": { "docs": "Description of the Rev organization.", @@ -1672,6 +1739,7 @@ organization. "RevOrgsCreateResponse": { "docs": "Response object for request to create a new Rev organization. ", + "inline": undefined, "properties": { "rev_org": { "type": "RevOrg", @@ -1687,6 +1755,7 @@ organization. }, "RevOrgsGetResponse": { "docs": "The response to getting a Rev organization's information.", + "inline": undefined, "properties": { "rev_org": { "type": "RevOrg", @@ -1699,6 +1768,7 @@ organization. "RevOrgsListResponse": { "docs": "The response to getting a list of Rev organizations' information. ", + "inline": undefined, "properties": { "next_cursor": { "docs": "The cursor used to iterate subsequent results in accordance to the @@ -1723,6 +1793,7 @@ sort order. If not set, then no prior elements exist. }, "RevOrgsUpdateResponse": { "docs": "Response object to updating Rev organization's information.", + "inline": undefined, "properties": { "rev_org": { "type": "RevOrg", @@ -1737,6 +1808,7 @@ sort order. If not set, then no prior elements exist. "extends": [ "UserBaseSummary", ], + "inline": undefined, "properties": { "external_ref": { "docs": "External ref is a mutable unique identifier for a user within the @@ -1755,6 +1827,7 @@ system-generated identifier will be assigned to the user. }, "SetTagWithValue": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the tag.", @@ -1773,6 +1846,7 @@ the value must be one that's specified in the tag's allowed values. }, "StageInit": { "docs": "Sets an object's initial stage.", + "inline": undefined, "properties": { "name": { "docs": "The name of the stage.", @@ -1785,6 +1859,7 @@ the value must be one that's specified in the tag's allowed values. }, "StageUpdate": { "docs": "Updates an object's stage.", + "inline": undefined, "properties": { "name": { "docs": "The updated name of the stage, otherwise unchanged if not set. @@ -1804,6 +1879,7 @@ the value must be one that's specified in the tag's allowed values. "extends": [ "AtomBaseSummary", ], + "inline": undefined, "properties": { "name": { "docs": "The name of the tag, which denotes the logical concept by which all @@ -1819,6 +1895,7 @@ unique. }, "TagWithValue": { "docs": undefined, + "inline": undefined, "properties": { "tag": { "type": "TagSummary", @@ -1834,6 +1911,7 @@ unique. }, "TagsCreateResponse": { "docs": "The response to creating a new tag.", + "inline": undefined, "properties": { "tag": { "type": "tag", @@ -1849,6 +1927,7 @@ unique. }, "TagsGetResponse": { "docs": "The response to getting a tag's information.", + "inline": undefined, "properties": { "tag": { "type": "tag", @@ -1860,6 +1939,7 @@ unique. }, "TagsListResponse": { "docs": "The response to listing the tags.", + "inline": undefined, "properties": { "next_cursor": { "docs": "The cursor used to iterate subsequent results in accordance to the @@ -1884,6 +1964,7 @@ sort order. If not set, then no prior elements exist. }, "TagsUpdateAllowedValues": { "docs": "Specifies an update to a tag's allowed values.", + "inline": undefined, "properties": { "set": { "docs": "Sets the allowed values for the tag.", @@ -1896,6 +1977,7 @@ sort order. If not set, then no prior elements exist. }, "TagsUpdateResponse": { "docs": "The response for updating a tag.", + "inline": undefined, "properties": { "tag": { "type": "tag", @@ -1922,6 +2004,7 @@ sort order. If not set, then no prior elements exist. "extends": [ "TimelineEntryBase", ], + "inline": undefined, "properties": { "artifacts": { "docs": "The artifacts for the comment.", @@ -1976,6 +2059,7 @@ will appear in the response. }, "TimelineEntriesCreateRequestTimelineComment": { "docs": undefined, + "inline": undefined, "properties": { "artifacts": { "docs": "The IDs of the artifacts attached to the comment.", @@ -2000,6 +2084,7 @@ will appear in the response. "TimelineEntriesCreateRequestType": "literal<"timeline_comment">", "TimelineEntriesCreateResponse": { "docs": "The response to creating a timeline entry for an object.", + "inline": undefined, "properties": { "timeline_entry": { "type": "TimelineEntry", @@ -2011,6 +2096,7 @@ will appear in the response. }, "TimelineEntriesGetResponse": { "docs": "The request to getting a timeline entry.", + "inline": undefined, "properties": { "timeline_entry": { "type": "TimelineEntry", @@ -2022,6 +2108,7 @@ will appear in the response. }, "TimelineEntriesListResponse": { "docs": "The response to listing timeline entries for an object.", + "inline": undefined, "properties": { "next_cursor": { "docs": "The cursor used to iterate subsequent results in accordance to the @@ -2066,6 +2153,7 @@ sort order. If not set, then no prior elements exist. }, "TimelineEntriesUpdateRequestTimelineComment": { "docs": undefined, + "inline": undefined, "properties": { "artifacts": { "type": "optional", @@ -2088,6 +2176,7 @@ sort order. If not set, then no prior elements exist. }, "TimelineEntriesUpdateRequestTimelineCommentArtifacts": { "docs": undefined, + "inline": undefined, "properties": { "add": { "docs": "Adds the provided artifacts to the comment. An artifact cannot be @@ -2114,6 +2203,7 @@ not present, then it's ignored. Mututally exclusive with `set`. "TimelineEntriesUpdateRequestType": "literal<"timeline_comment">", "TimelineEntriesUpdateResponse": { "docs": "The response to updating a timeline entry.", + "inline": undefined, "properties": { "timeline_entry": { "type": "TimelineEntry", @@ -2154,6 +2244,7 @@ default visibility. "extends": [ "AtomBase", ], + "inline": undefined, "properties": { "display_name": { "docs": "The user's display name. The name is non-unique and mutable. @@ -2184,6 +2275,7 @@ default visibility. "extends": [ "AtomBaseSummary", ], + "inline": undefined, "properties": { "display_name": { "docs": "The user's display name. The name is non-unique and mutable. @@ -2247,6 +2339,7 @@ default visibility. }, "WebhookEventRequest": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The event's ID.", @@ -2331,6 +2424,7 @@ seconds. }, "WebhookEventResponse": { "docs": undefined, + "inline": undefined, "properties": { "challenge": { "docs": "The challenge from the "verify" request, otherwise this should not @@ -2378,6 +2472,7 @@ be set for other request types. }, "WebhookEventVerify": { "docs": undefined, + "inline": undefined, "properties": { "challenge": { "docs": "The challenge that must be echoed in the response.", @@ -2407,6 +2502,7 @@ be set for other request types. }, "WebhooksCreateResponse": { "docs": "The response to creating a new webhook.", + "inline": undefined, "properties": { "webhook": { "type": "webhook", @@ -2422,6 +2518,7 @@ be set for other request types. }, "WebhooksGetResponse": { "docs": "The response to getting the information for the webhook.", + "inline": undefined, "properties": { "webhook": { "type": "webhook", @@ -2433,6 +2530,7 @@ be set for other request types. }, "WebhooksListResponse": { "docs": "The response to listing the webhooks.", + "inline": undefined, "properties": { "webhooks": { "docs": "The list of webhooks.", @@ -2455,6 +2553,7 @@ be set for other request types. }, "WebhooksUpdateRequestEventTypes": { "docs": undefined, + "inline": undefined, "properties": { "add": { "docs": "The event types to add. If a provided event type is already set for @@ -2484,6 +2583,7 @@ event types. Note this is mutually exclusive with 'add' and }, "WebhooksUpdateResponse": { "docs": "The response to updating the webhook.", + "inline": undefined, "properties": { "webhook": { "type": "webhook", @@ -2498,6 +2598,7 @@ event types. Note this is mutually exclusive with 'add' and "extends": [ "AtomBase", ], + "inline": undefined, "properties": { "applies_to_part": "optional", "artifacts": { @@ -2601,6 +2702,7 @@ issues. }, "WorksCreateRequestIssue": { "docs": undefined, + "inline": undefined, "properties": { "priority": { "type": "optional", @@ -2616,6 +2718,7 @@ issues. }, "WorksCreateRequestTicket": { "docs": undefined, + "inline": undefined, "properties": { "group": { "docs": "The group that the ticket is associated with.", @@ -2635,6 +2738,7 @@ issues. }, "WorksCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "work": { "type": "work", @@ -2649,6 +2753,7 @@ issues. }, "WorksExportResponse": { "docs": undefined, + "inline": undefined, "properties": { "works": { "docs": "The resulting collection of work items.", @@ -2661,6 +2766,7 @@ issues. }, "WorksGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "work": { "type": "work", @@ -2672,6 +2778,7 @@ issues. }, "WorksListResponse": { "docs": undefined, + "inline": undefined, "properties": { "next_cursor": { "docs": "The cursor used to iterate subsequent results in accordance to the @@ -2746,6 +2853,7 @@ sort order. If not set, then no prior elements exist. }, "WorksUpdateRequestArtifactIds": { "docs": undefined, + "inline": undefined, "properties": { "set": { "docs": "Sets the IDs to the provided artifact IDs.", @@ -2758,6 +2866,7 @@ sort order. If not set, then no prior elements exist. }, "WorksUpdateRequestIssue": { "docs": undefined, + "inline": undefined, "properties": { "priority": { "type": "optional", @@ -2773,6 +2882,7 @@ sort order. If not set, then no prior elements exist. }, "WorksUpdateRequestOwnedBy": { "docs": undefined, + "inline": undefined, "properties": { "set": { "docs": "Sets the owner IDs to the provided user IDs. This must not be @@ -2787,6 +2897,7 @@ empty. }, "WorksUpdateRequestReportedBy": { "docs": undefined, + "inline": undefined, "properties": { "set": { "docs": "Sets the users that reported the work to the provided user IDs. @@ -2800,6 +2911,7 @@ empty. }, "WorksUpdateRequestTags": { "docs": undefined, + "inline": undefined, "properties": { "set": { "docs": "Sets the provided tags on the work item.", @@ -2812,6 +2924,7 @@ empty. }, "WorksUpdateRequestTicket": { "docs": undefined, + "inline": undefined, "properties": { "group": { "docs": "The group that the ticket is associated with.", @@ -2832,6 +2945,7 @@ empty. }, "WorksUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "work": { "type": "work", @@ -2849,6 +2963,7 @@ empty. "extends": [ "PartBase", ], + "inline": undefined, "properties": { "target_close_date": { "docs": "Timestamp when the enhancement is expected to be closed.", @@ -2864,6 +2979,7 @@ empty. "extends": [ "WorkBase", ], + "inline": undefined, "properties": { "priority": "optional", }, @@ -2891,6 +3007,7 @@ empty. }, "stage": { "docs": "Describes the current stage of a work item.", + "inline": undefined, "properties": { "name": { "docs": "Current stage name of the work item.", @@ -2906,6 +3023,7 @@ empty. "extends": [ "AtomBase", ], + "inline": undefined, "properties": { "allowed_values": { "docs": "The allowed values for the tag, where a value is provided when a @@ -2937,6 +3055,7 @@ unique. "extends": [ "WorkBase", ], + "inline": undefined, "properties": { "group": "optional", "rev_org": "optional", @@ -2951,6 +3070,7 @@ unique. "extends": [ "AtomBase", ], + "inline": undefined, "properties": { "event_types": { "docs": "The event types that the webhook will receive.", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/discriminated-union-value-title.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/discriminated-union-value-title.json index 5303ec20f77..bf6d9105202 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/discriminated-union-value-title.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/discriminated-union-value-title.json @@ -58,6 +58,7 @@ "Response": { "docs": "A generic response type used throughout the API. ", + "inline": undefined, "properties": { "value": { "docs": "An optional numerical value. diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/enum-casing.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/enum-casing.json index c41e060c95c..f672a171260 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/enum-casing.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/enum-casing.json @@ -45,6 +45,7 @@ "types": { "ExampleResponse": { "docs": undefined, + "inline": undefined, "properties": { "custom_fields": "optional>", "message": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/flagright.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/flagright.json index 51b778e1009..c0257a814df 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/flagright.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/flagright.json @@ -1990,6 +1990,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "types": { "ACHDetails": { "docs": "Model for ACH payment method", + "inline": undefined, "properties": { "accountNumber": { "docs": "Bank account number of the individual", @@ -2057,6 +2058,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "Address": { "docs": "Model for standardized address", + "inline": undefined, "properties": { "addressLines": { "docs": "Address lines of the user's residence address", @@ -2113,6 +2115,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "AlertClosedDetails": { "docs": undefined, + "inline": undefined, "properties": { "alertId": { "type": "optional", @@ -2154,6 +2157,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "Amount": { "docs": "Model for amount", + "inline": undefined, "properties": { "amountCurrency": { "type": "CurrencyCode", @@ -2173,6 +2177,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "BusinessBase", "BusinessOptional", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -2180,6 +2185,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "BusinessBase": { "docs": "Model for a business user base fields", + "inline": undefined, "properties": { "createdTimestamp": { "docs": "Timestamp when the user was created", @@ -2209,6 +2215,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "BusinessEntityLink": { "docs": undefined, + "inline": undefined, "properties": { "childUserIds": { "type": "optional>", @@ -2223,6 +2230,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "BusinessOptional": { "docs": "Model for a business user - optional fields", + "inline": undefined, "properties": { "acquisitionChannel": { "type": "optional", @@ -2312,6 +2320,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "BusinessUsersResponse": { "docs": "Model for business user risk score response", + "inline": undefined, "properties": { "userId": { "docs": "user ID the risk score pertains to", @@ -2333,6 +2342,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "extends": [ "Business", ], + "inline": undefined, "properties": { "executedRules": "optional>", "hitRules": "optional>", @@ -2343,6 +2353,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "CardDetails": { "docs": "Model for credit or debit card details", + "inline": undefined, "properties": { "3dsDone": { "docs": "Whether 3ds was successfully enforced for the transaction", @@ -2451,6 +2462,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "CardExpiry": { "docs": undefined, + "inline": undefined, "properties": { "month": { "type": "optional", @@ -2465,6 +2477,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "CardMerchantDetails": { "docs": undefined, + "inline": undefined, "properties": { "MCC": { "type": "optional", @@ -2505,6 +2518,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "CaseClosedDetails": { "docs": undefined, + "inline": undefined, "properties": { "caseId": { "type": "optional", @@ -2534,6 +2548,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "CaseManagementEvent": { "docs": "Model for case management events", + "inline": undefined, "properties": { "caseStatus": { "docs": "Status of a case. E.g. Open, Closed etc.", @@ -2605,6 +2620,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "CheckDetails": { "docs": undefined, + "inline": undefined, "properties": { "checkIdentifier": { "type": "optional", @@ -2655,6 +2671,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "CompanyFinancialDetails": { "docs": "Model for business user company financial details", + "inline": undefined, "properties": { "expectedTransactionAmountPerMonth": { "type": "optional", @@ -2673,6 +2690,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "CompanyGeneralDetails": { "docs": "Model for business user company general details", + "inline": undefined, "properties": { "businessIndustry": { "docs": "The industry the business operates in for a business customer", @@ -2724,6 +2742,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "CompanyRegistrationDetails": { "docs": "Model for business user company registration details", + "inline": undefined, "properties": { "dateOfRegistration": { "type": "optional", @@ -2766,6 +2785,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "ConsumerName": { "docs": "Model for a generic consumer name", + "inline": undefined, "properties": { "firstName": { "docs": "First name of the user", @@ -2804,6 +2824,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "ConsumerUsersResponse": { "docs": "Model for consumer user risk score response", + "inline": undefined, "properties": { "userId": { "docs": "user ID the risk score pertains to", @@ -2822,6 +2843,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "ContactDetails": { "docs": "Model for business user contact information details", + "inline": undefined, "properties": { "addresses": { "docs": "Address(es) of the company", @@ -3390,6 +3412,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "Date": { "docs": "Model for date", + "inline": undefined, "properties": { "day": { "docs": "Day of date", @@ -3410,6 +3433,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "DeviceData": { "docs": "Model for device data", + "inline": undefined, "properties": { "appVersion": { "docs": "The version of the app your user is using on their device at a given timestamp for an event or transaction", @@ -3504,6 +3528,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "ExecutedRulesResult": { "docs": "Model for list of executed rules", + "inline": undefined, "properties": { "labels": { "type": "optional>", @@ -3556,6 +3581,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "FailedRulesResult": { "docs": "Model for list of rules failed execution. It means rules could not be run", + "inline": undefined, "properties": { "failureException": { "type": "RuleFailureException", @@ -3597,6 +3623,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "FalsePositiveDetails": { "docs": undefined, + "inline": undefined, "properties": { "confidenceScore": "double", "isFalsePositive": "boolean", @@ -3611,6 +3638,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "GenericBankAccountDetails": { "docs": "Model for any generic bank account", + "inline": undefined, "properties": { "accountNumber": { "docs": "Bank account number", @@ -3661,6 +3689,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "HitRulesDetails": { "docs": "Model for list of hit rules", + "inline": undefined, "properties": { "labels": { "type": "optional>", @@ -3712,6 +3741,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "IBANDetails": { "docs": "Standardized model for Bank Details", + "inline": undefined, "properties": { "BIC": { "docs": "Identifier for the bank. Can be routing number, BIK number, SWIFT code, BIC number etc.", @@ -3781,6 +3811,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "KYCStatusDetails": { "docs": undefined, + "inline": undefined, "properties": { "reason": { "type": "optional", @@ -3795,6 +3826,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "LegalDocument": { "docs": "LegalDocument model generalizes User's identity document type (ex: Passport)", + "inline": undefined, "properties": { "documentExpirationDate": { "docs": "User's identity document expiration date (UNIX timestamp in milliseconds)", @@ -3841,6 +3873,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "LegalEntity": { "docs": "Model for business user legal entity details", + "inline": undefined, "properties": { "companyFinancialDetails": { "type": "optional", @@ -3865,6 +3898,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "ListData": { "docs": "Payload of a list, new or existed", + "inline": undefined, "properties": { "items": { "docs": "List items", @@ -3880,6 +3914,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "ListExisted": { "docs": "List with ID and header", + "inline": undefined, "properties": { "header": { "type": "ListHeader", @@ -3896,6 +3931,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "ListHeader": { "docs": undefined, + "inline": undefined, "properties": { "createdTimestamp": "double", "listId": "string", @@ -3912,6 +3948,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "ListItem": { "docs": undefined, + "inline": undefined, "properties": { "key": "string", "metadata": { @@ -3928,6 +3965,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "ListMetadata": { "docs": undefined, "extra-properties": true, + "inline": undefined, "properties": { "checksum": { "type": "optional", @@ -3978,6 +4016,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "MCCDetails": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Merchant code", @@ -3994,6 +4033,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "MpesaDetails": { "docs": "Model for Mpesa payment method", + "inline": undefined, "properties": { "businessShortCode": { "docs": "Business code", @@ -4037,6 +4077,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "PEPStatus": { "docs": undefined, + "inline": undefined, "properties": { "isPepHit": "boolean", "pepCountry": { @@ -4071,6 +4112,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "Person": { "docs": "Model for a generic individual - different from User model by not having userId field", + "inline": undefined, "properties": { "contactDetails": { "type": "optional", @@ -4099,6 +4141,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "extends": [ "RulesResults", ], + "inline": undefined, "properties": { "message": "optional", "userId": { @@ -4121,6 +4164,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "extends": [ "TransactionMonitoringResult", ], + "inline": undefined, "properties": { "message": "optional", }, @@ -4133,6 +4177,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "extends": [ "RulesResults", ], + "inline": undefined, "properties": { "message": "optional", "userId": { @@ -4164,6 +4209,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "RiskScoringResult": { "docs": "Model for results from Risk Scoring", + "inline": undefined, "properties": { "customerRiskAssessment": { "docs": "Quantified dynamic risk score", @@ -4196,6 +4242,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "RuleFailureException": { "docs": undefined, + "inline": undefined, "properties": { "exceptionDescription": { "docs": "Name of the rule", @@ -4233,6 +4280,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "RuleHitMeta": { "docs": "Details of rule execution, for internal purposes only", + "inline": undefined, "properties": { "falsePositiveDetails": "optional", "hitDirections": "optional>", @@ -4274,6 +4322,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "RulesResults": { "docs": undefined, + "inline": undefined, "properties": { "executedRules": { "docs": "Unique transaction identifier", @@ -4290,6 +4339,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "SWIFTDetails": { "docs": "Model for SWIFT payment method", + "inline": undefined, "properties": { "accountNumber": { "docs": "Account number", @@ -4347,6 +4397,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "SanctionsDetails": { "docs": undefined, + "inline": undefined, "properties": { "entityType": { "type": "optional", @@ -4375,6 +4426,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "Tag": { "docs": "Generic key-value pair model to append a custom variable being sent to Flagright API", + "inline": undefined, "properties": { "key": { "docs": "Key value when you are creating a custom variable", @@ -4403,6 +4455,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "Thing": { "docs": undefined, + "inline": undefined, "properties": { "publishedAt": "optional", }, @@ -4416,6 +4469,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "TransactionBase", "TransactionUpdatable", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4423,6 +4477,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "TransactionAmountDetails": { "docs": "Model for transaction amount details", + "inline": undefined, "properties": { "country": { "type": "optional", @@ -4441,6 +4496,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "TransactionAmountLimit": { "docs": undefined, + "inline": undefined, "properties": { "day": { "type": "optional", @@ -4461,6 +4517,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "TransactionBase": { "docs": "Model for transaction base Payload", + "inline": undefined, "properties": { "destinationUserId": { "docs": "UserId for transaction's destination. In other words, where the value is being transferred to.", @@ -4501,6 +4558,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "TransactionCountLimit": { "docs": undefined, + "inline": undefined, "properties": { "day": { "type": "optional", @@ -4524,6 +4582,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "extends": [ "RulesResults", ], + "inline": undefined, "properties": { "eventId": "string", "transaction": "Transaction", @@ -4534,6 +4593,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "TransactionLimit": { "docs": undefined, + "inline": undefined, "properties": { "averageTransactionAmountLimit": { "type": "optional", @@ -4551,6 +4611,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "TransactionLimits": { "docs": "Model for transaction limits for a given user", + "inline": undefined, "properties": { "maximumDailyTransactionLimit": { "type": "optional", @@ -4580,6 +4641,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "TransactionLimitsPaymentMethodLimits": { "docs": undefined, + "inline": true, "properties": { "ACH": "optional", "CARD": "optional", @@ -4600,6 +4662,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "extends": [ "RulesResults", ], + "inline": undefined, "properties": { "transactionId": { "docs": "Transaction ID that the results pertain to", @@ -4641,6 +4704,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "TransactionUpdatable": { "docs": "Model for transaction additional payload", + "inline": undefined, "properties": { "destinationAmountDetails": { "type": "optional", @@ -4776,6 +4840,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "extends": [ "Transaction", ], + "inline": undefined, "properties": { "executedRules": "list", "hitRules": "list", @@ -4786,6 +4851,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "UPIDetails": { "docs": "Model for UPI payment method", + "inline": undefined, "properties": { "bankProvider": { "docs": "Bank provider name", @@ -4836,6 +4902,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "UserBase", "UserOptional", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -4843,6 +4910,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "UserBase": { "docs": "Model for User details", + "inline": undefined, "properties": { "createdTimestamp": { "docs": "Timestamp when userId is created", @@ -4875,6 +4943,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "UserDetails": { "docs": "Model for consumer user personal details", + "inline": undefined, "properties": { "countryOfNationality": { "type": "optional", @@ -4920,6 +4989,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "extends": [ "RulesResults", ], + "inline": undefined, "properties": { "userId": { "docs": "User ID that the results pertain to", @@ -4932,6 +5002,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "UserOptional": { "docs": "Model for User details", + "inline": undefined, "properties": { "acquisitionChannel": { "type": "optional", @@ -5010,6 +5081,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "UserStateDetails": { "docs": undefined, + "inline": undefined, "properties": { "reason": { "type": "optional", @@ -5030,6 +5102,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu "extends": [ "User", ], + "inline": undefined, "properties": { "executedRules": "optional>", "hitRules": "optional>", @@ -5040,6 +5113,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "WalletDetails": { "docs": "Standardized model for a Generic wallet transaction", + "inline": undefined, "properties": { "name": { "docs": "Name of the account holder for a specific wallet", @@ -5081,6 +5155,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu }, "WebhookEvent": { "docs": undefined, + "inline": undefined, "properties": { "createdTimestamp": { "type": "double", @@ -6241,6 +6316,7 @@ In order to make individual events retrievable, you also need to pass in a uniqu CHECK: optional source: openapi: ../openapi.yml + inline: true TransactionLimits: docs: Model for transaction limits for a given user properties: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/flexport.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/flexport.json index bd92294e044..6e8adb3906c 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/flexport.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/flexport.json @@ -395,6 +395,7 @@ "types": { "AdditionalDates": { "docs": undefined, + "inline": undefined, "properties": { "cargo_ready_date": { "docs": "Represents the date when the cargo on the leg is ready for pickup.", @@ -437,6 +438,7 @@ }, "Address": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -459,6 +461,7 @@ }, "AddressForRequestBody": { "docs": undefined, + "inline": undefined, "properties": { "city": "optional", "country_code": "optional", @@ -474,6 +477,7 @@ }, "AirBookingDetail": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -511,6 +515,7 @@ }, "AirShipmentDetail": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -527,6 +532,7 @@ }, "AirShipmentLeg": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "flight_number": "optional", @@ -539,6 +545,7 @@ }, "Airport": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -555,6 +562,7 @@ }, "BadRequestErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional>", @@ -568,6 +576,7 @@ }, "Booking": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -631,6 +640,7 @@ }, "BookingAmendment": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -713,6 +723,7 @@ }, "BookingAmendmentHsCode": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "String representing the object’s type. Always `/booking_amendment_product_description` for this object.", @@ -734,6 +745,7 @@ }, "BookingHsCode": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "String representing the object’s type. Always `/product_descriptions` for this object.", @@ -759,6 +771,7 @@ }, "BookingLineItem": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -781,6 +794,7 @@ }, "BookingLineItemCollectionRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -818,6 +832,7 @@ }, "BookingRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "id": "optional", @@ -842,6 +857,7 @@ }, "CarbonCalculation": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -855,6 +871,7 @@ }, "Cargo": { "docs": "With cargo you have two options, detailed or simple. These are both expressed directly on the cargo object. For detailed cargo, `shipping_units` is required, and `weight` and `volume` is required in the `cargo` object or the `shipping_units` object. For simple cargo, `shipping_units` is required, but only one should be specified, and `weight` and `volume` are required in the `cargo` object.", + "inline": undefined, "properties": { "_object": { "docs": "String representing the object’s type. Always `/cargo` for this object.", @@ -909,6 +926,7 @@ }, "CommercialInvoice": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object. Always /commercial_invoice for this object.", @@ -958,6 +976,7 @@ }, "CommercialInvoiceCollectionRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "link": "optional", @@ -980,6 +999,7 @@ }, "CommercialInvoiceLineItem": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object. Always /commercial_invoice_line_item for this object.", @@ -1022,6 +1042,7 @@ }, "CommercialInvoiceLineItemContainerNumber": { "docs": undefined, + "inline": undefined, "properties": { "commercial_invoice_line_item_id": "optional", "container_number": "optional", @@ -1036,6 +1057,7 @@ }, "Company": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object. Always /network/company for this object.", @@ -1059,6 +1081,7 @@ }, "CompanyEntity": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -1076,6 +1099,7 @@ }, "CompanyEntityRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "id": "optional", @@ -1088,6 +1112,7 @@ }, "Contact": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object. Always /network/contact for this object.", @@ -1112,6 +1137,7 @@ }, "ContactCompany": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": true, "properties": { "_object": "optional", "id": "optional", @@ -1124,6 +1150,7 @@ }, "ContainerCollectionRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -1144,6 +1171,7 @@ }, "ContainerCounts": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "String representing the object’s type. Always `/container_counts` for this object.", @@ -1172,6 +1200,7 @@ }, "ContainerLegCollectionRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -1192,6 +1221,7 @@ }, "ContainerRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "id": "optional", @@ -1204,6 +1234,7 @@ }, "CoordinatesCreate": { "docs": undefined, + "inline": undefined, "properties": { "latitude": "optional", "longitude": "optional", @@ -1214,6 +1245,7 @@ }, "CreateAirBooking": { "docs": "If a non-null value is passed in for 'air_booking', then the new booking will be assumed to be an air booking, even if the 'ocean_booking' or 'trucking_booking' fields are set.", + "inline": undefined, "properties": { "destination_port_iata_code": { "docs": "Optional, provide one of `destination_port_us_cbp_port_code`, `destination_port_loc_code`, `destination_port_iata_code`, or `destination_port_icao_code`. Unique airport reference code used by IATA.", @@ -1283,6 +1315,7 @@ }, "CreateBookingAmendmentHsCode": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "Always required. English description of product in booking.", @@ -1303,6 +1336,7 @@ }, "CreateBookingHsCode": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "Always required. English description of product in booking.", @@ -1327,6 +1361,7 @@ }, "CreateCargo": { "docs": "With cargo you have two options, detailed or simple. These are both expressed directly on the cargo object. For detailed cargo, `shipping_units` is required, and `weight` and `volume` is required in the `cargo` object or the `shipping_units` object. For simple cargo, `shipping_units` is required, but only one should be specified, and `weight` and `volume` are required in the `cargo` object.", + "inline": undefined, "properties": { "contains_hazmat": { "docs": "Required. Whether the cargo contains hazardous materials.", @@ -1377,6 +1412,7 @@ }, "CreateCommercialInvoiceLineItem": { "docs": undefined, + "inline": undefined, "properties": { "container_number": "optional", "country_of_origin": "optional", @@ -1416,6 +1452,7 @@ }, "CreateContainerCounts": { "docs": undefined, + "inline": undefined, "properties": { "forty_five_ft_hc": { "docs": "Quantity of 45 ft HC containers requested.", @@ -1440,6 +1477,7 @@ }, "CreateDocument": { "docs": undefined, + "inline": undefined, "properties": { "document": { "docs": "Document represented in a strict Base64-encoded string.", @@ -1476,6 +1514,7 @@ }, "CreateInvolvedParty": { "docs": undefined, + "inline": undefined, "properties": { "company_entity_ref": { "docs": "Your custom string used to refer to the company entity. Can be used to look up or reference the company entity later on.", @@ -1489,6 +1528,7 @@ }, "CreateLineItem": { "docs": undefined, + "inline": undefined, "properties": { "assigned_party_ref": { "docs": "The party that this line item is assigned to. Useful if assigning line items to different factories under a vendor, for example.", @@ -1585,6 +1625,7 @@ }, "CreateLineItemDestinationLocation": { "docs": undefined, + "inline": undefined, "properties": { "location_ref": { "docs": "Location ref", @@ -1632,6 +1673,7 @@ }, "CreateLineItemMeasurement": { "docs": undefined, + "inline": undefined, "properties": { "measure_type": { "docs": "The type of measure", @@ -1823,6 +1865,7 @@ }, "CreateOceanBooking": { "docs": undefined, + "inline": undefined, "properties": { "container_counts": "CreateContainerCounts", "destination_port_loc_code": { @@ -1885,6 +1928,7 @@ }, "CreateOrUpdatePurchaseOrder": { "docs": undefined, + "inline": undefined, "properties": { "cargo_ready_date": { "docs": "Required if there is no cargo_ready_date in each line item. Date when cargo is ready for pickup at the origin location.", @@ -2069,6 +2113,7 @@ }, "CreateParty": { "docs": "A party is a company entity that is tied to a purchase order and has a specific role.", + "inline": undefined, "properties": { "contacts": { "docs": "A list of contact data for who should be contacted should there be questions about this order. For example, if your supplier needs to contact someone, who should they contact?", @@ -2093,6 +2138,7 @@ }, "CreatePartyContactsItem": { "docs": undefined, + "inline": true, "properties": { "department": "optional", "email": "optional", @@ -2126,6 +2172,7 @@ }, "CreatePurchaseOrderHsCode": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "The indentifying code on the hs code", @@ -2142,6 +2189,7 @@ }, "CreatePurchaseOrderPort": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "A unique identifier for this port", @@ -2170,6 +2218,7 @@ }, "CreatePurchaseOrderProduct": { "docs": undefined, + "inline": undefined, "properties": { "color": { "docs": "The color of the product", @@ -2226,6 +2275,7 @@ }, "CreateQuantity": { "docs": undefined, + "inline": undefined, "properties": { "unit": { "docs": "Required. Unit of measurement.", @@ -2257,6 +2307,7 @@ }, "CreateTruckingBooking": { "docs": undefined, + "inline": undefined, "properties": { "description_of_products": { "docs": "General description of the products in the shipment.", @@ -2287,6 +2338,7 @@ }, "CreditMemo": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "The type of the object", @@ -2317,6 +2369,7 @@ }, "CustomsEntry": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object. Always /customs_entry for this object.", @@ -2349,6 +2402,7 @@ }, "CustomsEntryCollectionRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "link": "optional", @@ -2371,6 +2425,7 @@ }, "CustomsInvolvedParty": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -2393,6 +2448,7 @@ }, "DistanceCreate": { "docs": undefined, + "inline": undefined, "properties": { "unit": { "docs": "Required. Unit of measurement. "km" for kilometers. "mi" for miles.", @@ -2419,6 +2475,7 @@ }, "Document": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object. Always /document for this object.", @@ -2460,6 +2517,7 @@ }, "DocumentCollectionRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "link": "optional", @@ -2471,6 +2529,7 @@ }, "Error": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "String representing the object’s type. Always /api/error for this object.", @@ -2495,6 +2554,7 @@ }, "Exception": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "message": { @@ -2539,6 +2599,7 @@ }, "FileMetadata": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object. Always /file_metadata for this object.", @@ -2570,6 +2631,7 @@ }, "GenericCollectionRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "link": "optional", @@ -2581,6 +2643,7 @@ }, "GenericObjectRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "id": "optional", @@ -2595,6 +2658,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -2605,6 +2669,7 @@ }, "HsCode": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "String representing the object’s type. Always `/hs_code` for this object.", @@ -2626,6 +2691,7 @@ }, "Invoice": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object. Always '/invoice' for this object.", @@ -2699,6 +2765,7 @@ }, "InvoiceItem": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object.", @@ -2744,6 +2811,7 @@ }, "InvoiceQuantity": { "docs": "Describes the number of units used to calculate the price of a line item", + "inline": undefined, "properties": { "_object": { "docs": "The type of the object", @@ -2764,6 +2832,7 @@ }, "InvoiceRate": { "docs": "Describes the rate per unit used to calculate the price of a line item", + "inline": undefined, "properties": { "_object": { "docs": "The type of the object", @@ -2807,6 +2876,7 @@ }, "LegCollectionRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -2827,6 +2897,7 @@ }, "LegRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "id": "optional", @@ -2839,6 +2910,7 @@ }, "Length": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "String representing the object’s type. Always `/quantity/length` for this object.", @@ -2859,6 +2931,7 @@ }, "LengthCreate": { "docs": undefined, + "inline": undefined, "properties": { "unit": { "docs": "Required. Unit of measurement. "cm" for centimeters. "in" for inches.", @@ -2895,6 +2968,7 @@ }, "LineItemMeasurement": { "docs": undefined, + "inline": undefined, "properties": { "measure_type": { "docs": "The type of measure", @@ -2931,6 +3005,7 @@ }, "Location": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object. Always /network/location for this object.", @@ -2954,6 +3029,7 @@ }, "Manufacturer": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -2974,6 +3050,7 @@ "discriminated": false, "docs": "Metadata has two allowed formats. Either array format or object format. Refer to the metadata section in this documentation for more information.", "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -2990,6 +3067,7 @@ }, "MetadataCreateExampleKey": { "docs": "Object format.", + "inline": true, "properties": { "example_key": "optional>", }, @@ -2999,6 +3077,7 @@ }, "MetadataCreateItem": { "docs": undefined, + "inline": true, "properties": { "name": "optional", "value": "optional>", @@ -3012,6 +3091,7 @@ "extends": [ "MoneyCreate", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -3019,6 +3099,7 @@ }, "MoneyCreate": { "docs": undefined, + "inline": undefined, "properties": { "amount": "optional", "currency_code": "optional", @@ -3029,6 +3110,7 @@ }, "OceanBookingDetail": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -3068,6 +3150,7 @@ }, "OceanShipmentContainerLeg": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -3083,6 +3166,7 @@ }, "OceanShipmentDetail": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -3104,6 +3188,7 @@ }, "OceanShipmentLeg": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "container_legs": "optional", @@ -3118,6 +3203,7 @@ }, "Parties": { "docs": "A party is a company entity that is tied to a purchase order that has a specific role.", + "inline": undefined, "properties": { "company_entity": "optional", "contacts": { @@ -3139,6 +3225,7 @@ }, "PartiesContactsItem": { "docs": undefined, + "inline": true, "properties": { "department": "optional", "email": "optional", @@ -3172,6 +3259,7 @@ }, "Place": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -3192,6 +3280,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3203,6 +3292,7 @@ }, "Placeport": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -3236,6 +3326,7 @@ }, "Product": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -3291,6 +3382,7 @@ }, "ProductClassification": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -3311,6 +3403,7 @@ }, "ProductProperty": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -3331,6 +3424,7 @@ }, "ProductRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "id": "optional", @@ -3343,6 +3437,7 @@ }, "PurchaseOrder": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -3450,6 +3545,7 @@ }, "PurchaseOrderLineItem": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -3510,6 +3606,7 @@ }, "PurchaseOrderLineItemCollectionRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -3530,6 +3627,7 @@ }, "PurchaseOrderLineItemDestinationAddress": { "docs": undefined, + "inline": undefined, "properties": { "location_ref": { "docs": "Location ref", @@ -3576,6 +3674,7 @@ }, "PurchaseOrderLineItemRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "id": "optional", @@ -3662,6 +3761,7 @@ }, "PurchaseOrderProduct": { "docs": undefined, + "inline": undefined, "properties": { "color": { "docs": "The color of the product", @@ -3718,6 +3818,7 @@ }, "PurchaseOrderRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": "optional", "id": "optional", @@ -3742,6 +3843,7 @@ }, "RailShipmentLeg": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "container_legs": "optional", @@ -3752,6 +3854,7 @@ }, "Shipment": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -3930,6 +4033,7 @@ }, "ShipmentContainer": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -4012,6 +4116,7 @@ }, "ShipmentDangerousGoods": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of this object", @@ -4042,6 +4147,7 @@ }, "ShipmentEventData": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -4067,6 +4173,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -4097,6 +4204,7 @@ }, "ShipmentItem": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -4115,6 +4223,7 @@ }, "ShipmentLeg": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -4156,6 +4265,7 @@ }, "ShipmentNode": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -4181,6 +4291,7 @@ }, "ShipmentRef": { "docs": "[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)", + "inline": undefined, "properties": { "_object": { "docs": "Type of Object Returned. In this case, /api/refs/object.", @@ -4225,6 +4336,7 @@ }, "ShippingUnit": { "docs": "For detailed cargo, `shipping_units` is required. For simple cargo, `shipping_units` is required, but only one should be specified.", + "inline": undefined, "properties": { "_object": { "docs": "String representing the object’s type. Always `/shipping_unit` for this object.", @@ -4258,6 +4370,7 @@ }, "ShippingUnitCreate": { "docs": "For detailed cargo, `shipping_units` is required. For simple cargo, `shipping_units` is required, but only one should be specified.", + "inline": undefined, "properties": { "atomic_count": { "docs": "Required if `unit_type` = `pallet`. The number of atomic units, i.e. units that will not be unpacked and broken up during shipping, contained in each shipping unit.", @@ -4287,6 +4400,7 @@ }, "Terminal": { "docs": "Name and address of a specific terminal within a port or airport. Possibly null", + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -4323,6 +4437,7 @@ }, "TruckingBookingDetail": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -4347,6 +4462,7 @@ }, "TruckingShipmentLeg": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "container_legs": "optional", @@ -4372,6 +4488,7 @@ }, "VatNumber": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -4392,6 +4509,7 @@ "extends": [ "VolumeCreate", ], + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -4404,6 +4522,7 @@ }, "VolumeCreate": { "docs": undefined, + "inline": undefined, "properties": { "unit": { "docs": "unit of measurement. "cbm" for cubic meters. "cbft" for cubic feet.", @@ -4430,6 +4549,7 @@ }, "WebhookEvent": { "docs": undefined, + "inline": undefined, "properties": { "_object": { "docs": "Type of the object", @@ -4451,6 +4571,7 @@ "extends": [ "WeightCreate", ], + "inline": undefined, "properties": { "_object": { "docs": "String representing the object’s type. Always `/quantity/weight` for this object.", @@ -4463,6 +4584,7 @@ }, "WeightCreate": { "docs": undefined, + "inline": undefined, "properties": { "unit": { "docs": "Required. Unit of measurement. "kg" for kilograms, "lbs" for pounds", @@ -4489,6 +4611,7 @@ }, "WriteProductClassification": { "docs": undefined, + "inline": undefined, "properties": { "codes": { "docs": "Always required. An array of HS codes for this product in the provided region", @@ -4505,6 +4628,7 @@ }, "WriteProductProperty": { "docs": undefined, + "inline": undefined, "properties": { "type": { "docs": "Always required. User defined type of this property", @@ -4521,6 +4645,7 @@ }, "WriteProductSupplier": { "docs": undefined, + "inline": undefined, "properties": { "country_of_origin": { "docs": "Always required. ISO Alpha-2 country in which the product is manufactured", @@ -4541,6 +4666,7 @@ }, "WriteVatNumber": { "docs": undefined, + "inline": undefined, "properties": { "country_code": { "docs": "ISO 3166 two-letter country code", @@ -4739,12 +4865,14 @@ example_key: optional> source: openapi: ../openapi.yml + inline: true MetadataCreateItem: properties: name: optional value: optional> source: openapi: ../openapi.yml + inline: true MetadataCreate: discriminated: false docs: >- @@ -5180,6 +5308,7 @@ - Manufacturer source: openapi: ../openapi.yml + inline: true Place: properties: _object: @@ -5940,6 +6069,7 @@ - integer source: openapi: ../openapi.yml + inline: true GenericObjectRef: docs: '[Expandable API link.](https://apidocs.flexport.com/v3/tag/Expansion)' properties: @@ -6630,6 +6760,7 @@ - OceanShipmentContainerLeg source: openapi: ../openapi.yml + inline: true ShipmentEventData: properties: _object: @@ -6859,6 +6990,7 @@ id: optional source: openapi: ../openapi.yml + inline: true Contact: properties: _object: @@ -7165,6 +7297,7 @@ department: optional source: openapi: ../openapi.yml + inline: true Parties: docs: >- A party is a company entity that is tied to a purchase order that has a @@ -7341,6 +7474,7 @@ department: optional source: openapi: ../openapi.yml + inline: true CreateParty: docs: >- A party is a company entity that is tied to a purchase order and has a @@ -9212,6 +9346,7 @@ errors: "types": { "BookingCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -9224,6 +9359,7 @@ errors: }, "BookingShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -9264,6 +9400,7 @@ errors: }, "BookingsIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -9276,6 +9413,7 @@ errors: }, "BookingsIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -9327,6 +9465,7 @@ errors: data: optional> source: openapi: ../openapi.yml + inline: true BookingsIndexResponse: properties: _object: optional @@ -10595,6 +10734,7 @@ docs: Endpoints relating to Booking objects "types": { "BookingAmendmentCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -11127,6 +11267,7 @@ docs: >- "types": { "BookingLineItemCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -11149,6 +11290,7 @@ docs: >- }, "BookingLineItemIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -11161,6 +11303,7 @@ docs: >- }, "BookingLineItemIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -11173,6 +11316,7 @@ docs: >- }, "BookingLineItemShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -11201,6 +11345,7 @@ docs: >- data: optional> source: openapi: ../openapi.yml + inline: true BookingLineItemIndexResponse: properties: _object: optional @@ -11554,6 +11699,7 @@ docs: >- "types": { "CarbonCalculationCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -12507,6 +12653,7 @@ docs: Endpoints relating to Carbon Calculations "types": { "CommercialInvoicesCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -12519,6 +12666,7 @@ docs: Endpoints relating to Carbon Calculations }, "CommercialInvoicesIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -12531,6 +12679,7 @@ docs: Endpoints relating to Carbon Calculations }, "CommercialInvoicesIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -12543,6 +12692,7 @@ docs: Endpoints relating to Carbon Calculations }, "CommercialInvoicesShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -12555,6 +12705,7 @@ docs: Endpoints relating to Carbon Calculations }, "CommercialInvoicesUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -12578,6 +12729,7 @@ types: data: optional> source: openapi: ../openapi.yml + inline: true CommercialInvoicesIndexResponse: properties: _object: optional @@ -13681,6 +13833,7 @@ docs: Endpoints relating to Commercial Invoice objects "types": { "NetworkCompanyCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -13693,6 +13846,7 @@ docs: Endpoints relating to Commercial Invoice objects }, "NetworkCompanyIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -13705,6 +13859,7 @@ docs: Endpoints relating to Commercial Invoice objects }, "NetworkCompanyIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -13718,6 +13873,7 @@ docs: Endpoints relating to Commercial Invoice objects }, "NetworkCompanyMeResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -13730,6 +13886,7 @@ docs: Endpoints relating to Commercial Invoice objects }, "NetworkCompanyShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -13742,6 +13899,7 @@ docs: Endpoints relating to Commercial Invoice objects }, "NetworkCompanyUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -13766,6 +13924,7 @@ types: data: optional> source: openapi: ../openapi.yml + inline: true NetworkCompanyIndexResponse: properties: _object: optional @@ -14559,6 +14718,7 @@ docs: Endpoints relating to Company objects "types": { "CompanyEntityIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -14571,6 +14731,7 @@ docs: Endpoints relating to Company objects }, "CompanyEntityIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -14584,6 +14745,7 @@ docs: Endpoints relating to Company objects }, "NetworkCompanyEntityCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -14596,6 +14758,7 @@ docs: Endpoints relating to Company objects }, "NetworkCompanyEntityShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -14608,6 +14771,7 @@ docs: Endpoints relating to Company objects }, "NetworkCompanyEntityUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -14632,6 +14796,7 @@ types: data: optional> source: openapi: ../openapi.yml + inline: true CompanyEntityIndexResponse: properties: _object: optional @@ -15274,6 +15439,7 @@ docs: Endpoints relating to CompanyEntity objects "types": { "NetworkContactCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -15286,6 +15452,7 @@ docs: Endpoints relating to CompanyEntity objects }, "NetworkContactIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -15298,6 +15465,7 @@ docs: Endpoints relating to CompanyEntity objects }, "NetworkContactIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -15311,6 +15479,7 @@ docs: Endpoints relating to CompanyEntity objects }, "NetworkContactShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -15323,6 +15492,7 @@ docs: Endpoints relating to CompanyEntity objects }, "NetworkContactUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -15347,6 +15517,7 @@ types: data: optional> source: openapi: ../openapi.yml + inline: true NetworkContactIndexResponse: properties: _object: optional @@ -15884,6 +16055,7 @@ docs: Endpoints relating to Contact objects "types": { "ContainerListResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -15896,6 +16068,7 @@ docs: Endpoints relating to Contact objects }, "ContainerListResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -15908,6 +16081,7 @@ docs: Endpoints relating to Contact objects }, "ContainerShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -15931,6 +16105,7 @@ types: data: optional> source: openapi: ../openapi.yml + inline: true ContainerListResponse: properties: _object: optional @@ -16334,6 +16509,7 @@ docs: Endpoints relating to Container objects "types": { "OceanContainerLegsIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -16346,6 +16522,7 @@ docs: Endpoints relating to Container objects }, "OceanContainerLegsIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -16358,6 +16535,7 @@ docs: Endpoints relating to Container objects }, "OceanContainerLegsShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -16381,6 +16559,7 @@ types: data: optional> source: openapi: ../openapi.yml + inline: true OceanContainerLegsIndexResponse: properties: _object: optional @@ -16674,6 +16853,7 @@ docs: Endpoints relating to ContainerLeg objects "types": { "CustomsEntriesShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -16686,6 +16866,7 @@ docs: Endpoints relating to ContainerLeg objects }, "CustomsEntryIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -16698,6 +16879,7 @@ docs: Endpoints relating to ContainerLeg objects }, "CustomsEntryIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -16721,6 +16903,7 @@ types: data: optional> source: openapi: ../openapi.yml + inline: true CustomsEntryIndexResponse: properties: _object: optional @@ -17109,6 +17292,7 @@ docs: Endpoints relating to Customs Entry objects "types": { "DocumentsCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -17121,6 +17305,7 @@ docs: Endpoints relating to Customs Entry objects }, "DocumentsIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -17133,6 +17318,7 @@ docs: Endpoints relating to Customs Entry objects }, "DocumentsIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -17146,6 +17332,7 @@ docs: Endpoints relating to Customs Entry objects }, "DocumentsShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -17170,6 +17357,7 @@ types: data: optional> source: openapi: ../openapi.yml + inline: true DocumentsIndexResponse: properties: _object: optional @@ -17640,6 +17828,7 @@ docs: Endpoints relating to Document objects }, "EventsIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -17652,6 +17841,7 @@ docs: Endpoints relating to Document objects }, "EventsIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -17664,6 +17854,7 @@ docs: Endpoints relating to Document objects }, "EventsShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -17701,6 +17892,7 @@ docs: Endpoints relating to Document objects data: optional> source: openapi: ../openapi.yml + inline: true EventsIndexResponse: properties: _object: optional @@ -18543,6 +18735,7 @@ Other details about this invoice", }, "InvoiceIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -18555,6 +18748,7 @@ Other details about this invoice", }, "InvoiceIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -18567,6 +18761,7 @@ Other details about this invoice", }, "InvoicesShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -18603,6 +18798,7 @@ Other details about this invoice", data: optional> source: openapi: ../openapi.yml + inline: true InvoiceIndexResponse: properties: _object: optional @@ -19541,6 +19737,7 @@ docs: Endpoints relating to Invoice objects "types": { "LocationIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -19553,6 +19750,7 @@ docs: Endpoints relating to Invoice objects }, "LocationIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -19566,6 +19764,7 @@ docs: Endpoints relating to Invoice objects }, "LocationUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -19578,6 +19777,7 @@ docs: Endpoints relating to Invoice objects }, "NetworkLocationCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -19590,6 +19790,7 @@ docs: Endpoints relating to Invoice objects }, "NetworkLocationShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -19614,6 +19815,7 @@ types: data: optional> source: openapi: ../openapi.yml + inline: true LocationIndexResponse: properties: _object: optional @@ -20131,6 +20333,7 @@ docs: Endpoints relating to Location objects }, "PortsIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -20143,6 +20346,7 @@ docs: Endpoints relating to Location objects }, "PortsIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>>", @@ -20174,6 +20378,7 @@ docs: Endpoints relating to Location objects data: optional>> source: openapi: ../openapi.yml + inline: true PortsIndexResponse: properties: _object: optional @@ -20707,6 +20912,7 @@ docs: Endpoints relating to Ports objects "types": { "ProductCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -20719,6 +20925,7 @@ docs: Endpoints relating to Ports objects }, "ProductIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -20731,6 +20938,7 @@ docs: Endpoints relating to Ports objects }, "ProductIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -20743,6 +20951,7 @@ docs: Endpoints relating to Ports objects }, "ProductShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -20755,6 +20964,7 @@ docs: Endpoints relating to Ports objects }, "ProductUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -20778,6 +20988,7 @@ types: data: optional> source: openapi: ../openapi.yml + inline: true ProductIndexResponse: properties: _object: optional @@ -22175,6 +22386,7 @@ docs: Endpoints relating to Product objects }, "PurchaseOrderIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -22187,6 +22399,7 @@ docs: Endpoints relating to Product objects }, "PurchaseOrderIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -22199,6 +22412,7 @@ docs: Endpoints relating to Product objects }, "PurchaseOrderShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -22250,6 +22464,7 @@ docs: Endpoints relating to Product objects data: optional> source: openapi: ../openapi.yml + inline: true PurchaseOrderIndexResponse: properties: _object: optional @@ -23455,6 +23670,7 @@ docs: >- }, "PurchaseOrderLineItemIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -23467,6 +23683,7 @@ docs: >- }, "PurchaseOrderLineItemIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -23479,6 +23696,7 @@ docs: >- }, "PurchaseOrderLineItemShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -23507,6 +23725,7 @@ docs: >- data: optional> source: openapi: ../openapi.yml + inline: true PurchaseOrderLineItemIndexResponse: properties: _object: optional @@ -25075,6 +25294,7 @@ docs: >- }, "ShipmentIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -25087,6 +25307,7 @@ docs: >- }, "ShipmentIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -25099,6 +25320,7 @@ docs: >- }, "ShipmentShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -25111,6 +25333,7 @@ docs: >- }, "ShipmentUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -25123,6 +25346,7 @@ docs: >- }, "ShipmentsShareableResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -25135,6 +25359,7 @@ docs: >- }, "ShipmentsShareableResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "shipments": "optional>", @@ -25145,6 +25370,7 @@ docs: >- }, "ShipmentsShareableResponseDataShipmentsItem": { "docs": undefined, + "inline": true, "properties": { "expiration_date": "optional", "shareable_url": "optional", @@ -25182,6 +25408,7 @@ docs: >- data: optional> source: openapi: ../openapi.yml + inline: true ShipmentIndexResponse: properties: _object: optional @@ -25213,12 +25440,14 @@ docs: >- expiration_date: optional source: openapi: ../openapi.yml + inline: true ShipmentsShareableResponseData: properties: _object: optional shipments: optional> source: openapi: ../openapi.yml + inline: true ShipmentsShareableResponse: properties: _object: optional @@ -26642,6 +26871,7 @@ docs: Endpoints relating to Shipment objects "types": { "ShipmentLegIndexResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -26654,6 +26884,7 @@ docs: Endpoints relating to Shipment objects }, "ShipmentLegIndexResponseData": { "docs": undefined, + "inline": true, "properties": { "_object": "optional", "data": "optional>", @@ -26666,6 +26897,7 @@ docs: Endpoints relating to Shipment objects }, "ShipmentLegShowResponse": { "docs": undefined, + "inline": undefined, "properties": { "_object": "optional", "data": "optional", @@ -26689,6 +26921,7 @@ types: data: optional> source: openapi: ../openapi.yml + inline: true ShipmentLegIndexResponse: properties: _object: optional diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/float.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/float.json index 3f9e90b448d..4eef66bfac5 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/float.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/float.json @@ -55,6 +55,7 @@ "Response": { "docs": "A generic response type used throughout the API. ", + "inline": undefined, "properties": { "id": "optional", "value": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/hathora.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/hathora.json index 752e05f7853..183a789bdf1 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/hathora.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/hathora.json @@ -82,6 +82,7 @@ "types": { "ActiveConnectionInfo": { "docs": undefined, + "inline": undefined, "properties": { "host": "string", "port": "double", @@ -94,6 +95,7 @@ }, "AppConfig": { "docs": undefined, + "inline": undefined, "properties": { "appName": { "type": "string", @@ -112,6 +114,7 @@ }, "AppConfigAuthConfiguration": { "docs": undefined, + "inline": true, "properties": { "anonymous": "optional", "google": "optional", @@ -123,6 +126,7 @@ }, "AppConfigAuthConfigurationGoogle": { "docs": undefined, + "inline": true, "properties": { "clientId": "string", }, @@ -133,6 +137,7 @@ "AppId": "string", "Application": { "docs": undefined, + "inline": undefined, "properties": { "appId": "string", "appName": "string", @@ -150,6 +155,7 @@ }, "ApplicationAuthConfiguration": { "docs": undefined, + "inline": true, "properties": { "anonymous": "optional", "google": "optional", @@ -161,6 +167,7 @@ }, "ApplicationAuthConfigurationGoogle": { "docs": undefined, + "inline": true, "properties": { "clientId": "string", }, @@ -173,6 +180,7 @@ "extends": [ "Application", ], + "inline": undefined, "properties": { "deployment": "Deployment", }, @@ -182,6 +190,7 @@ }, "Build": { "docs": undefined, + "inline": undefined, "properties": { "appId": "AppId", "buildId": "BuildId", @@ -201,6 +210,7 @@ "BuildId": "double", "BuildRegionalContainerTagsItem": { "docs": undefined, + "inline": true, "properties": { "containerTag": "string", "region": "Region", @@ -239,6 +249,7 @@ "extends": [ "DeploymentConfig", ], + "inline": undefined, "properties": { "appId": "AppId", "buildId": "BuildId", @@ -254,6 +265,7 @@ }, "DeploymentConfig": { "docs": undefined, + "inline": undefined, "properties": { "containerPort": { "type": "integer", @@ -285,6 +297,7 @@ }, "DeploymentConfigEnvItem": { "docs": undefined, + "inline": true, "properties": { "name": { "type": "string", @@ -313,6 +326,7 @@ "DiscoveryResponse": "list", "DiscoveryResponseItem": { "docs": undefined, + "inline": undefined, "properties": { "host": "string", "port": "double", @@ -324,6 +338,7 @@ }, "Lobby": { "docs": undefined, + "inline": undefined, "properties": { "appId": "AppId", "createdAt": "datetime", @@ -362,6 +377,7 @@ }, "MetricValue": { "docs": undefined, + "inline": undefined, "properties": { "timestamp": "double", "value": "double", @@ -378,6 +394,7 @@ "OrgId": "string", "PickRoomExcludeKeyofRoomAllocations": { "docs": "From T, pick a set of properties whose keys are in the union K", + "inline": undefined, "properties": { "appId": "AppId", "currentAllocation": "optional", @@ -401,6 +418,7 @@ }, "Process": { "docs": undefined, + "inline": undefined, "properties": { "activeConnections": "double", "appId": "AppId", @@ -429,6 +447,7 @@ "extends": [ "Process", ], + "inline": undefined, "properties": { "rooms": "list", "totalRooms": "double", @@ -439,6 +458,7 @@ }, "RecordPartialMetricNameMetricValueArray": { "docs": "Construct a type with a set of properties K of type T", + "inline": undefined, "properties": { "cpu": "optional>", "memory": "optional>", @@ -451,6 +471,7 @@ }, "RecordStringNever": { "docs": "Construct a type with a set of properties K of type T", + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.json", @@ -475,6 +496,7 @@ }, "Room": { "docs": undefined, + "inline": undefined, "properties": { "allocations": "list", "appId": "AppId", @@ -488,6 +510,7 @@ }, "RoomAllocation": { "docs": undefined, + "inline": undefined, "properties": { "processId": "ProcessId", "roomAllocationId": "RoomAllocationId", @@ -514,6 +537,7 @@ "RoomWithoutAllocations": "OmitRoomAllocations", "StartingConnectionInfo": { "docs": undefined, + "inline": undefined, "properties": { "roomId": "RoomId", }, @@ -592,6 +616,7 @@ types: clientId: string source: openapi: ../openapi.json + inline: true ApplicationAuthConfiguration: properties: google: optional @@ -599,6 +624,7 @@ types: anonymous: optional source: openapi: ../openapi.json + inline: true Application: properties: deletedBy: optional @@ -641,6 +667,7 @@ types: maxLength: 100 source: openapi: ../openapi.json + inline: true DeploymentConfig: properties: env: list @@ -686,6 +713,7 @@ types: clientId: string source: openapi: ../openapi.json + inline: true AppConfigAuthConfiguration: properties: google: optional @@ -693,6 +721,7 @@ types: anonymous: optional source: openapi: ../openapi.json + inline: true AppConfig: properties: authConfiguration: AppConfigAuthConfiguration @@ -723,6 +752,7 @@ types: region: Region source: openapi: ../openapi.json + inline: true BuildStatus: enum: - created @@ -1438,6 +1468,7 @@ service: "types": { "LoginAnonymousResponse": { "docs": undefined, + "inline": undefined, "properties": { "token": "string", }, @@ -1447,6 +1478,7 @@ service: }, "LoginGoogleResponse": { "docs": undefined, + "inline": undefined, "properties": { "token": "string", }, @@ -1456,6 +1488,7 @@ service: }, "LoginNicknameResponse": { "docs": undefined, + "inline": undefined, "properties": { "token": "string", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/hookdeck.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/hookdeck.json index b22acd31772..4fbbe7da936 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/hookdeck.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/hookdeck.json @@ -58,6 +58,7 @@ "types": { "AlertRule": { "docs": undefined, + "inline": undefined, "properties": { "strategy": "AlertStrategy", }, @@ -77,6 +78,7 @@ }, "ApiErrorResponse": { "docs": "Error response model", + "inline": undefined, "properties": { "code": { "docs": "Error code", @@ -98,6 +100,7 @@ }, "ApiErrorResponseData": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -105,6 +108,7 @@ }, "ApiKeyIntegrationConfigs": { "docs": undefined, + "inline": undefined, "properties": { "api_key": "string", "header_key": "string", @@ -115,6 +119,7 @@ }, "AttachedIntegrationToSource": { "docs": undefined, + "inline": undefined, "properties": { "success": "boolean", }, @@ -188,6 +193,7 @@ }, "BasicAuthIntegrationConfigs": { "docs": undefined, + "inline": undefined, "properties": { "name": "string", "password": "string", @@ -198,6 +204,7 @@ }, "BatchOperation": { "docs": undefined, + "inline": undefined, "properties": { "cancelled_at": { "docs": "Date the bulk retry was cancelled", @@ -263,6 +270,7 @@ }, "BatchOperationPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -274,6 +282,7 @@ }, "BatchOperationPlan": { "docs": undefined, + "inline": undefined, "properties": { "estimated_batch": { "docs": "Number of batches required to complete the bulk retry", @@ -296,6 +305,7 @@ "discriminated": false, "docs": "Query object to filter records", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -306,6 +316,7 @@ }, "Bookmark": { "docs": undefined, + "inline": undefined, "properties": { "alias": { "docs": "Alternate alias for the bookmark", @@ -351,6 +362,7 @@ }, "BookmarkPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -362,6 +374,7 @@ }, "Connection": { "docs": undefined, + "inline": undefined, "properties": { "archived_at": { "docs": "Date the connection was archived", @@ -411,6 +424,7 @@ "discriminated": false, "docs": "JSON using our filter syntax to filter on request headers", "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -423,6 +437,7 @@ }, "ConnectionFilterPropertyThree": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -430,6 +445,7 @@ }, "ConnectionPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -441,6 +457,7 @@ }, "ConsoleLine": { "docs": undefined, + "inline": undefined, "properties": { "message": "string", "type": "ConsoleLineType", @@ -463,6 +480,7 @@ }, "DelayRule": { "docs": undefined, + "inline": undefined, "properties": { "delay": { "docs": "Delay to introduce in MS", @@ -475,6 +493,7 @@ }, "DeletedBookmarkResponse": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "Bookmark ID", @@ -487,6 +506,7 @@ }, "DeletedIntegration": { "docs": undefined, + "inline": undefined, "properties": { "id": "string", }, @@ -496,6 +516,7 @@ }, "DeletedIssueTriggerResponse": { "docs": undefined, + "inline": undefined, "properties": { "id": "string", }, @@ -505,6 +526,7 @@ }, "DeliveryIssue": { "docs": "Delivery issue", + "inline": undefined, "properties": { "aggregation_keys": "DeliveryIssueAggregationKeys", "auto_resolved_at": "optional", @@ -554,6 +576,7 @@ }, "DeliveryIssueAggregationKeys": { "docs": "Keys used as the aggregation keys a 'delivery' type issue", + "inline": undefined, "properties": { "error_code": "list", "response_status": "list", @@ -565,6 +588,7 @@ }, "DeliveryIssueData": { "docs": "Delivery issue data", + "inline": undefined, "properties": { "trigger_attempt": "optional", "trigger_event": "optional", @@ -575,6 +599,7 @@ }, "DeliveryIssueReference": { "docs": "Reference to the event and attempt an issue is being created for.", + "inline": undefined, "properties": { "attempt_id": "string", "event_id": "string", @@ -585,6 +610,7 @@ }, "DeliveryIssueWithData": { "docs": "Delivery issue", + "inline": undefined, "properties": { "aggregation_keys": "DeliveryIssueAggregationKeys", "auto_resolved_at": "optional", @@ -635,6 +661,7 @@ }, "Destination": { "docs": "Associated [Destination](#destination-object) object", + "inline": undefined, "properties": { "archived_at": { "docs": "Date the destination was archived", @@ -681,6 +708,7 @@ }, "DestinationPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -704,6 +732,7 @@ }, "DetachedIntegrationFromSource": { "docs": undefined, + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -711,6 +740,7 @@ }, "Event": { "docs": undefined, + "inline": undefined, "properties": { "attempts": { "docs": "Number of delivery attempts made", @@ -784,6 +814,7 @@ "EventArray": "list", "EventAttempt": { "docs": undefined, + "inline": undefined, "properties": { "archived_at": { "docs": "Date the attempt was archived", @@ -861,6 +892,7 @@ }, "EventAttemptBody": { "docs": "Response body from the destination", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -868,6 +900,7 @@ }, "EventAttemptPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>>", @@ -879,6 +912,7 @@ }, "EventData": { "docs": undefined, + "inline": true, "properties": { "body": "optional", "headers": "optional", @@ -895,6 +929,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -906,6 +941,7 @@ }, "EventDataBodyOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -915,6 +951,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -927,6 +964,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -937,6 +975,7 @@ }, "EventDataParsedQueryOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -944,6 +983,7 @@ }, "EventPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -967,6 +1007,7 @@ }, "FilterRule": { "docs": undefined, + "inline": undefined, "properties": { "body": "optional", "headers": "optional", @@ -990,6 +1031,7 @@ }, "HandledHmacConfigs": { "docs": undefined, + "inline": undefined, "properties": { "webhook_secret_key": "string", }, @@ -1010,6 +1052,7 @@ }, "HmacIntegrationConfigs": { "docs": undefined, + "inline": undefined, "properties": { "algorithm": "HmacAlgorithms", "encoding": "HmacIntegrationConfigsEncoding", @@ -1031,6 +1074,7 @@ }, "IgnoredEvent": { "docs": undefined, + "inline": undefined, "properties": { "cause": "IgnoredEventCause", "created_at": "datetime", @@ -1060,6 +1104,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1070,6 +1115,7 @@ }, "IgnoredEventPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -1081,6 +1127,7 @@ }, "Integration": { "docs": undefined, + "inline": undefined, "properties": { "configs": { "docs": "Decrypted Key/Value object of the associated configuration for that provider", @@ -1124,6 +1171,7 @@ "discriminated": false, "docs": "Decrypted Key/Value object of the associated configuration for that provider", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1147,6 +1195,7 @@ }, "IntegrationPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -1206,6 +1255,7 @@ }, "IssueCount": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "Number of issues", @@ -1230,6 +1280,7 @@ }, "IssueTrigger": { "docs": undefined, + "inline": undefined, "properties": { "channels": "optional", "configs": "IssueTriggerReference", @@ -1269,6 +1320,7 @@ }, "IssueTriggerBackpressureConfigs": { "docs": "Configurations for a 'Backpressure' issue trigger", + "inline": undefined, "properties": { "delay": "IssueTriggerBackpressureDelay", "destinations": { @@ -1284,6 +1336,7 @@ "discriminated": false, "docs": "A pattern to match on the destination name or array of destination IDs. Use `*` as wildcard.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1305,6 +1358,7 @@ }, "IssueTriggerChannels": { "docs": "Notification channels object for the specific channel type", + "inline": undefined, "properties": { "email": "optional", "opsgenie": "optional", @@ -1316,6 +1370,7 @@ }, "IssueTriggerDeliveryConfigs": { "docs": "Configurations for a 'delivery' issue trigger", + "inline": undefined, "properties": { "connections": { "docs": "A pattern to match on the connection name or array of connection IDs. Use `*` as wildcard.", @@ -1331,6 +1386,7 @@ "discriminated": false, "docs": "A pattern to match on the connection name or array of connection IDs. Use `*` as wildcard.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1341,6 +1397,7 @@ }, "IssueTriggerEmailChannel": { "docs": "Email channel for an issue trigger", + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -1348,6 +1405,7 @@ }, "IssueTriggerIntegrationChannel": { "docs": "Integration channel for an issue trigger", + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -1355,6 +1413,7 @@ }, "IssueTriggerPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -1368,6 +1427,7 @@ "discriminated": false, "docs": "Configuration object for the specific issue type selected", "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -1379,6 +1439,7 @@ }, "IssueTriggerSlackChannel": { "docs": "Slack channel for an issue trigger", + "inline": undefined, "properties": { "channel_name": { "docs": "Channel name", @@ -1401,6 +1462,7 @@ }, "IssueTriggerTransformationConfigs": { "docs": "Configurations for a 'Transformation' issue trigger", + "inline": undefined, "properties": { "log_level": "TransformationExecutionLogLevel", "transformations": { @@ -1416,6 +1478,7 @@ "discriminated": false, "docs": "A pattern to match on the transformation name or array of transformation IDs. Use `*` as wildcard.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1451,6 +1514,7 @@ }, "IssueWithDataPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -1471,6 +1535,7 @@ }, "RawBody": { "docs": undefined, + "inline": undefined, "properties": { "body": "string", }, @@ -1480,6 +1545,7 @@ }, "Request": { "docs": undefined, + "inline": undefined, "properties": { "cli_events_count": { "docs": "The count of CLI events created from this request", @@ -1544,6 +1610,7 @@ }, "RequestData": { "docs": undefined, + "inline": true, "properties": { "body": "optional", "headers": "optional", @@ -1560,6 +1627,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1571,6 +1639,7 @@ }, "RequestDataBodyOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -1580,6 +1649,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1592,6 +1662,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1602,6 +1673,7 @@ }, "RequestDataParsedQueryOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -1619,6 +1691,7 @@ }, "RequestPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -1646,6 +1719,7 @@ }, "RetriedEvent": { "docs": undefined, + "inline": undefined, "properties": { "attempt": "optional", "event": "Event", @@ -1656,6 +1730,7 @@ }, "RetryRequest": { "docs": undefined, + "inline": undefined, "properties": { "events": "optional>", "request": "Request", @@ -1666,6 +1741,7 @@ }, "RetryRule": { "docs": undefined, + "inline": undefined, "properties": { "count": { "docs": "Maximum number of retries to attempt", @@ -1710,6 +1786,7 @@ }, "Ruleset": { "docs": "Associated [Ruleset](#ruleset-object) object", + "inline": undefined, "properties": { "archived_at": { "docs": "Date the ruleset was archived", @@ -1750,6 +1827,7 @@ }, "RulesetPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>>", @@ -1761,6 +1839,7 @@ }, "SeekPagination": { "docs": undefined, + "inline": undefined, "properties": { "dir": "optional", "limit": "optional", @@ -1776,6 +1855,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1788,6 +1868,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1798,6 +1879,7 @@ }, "ShopifyIntegrationConfigs": { "docs": undefined, + "inline": undefined, "properties": { "api_key": "optional", "api_secret": "optional", @@ -1821,6 +1903,7 @@ }, "ShortEventData": { "docs": undefined, + "inline": undefined, "properties": { "body": "optional", "headers": "optional", @@ -1837,6 +1920,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1848,6 +1932,7 @@ }, "ShortEventDataBodyOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -1857,6 +1942,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1869,6 +1955,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1879,6 +1966,7 @@ }, "ShortEventDataParsedQueryOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -1886,6 +1974,7 @@ }, "Source": { "docs": "Associated [Source](#source-object) object", + "inline": undefined, "properties": { "archived_at": { "docs": "Date the source was archived", @@ -1930,6 +2019,7 @@ }, "SourceIntegration": { "docs": "Integration object", + "inline": true, "properties": { "features": { "docs": "List of enabled features", @@ -1951,6 +2041,7 @@ }, "SourcePaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -1962,6 +2053,7 @@ }, "ToggleWebhookNotifications": { "docs": undefined, + "inline": undefined, "properties": { "enabled": "boolean", "source_id": "string", @@ -1997,6 +2089,7 @@ }, "TransformFull": { "docs": undefined, + "inline": undefined, "properties": { "transformation": { "docs": "You can optionally define a new transformation while creating a transform rule", @@ -2017,6 +2110,7 @@ }, "TransformFullTransformation": { "docs": "You can optionally define a new transformation while creating a transform rule", + "inline": true, "properties": { "code": { "docs": "A string representation of your JavaScript (ES6) code to run", @@ -2037,6 +2131,7 @@ }, "TransformReference": { "docs": undefined, + "inline": undefined, "properties": { "transformation_id": { "docs": "ID of the attached transformation object. Optional input, always set once the rule is defined", @@ -2055,6 +2150,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -2065,6 +2161,7 @@ }, "Transformation": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "JavaScript code to be executed", @@ -2103,6 +2200,7 @@ }, "TransformationExecution": { "docs": undefined, + "inline": undefined, "properties": { "created_at": "datetime", "id": "string", @@ -2137,6 +2235,7 @@ }, "TransformationExecutionPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -2148,6 +2247,7 @@ }, "TransformationExecutorOutput": { "docs": undefined, + "inline": undefined, "properties": { "console": "optional>", "execution_id": "optional", @@ -2162,6 +2262,7 @@ }, "TransformationExecutorOutputRequest": { "docs": undefined, + "inline": true, "properties": { "body": "optional", "headers": "optional", @@ -2177,6 +2278,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -2187,6 +2289,7 @@ }, "TransformationExecutorOutputRequestBodyOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -2196,6 +2299,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -2208,6 +2312,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -2218,6 +2323,7 @@ }, "TransformationExecutorOutputRequestParsedQueryOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -2227,6 +2333,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -2237,6 +2344,7 @@ }, "TransformationExecutorOutputRequestQueryZero": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -2244,6 +2352,7 @@ }, "TransformationFailedMeta": { "docs": undefined, + "inline": undefined, "properties": { "transformation_id": "string", }, @@ -2253,6 +2362,7 @@ }, "TransformationIssue": { "docs": "Transformation issue", + "inline": undefined, "properties": { "aggregation_keys": "TransformationIssueAggregationKeys", "auto_resolved_at": "optional", @@ -2302,6 +2412,7 @@ }, "TransformationIssueAggregationKeys": { "docs": "Keys used as the aggregation keys a 'transformation' type issue", + "inline": undefined, "properties": { "log_level": "TransformationExecutionLogLevel", "transformation_id": "list", @@ -2312,6 +2423,7 @@ }, "TransformationIssueData": { "docs": "Transformation issue data", + "inline": undefined, "properties": { "transformation_execution": "TransformationExecution", "trigger_attempt": "optional", @@ -2322,6 +2434,7 @@ }, "TransformationIssueReference": { "docs": "Reference to the event request transformation an issue is being created for.", + "inline": undefined, "properties": { "transformation_execution_id": "string", "trigger_event_request_transformation_id": { @@ -2335,6 +2448,7 @@ }, "TransformationIssueWithData": { "docs": "Transformation issue", + "inline": undefined, "properties": { "aggregation_keys": "TransformationIssueAggregationKeys", "auto_resolved_at": "optional", @@ -2385,6 +2499,7 @@ }, "TransformationPaginatedResult": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "models": "optional>", @@ -2438,6 +2553,7 @@ types: - list source: openapi: ../openapi.yml + inline: true SeekPaginationDir: discriminated: false union: @@ -2445,6 +2561,7 @@ types: - list source: openapi: ../openapi.yml + inline: true SeekPagination: properties: order_by: optional @@ -2479,6 +2596,7 @@ types: - list source: openapi: ../openapi.yml + inline: true IssueTriggerDeliveryConfigs: docs: Configurations for a 'delivery' issue trigger properties: @@ -2510,6 +2628,7 @@ types: - list source: openapi: ../openapi.yml + inline: true IssueTriggerTransformationConfigs: docs: Configurations for a 'Transformation' issue trigger properties: @@ -2539,6 +2658,7 @@ types: - list source: openapi: ../openapi.yml + inline: true IssueTriggerBackpressureConfigs: docs: Configurations for a 'Backpressure' issue trigger properties: @@ -2624,6 +2744,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true ApiErrorResponse: docs: Error response model properties: @@ -2701,6 +2822,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true EventAttempt: properties: id: @@ -2773,6 +2895,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true ShortEventDataParsedQuery: discriminated: false union: @@ -2780,6 +2903,7 @@ types: - ShortEventDataParsedQueryOne source: openapi: ../openapi.yml + inline: true ShortEventDataHeaders: discriminated: false union: @@ -2787,10 +2911,12 @@ types: - map> source: openapi: ../openapi.yml + inline: true ShortEventDataBodyOne: properties: {} source: openapi: ../openapi.yml + inline: true ShortEventDataBody: discriminated: false union: @@ -2799,6 +2925,7 @@ types: - list source: openapi: ../openapi.yml + inline: true ShortEventData: properties: path: string @@ -2861,6 +2988,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true EventDataParsedQuery: discriminated: false union: @@ -2868,6 +2996,7 @@ types: - EventDataParsedQueryOne source: openapi: ../openapi.yml + inline: true EventDataHeaders: discriminated: false union: @@ -2875,10 +3004,12 @@ types: - map> source: openapi: ../openapi.yml + inline: true EventDataBodyOne: properties: {} source: openapi: ../openapi.yml + inline: true EventDataBody: discriminated: false union: @@ -2887,6 +3018,7 @@ types: - list source: openapi: ../openapi.yml + inline: true EventData: properties: path: string @@ -2897,6 +3029,7 @@ types: is_large_payload: optional source: openapi: ../openapi.yml + inline: true Event: properties: id: @@ -3036,6 +3169,7 @@ types: - optional source: openapi: ../openapi.yml + inline: true BatchOperation: properties: id: @@ -3207,6 +3341,7 @@ types: - ShopifyIntegrationConfigs source: openapi: ../openapi.yml + inline: true Integration: properties: id: @@ -3552,6 +3687,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true RequestDataParsedQuery: discriminated: false union: @@ -3559,6 +3695,7 @@ types: - RequestDataParsedQueryOne source: openapi: ../openapi.yml + inline: true RequestDataHeaders: discriminated: false union: @@ -3566,10 +3703,12 @@ types: - map> source: openapi: ../openapi.yml + inline: true RequestDataBodyOne: properties: {} source: openapi: ../openapi.yml + inline: true RequestDataBody: discriminated: false union: @@ -3578,6 +3717,7 @@ types: - list source: openapi: ../openapi.yml + inline: true RequestData: properties: path: string @@ -3588,6 +3728,7 @@ types: is_large_payload: optional source: openapi: ../openapi.yml + inline: true Request: properties: id: @@ -3678,6 +3819,7 @@ types: - TransformationFailedMeta source: openapi: ../openapi.yml + inline: true IgnoredEvent: properties: id: string @@ -3731,6 +3873,7 @@ types: properties: {} source: openapi: ../openapi.yml + inline: true ConnectionFilterProperty: discriminated: false docs: JSON using our filter syntax to filter on request headers @@ -3779,6 +3922,7 @@ types: your transformation code source: openapi: ../openapi.yml + inline: true TransformFull: properties: type: @@ -3872,6 +4016,7 @@ types: type: list source: openapi: ../openapi.yml + inline: true Source: docs: Associated [Source](#source-object) object properties: @@ -3972,10 +4117,12 @@ types: - map source: openapi: ../openapi.yml + inline: true TransformationExecutorOutputRequestQueryZero: properties: {} source: openapi: ../openapi.yml + inline: true TransformationExecutorOutputRequestQuery: discriminated: false union: @@ -3983,10 +4130,12 @@ types: - string source: openapi: ../openapi.yml + inline: true TransformationExecutorOutputRequestParsedQueryOne: properties: {} source: openapi: ../openapi.yml + inline: true TransformationExecutorOutputRequestParsedQuery: discriminated: false union: @@ -3994,10 +4143,12 @@ types: - TransformationExecutorOutputRequestParsedQueryOne source: openapi: ../openapi.yml + inline: true TransformationExecutorOutputRequestBodyOne: properties: {} source: openapi: ../openapi.yml + inline: true TransformationExecutorOutputRequestBody: discriminated: false union: @@ -4005,6 +4156,7 @@ types: - TransformationExecutorOutputRequestBodyOne source: openapi: ../openapi.yml + inline: true TransformationExecutorOutputRequest: properties: headers: optional @@ -4014,6 +4166,7 @@ types: body: optional source: openapi: ../openapi.yml + inline: true TransformationExecutorOutput: properties: request_id: optional @@ -5498,6 +5651,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "types": { "CreateEventBulkRetryRequestQuery": { "docs": "Filter properties for the events to be included in the bulk retry", + "inline": true, "properties": { "attempts": { "docs": "Filter by number of attempts", @@ -5573,6 +5727,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "Filter by number of attempts", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -5592,6 +5747,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. }, "CreateEventBulkRetryRequestQueryAttemptsAny": { "docs": undefined, + "inline": true, "properties": { "any": "optional", "contains": { @@ -5653,6 +5809,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "URL Encoded string of the JSON to match to the data body", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -5663,6 +5820,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. }, "CreateEventBulkRetryRequestQueryBodyOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -5672,6 +5830,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -5692,6 +5851,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "Filter by CLI IDs. `?[any]=true` operator for any CLI.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -5703,6 +5863,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. }, "CreateEventBulkRetryRequestQueryCliIdAny": { "docs": undefined, + "inline": true, "properties": { "any": "optional", }, @@ -5714,6 +5875,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -5726,6 +5888,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "Filter by `created_at` date using a date operator", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -5736,6 +5899,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. }, "CreateEventBulkRetryRequestQueryCreatedAtAny": { "docs": undefined, + "inline": true, "properties": { "any": "optional", "gt": "optional", @@ -5751,6 +5915,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "Filter by destination IDs", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -5772,6 +5937,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -5792,6 +5958,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -5812,6 +5979,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "URL Encoded string of the JSON to match to the data headers", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -5822,6 +5990,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. }, "CreateEventBulkRetryRequestQueryHeadersOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -5831,6 +6000,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "Filter by event IDs", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -5852,6 +6022,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -5872,6 +6043,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "Filter by `last_attempt_at` date using a date operator", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -5882,6 +6054,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. }, "CreateEventBulkRetryRequestQueryLastAttemptAtAny": { "docs": undefined, + "inline": true, "properties": { "any": "optional", "gt": "optional", @@ -5897,6 +6070,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "URL Encoded string of the JSON to match to the parsed query (JSON representation of the query)", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -5907,6 +6081,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. }, "CreateEventBulkRetryRequestQueryParsedQueryOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -5916,6 +6091,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "Filter by HTTP response status code", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -5936,6 +6112,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. }, "CreateEventBulkRetryRequestQueryResponseStatusAny": { "docs": undefined, + "inline": true, "properties": { "any": "optional", "contains": { @@ -5997,6 +6174,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "Filter by source IDs", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -6018,6 +6196,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "Lifecyle status of the event", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -6030,6 +6209,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "Filter by `successful_at` date using a date operator", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -6040,6 +6220,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. }, "CreateEventBulkRetryRequestQuerySuccessfulAtAny": { "docs": undefined, + "inline": true, "properties": { "any": "optional", "gt": "optional", @@ -6055,6 +6236,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. "discriminated": false, "docs": "Filter by webhook connection IDs", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -6104,6 +6286,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryStatus: discriminated: false docs: Lifecyle status of the event @@ -6112,6 +6295,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryIssueId: discriminated: false union: @@ -6121,6 +6305,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryWebhookId: discriminated: false docs: Filter by webhook connection IDs @@ -6132,6 +6317,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryDestinationId: discriminated: false docs: Filter by destination IDs @@ -6143,6 +6329,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQuerySourceId: discriminated: false docs: Filter by source IDs @@ -6154,6 +6341,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryAttemptsAny: properties: gt: @@ -6179,6 +6367,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. min: 0 source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryAttempts: discriminated: false docs: Filter by number of attempts @@ -6189,6 +6378,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - CreateEventBulkRetryRequestQueryAttemptsAny source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryResponseStatusAny: properties: gt: @@ -6219,6 +6409,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. max: 600 source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryResponseStatus: discriminated: false docs: Filter by HTTP response status code @@ -6231,6 +6422,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQuerySuccessfulAtAny: properties: gt: optional @@ -6240,6 +6432,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. any: optional source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQuerySuccessfulAt: discriminated: false docs: Filter by `successful_at` date using a date operator @@ -6248,6 +6441,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - CreateEventBulkRetryRequestQuerySuccessfulAtAny source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryCreatedAtAny: properties: gt: optional @@ -6257,6 +6451,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. any: optional source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryCreatedAt: discriminated: false docs: Filter by `created_at` date using a date operator @@ -6265,6 +6460,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - CreateEventBulkRetryRequestQueryCreatedAtAny source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryErrorCode: discriminated: false union: @@ -6274,11 +6470,13 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryCliIdAny: properties: any: optional source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryCliId: discriminated: false docs: Filter by CLI IDs. `?[any]=true` operator for any CLI. @@ -6288,6 +6486,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryCliUserId: discriminated: false union: @@ -6295,6 +6494,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryLastAttemptAtAny: properties: gt: optional @@ -6304,6 +6504,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. any: optional source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryLastAttemptAt: discriminated: false docs: Filter by `last_attempt_at` date using a date operator @@ -6312,6 +6513,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - CreateEventBulkRetryRequestQueryLastAttemptAtAny source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryEventDataId: discriminated: false union: @@ -6321,10 +6523,12 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryHeadersOne: properties: {} source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryHeaders: discriminated: false docs: URL Encoded string of the JSON to match to the data headers @@ -6333,10 +6537,12 @@ docs: A bookmark lets you conveniently store and replay a specific request. - CreateEventBulkRetryRequestQueryHeadersOne source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryBodyOne: properties: {} source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryBody: discriminated: false docs: URL Encoded string of the JSON to match to the data body @@ -6345,10 +6551,12 @@ docs: A bookmark lets you conveniently store and replay a specific request. - CreateEventBulkRetryRequestQueryBodyOne source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryParsedQueryOne: properties: {} source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryParsedQuery: discriminated: false docs: >- @@ -6359,6 +6567,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - CreateEventBulkRetryRequestQueryParsedQueryOne source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQueryBulkRetryId: discriminated: false union: @@ -6368,6 +6577,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. - list source: openapi: ../openapi.yml + inline: true CreateEventBulkRetryRequestQuery: docs: Filter properties for the events to be included in the bulk retry properties: @@ -6425,6 +6635,7 @@ docs: A bookmark lets you conveniently store and replay a specific request. docs: URL Encoded string of the string to match partially to the path source: openapi: ../openapi.yml + inline: true imports: root: __package__.yml service: @@ -6921,6 +7132,7 @@ docs: '' "types": { "CreateIgnoredEventBulkRetryRequestQuery": { "docs": "Filter by the bulk retry ignored event query object", + "inline": true, "properties": { "cause": { "docs": "The cause of the ignored event", @@ -6949,6 +7161,7 @@ docs: '' "discriminated": false, "docs": "The cause of the ignored event", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -6969,6 +7182,7 @@ docs: '' "discriminated": false, "docs": "Connection ID of the ignored event", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -7016,6 +7230,7 @@ docs: '' - list source: openapi: ../openapi.yml + inline: true CreateIgnoredEventBulkRetryRequestQueryWebhookId: discriminated: false docs: Connection ID of the ignored event @@ -7026,6 +7241,7 @@ docs: '' - list source: openapi: ../openapi.yml + inline: true CreateIgnoredEventBulkRetryRequestQuery: docs: Filter by the bulk retry ignored event query object properties: @@ -7044,6 +7260,7 @@ docs: '' maxLength: 255 source: openapi: ../openapi.yml + inline: true imports: root: __package__.yml service: @@ -7538,6 +7755,7 @@ docs: '' "types": { "CreateRequestBulkRetryRequestQuery": { "docs": "Filter properties for the events to be included in the bulk retry, use query parameters of [Requests](#requests)", + "inline": true, "properties": { "body": { "docs": "URL Encoded string of the JSON to match to the data body", @@ -7586,6 +7804,7 @@ docs: '' "discriminated": false, "docs": "URL Encoded string of the JSON to match to the data body", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -7596,6 +7815,7 @@ docs: '' }, "CreateRequestBulkRetryRequestQueryBodyOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -7605,6 +7825,7 @@ docs: '' "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -7625,6 +7846,7 @@ docs: '' "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -7635,6 +7857,7 @@ docs: '' }, "CreateRequestBulkRetryRequestQueryCreatedAtAny": { "docs": undefined, + "inline": true, "properties": { "any": "optional", "gt": "optional", @@ -7650,6 +7873,7 @@ docs: '' "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -7670,6 +7894,7 @@ docs: '' }, "CreateRequestBulkRetryRequestQueryEventsCountAny": { "docs": undefined, + "inline": true, "properties": { "any": "optional", "contains": { @@ -7731,6 +7956,7 @@ docs: '' "discriminated": false, "docs": "URL Encoded string of the JSON to match to the data headers", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -7741,6 +7967,7 @@ docs: '' }, "CreateRequestBulkRetryRequestQueryHeadersOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -7750,6 +7977,7 @@ docs: '' "discriminated": false, "docs": "Filter by requests IDs", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -7771,6 +7999,7 @@ docs: '' "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -7791,6 +8020,7 @@ docs: '' }, "CreateRequestBulkRetryRequestQueryIgnoredCountAny": { "docs": undefined, + "inline": true, "properties": { "any": "optional", "contains": { @@ -7852,6 +8082,7 @@ docs: '' "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -7862,6 +8093,7 @@ docs: '' }, "CreateRequestBulkRetryRequestQueryIngestedAtAny": { "docs": undefined, + "inline": true, "properties": { "any": "optional", "gt": "optional", @@ -7877,6 +8109,7 @@ docs: '' "discriminated": false, "docs": "URL Encoded string of the JSON to match to the parsed query (JSON representation of the query)", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -7887,6 +8120,7 @@ docs: '' }, "CreateRequestBulkRetryRequestQueryParsedQueryOne": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -7896,6 +8130,7 @@ docs: '' "discriminated": false, "docs": "Filter by rejection cause", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -7907,6 +8142,7 @@ docs: '' }, "CreateRequestBulkRetryRequestQueryRejectionCauseAny": { "docs": undefined, + "inline": true, "properties": { "any": "optional", "contains": "optional", @@ -7923,6 +8159,7 @@ docs: '' "discriminated": false, "docs": "Filter by source IDs", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -7981,6 +8218,7 @@ docs: '' - list source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryStatus: enum: - accepted @@ -7997,6 +8235,7 @@ docs: '' contains: optional source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryRejectionCause: discriminated: false docs: Filter by rejection cause @@ -8006,6 +8245,7 @@ docs: '' - list source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryIgnoredCountAny: properties: gt: @@ -8031,6 +8271,7 @@ docs: '' min: 0 source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryIgnoredCount: discriminated: false union: @@ -8041,6 +8282,7 @@ docs: '' - list source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryEventsCountAny: properties: gt: @@ -8066,6 +8308,7 @@ docs: '' min: 0 source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryEventsCount: discriminated: false union: @@ -8076,6 +8319,7 @@ docs: '' - list source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQuerySourceId: discriminated: false docs: Filter by source IDs @@ -8087,10 +8331,12 @@ docs: '' - list source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryHeadersOne: properties: {} source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryHeaders: discriminated: false docs: URL Encoded string of the JSON to match to the data headers @@ -8099,10 +8345,12 @@ docs: '' - CreateRequestBulkRetryRequestQueryHeadersOne source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryBodyOne: properties: {} source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryBody: discriminated: false docs: URL Encoded string of the JSON to match to the data body @@ -8111,10 +8359,12 @@ docs: '' - CreateRequestBulkRetryRequestQueryBodyOne source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryParsedQueryOne: properties: {} source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryParsedQuery: discriminated: false docs: >- @@ -8125,6 +8375,7 @@ docs: '' - CreateRequestBulkRetryRequestQueryParsedQueryOne source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryCreatedAtAny: properties: gt: optional @@ -8134,6 +8385,7 @@ docs: '' any: optional source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryCreatedAt: discriminated: false union: @@ -8141,6 +8393,7 @@ docs: '' - CreateRequestBulkRetryRequestQueryCreatedAtAny source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryIngestedAtAny: properties: gt: optional @@ -8150,6 +8403,7 @@ docs: '' any: optional source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryIngestedAt: discriminated: false union: @@ -8157,6 +8411,7 @@ docs: '' - CreateRequestBulkRetryRequestQueryIngestedAtAny source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQueryBulkRetryId: discriminated: false union: @@ -8166,6 +8421,7 @@ docs: '' - list source: openapi: ../openapi.yml + inline: true CreateRequestBulkRetryRequestQuery: docs: >- Filter properties for the events to be included in the bulk retry, use @@ -8205,6 +8461,7 @@ docs: '' bulk_retry_id: optional source: openapi: ../openapi.yml + inline: true imports: root: __package__.yml service: @@ -9512,6 +9769,7 @@ docs: '' "types": { "CreateConnectionRequestDestination": { "docs": "Destination input object", + "inline": true, "properties": { "cli_path": { "docs": "Path for the CLI destination", @@ -9558,6 +9816,7 @@ docs: '' }, "CreateConnectionRequestRuleset": { "docs": "Ruleset input object", + "inline": true, "properties": { "is_team_default": "optional", "name": { @@ -9581,6 +9840,7 @@ docs: '' }, "CreateConnectionRequestSource": { "docs": "Source input object", + "inline": true, "properties": { "name": { "docs": "A unique name for the source", @@ -9610,6 +9870,7 @@ docs: '' }, "UpdateConnectionRequestRuleset": { "docs": "Ruleset input object", + "inline": true, "properties": { "is_team_default": "optional", "name": { @@ -9633,6 +9894,7 @@ docs: '' }, "UpsertConnectionRequestDestination": { "docs": "Destination input object", + "inline": true, "properties": { "cli_path": { "docs": "Path for the CLI destination", @@ -9679,6 +9941,7 @@ docs: '' }, "UpsertConnectionRequestRuleset": { "docs": "Ruleset input object", + "inline": true, "properties": { "is_team_default": "optional", "name": { @@ -9702,6 +9965,7 @@ docs: '' }, "UpsertConnectionRequestSource": { "docs": "Source input object", + "inline": true, "properties": { "name": { "docs": "A unique name for the source", @@ -9760,6 +10024,7 @@ docs: '' path_forwarding_disabled: optional source: openapi: ../openapi.yml + inline: true CreateConnectionRequestSource: docs: Source input object properties: @@ -9771,6 +10036,7 @@ docs: '' maxLength: 155 source: openapi: ../openapi.yml + inline: true CreateConnectionRequestRuleset: docs: Ruleset input object properties: @@ -9786,6 +10052,7 @@ docs: '' is_team_default: optional source: openapi: ../openapi.yml + inline: true UpsertConnectionRequestDestinationRateLimitPeriod: enum: - second @@ -9818,6 +10085,7 @@ docs: '' path_forwarding_disabled: optional source: openapi: ../openapi.yml + inline: true UpsertConnectionRequestSource: docs: Source input object properties: @@ -9829,6 +10097,7 @@ docs: '' maxLength: 155 source: openapi: ../openapi.yml + inline: true UpsertConnectionRequestRuleset: docs: Ruleset input object properties: @@ -9844,6 +10113,7 @@ docs: '' is_team_default: optional source: openapi: ../openapi.yml + inline: true UpdateConnectionRequestRuleset: docs: Ruleset input object properties: @@ -9859,6 +10129,7 @@ docs: '' is_team_default: optional source: openapi: ../openapi.yml + inline: true imports: root: __package__.yml service: @@ -12653,6 +12924,7 @@ docs: An event is any request that Hookdeck receives from a source. "discriminated": false, "docs": "Decrypted Key/Value object of the associated configuration for that provider", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -12668,6 +12940,7 @@ docs: An event is any request that Hookdeck receives from a source. "discriminated": false, "docs": "Decrypted Key/Value object of the associated configuration for that provider", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -12969,6 +13242,7 @@ types: - root.ShopifyIntegrationConfigs source: openapi: ../openapi.yml + inline: true UpdateIntegrationRequestConfigs: discriminated: false docs: >- @@ -12982,6 +13256,7 @@ types: - root.ShopifyIntegrationConfigs source: openapi: ../openapi.yml + inline: true ", }, "issueTriggers.yml": { @@ -13480,6 +13755,7 @@ types: "discriminated": false, "docs": "Configuration object for the specific issue type selected", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -13505,6 +13781,7 @@ types: "discriminated": false, "docs": "Configuration object for the specific issue type selected", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -13518,6 +13795,7 @@ types: "discriminated": false, "docs": "Configuration object for the specific issue type selected", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -13549,6 +13827,7 @@ types: - root.IssueTriggerBackpressureConfigs source: openapi: ../openapi.yml + inline: true UpsertIssueTriggerRequestConfigs: discriminated: false docs: Configuration object for the specific issue type selected @@ -13558,6 +13837,7 @@ types: - root.IssueTriggerBackpressureConfigs source: openapi: ../openapi.yml + inline: true UpdateIssueTriggerRequestConfigs: discriminated: false docs: Configuration object for the specific issue type selected @@ -13567,6 +13847,7 @@ types: - root.IssueTriggerBackpressureConfigs source: openapi: ../openapi.yml + inline: true service: auth: false base-path: '' @@ -18085,6 +18366,7 @@ docs: A source represents any third party that sends webhooks to Hookdeck. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -18126,6 +18408,7 @@ docs: A source represents any third party that sends webhooks to Hookdeck. }, "TestTransformationRequestEnv": { "docs": "Key-value environment variables to be passed to the transformation", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -18133,6 +18416,7 @@ docs: A source represents any third party that sends webhooks to Hookdeck. }, "TestTransformationRequestRequest": { "docs": "Request input to use for the transformation execution", + "inline": true, "properties": { "body": { "docs": "Body of the request", @@ -18163,6 +18447,7 @@ docs: A source represents any third party that sends webhooks to Hookdeck. "discriminated": false, "docs": "Body of the request", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -18173,6 +18458,7 @@ docs: A source represents any third party that sends webhooks to Hookdeck. }, "TestTransformationRequestRequestBodyZero": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -18180,6 +18466,7 @@ docs: A source represents any third party that sends webhooks to Hookdeck. }, "TestTransformationRequestRequestParsedQuery": { "docs": "JSON representation of the query params", + "inline": true, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -18189,6 +18476,7 @@ docs: A source represents any third party that sends webhooks to Hookdeck. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -18201,6 +18489,7 @@ docs: A source represents any third party that sends webhooks to Hookdeck. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -18226,6 +18515,7 @@ docs: A source represents any third party that sends webhooks to Hookdeck. - float source: openapi: ../openapi.yml + inline: true UpsertTransformationRequestEnvValue: discriminated: false union: @@ -18233,6 +18523,7 @@ docs: A source represents any third party that sends webhooks to Hookdeck. - float source: openapi: ../openapi.yml + inline: true UpdateTransformationRequestEnvValue: discriminated: false union: @@ -18240,15 +18531,18 @@ docs: A source represents any third party that sends webhooks to Hookdeck. - float source: openapi: ../openapi.yml + inline: true TestTransformationRequestEnv: docs: Key-value environment variables to be passed to the transformation properties: {} source: openapi: ../openapi.yml + inline: true TestTransformationRequestRequestBodyZero: properties: {} source: openapi: ../openapi.yml + inline: true TestTransformationRequestRequestBody: discriminated: false docs: Body of the request @@ -18257,11 +18551,13 @@ docs: A source represents any third party that sends webhooks to Hookdeck. - string source: openapi: ../openapi.yml + inline: true TestTransformationRequestRequestParsedQuery: docs: JSON representation of the query params properties: {} source: openapi: ../openapi.yml + inline: true TestTransformationRequestRequest: docs: Request input to use for the transformation execution properties: @@ -18282,6 +18578,7 @@ docs: A source represents any third party that sends webhooks to Hookdeck. docs: JSON representation of the query params source: openapi: ../openapi.yml + inline: true GetTransformationExecutionsRequestLogLevel: enum: - debug diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/humanloop.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/humanloop.json index eb6c0e1f9ee..0b640f69072 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/humanloop.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/humanloop.json @@ -22,6 +22,7 @@ "types": { "AgentConfigResponse": { "docs": undefined, + "inline": undefined, "properties": { "agent_class": { "docs": "Class of the agent.", @@ -67,6 +68,7 @@ "BooleanEvaluatorVersionStats": { "docs": "Base attributes for stats for an Evaluator Version-Evaluated Version pair in the Evaluation Report.", + "inline": undefined, "properties": { "evaluator_version_id": { "docs": "Unique identifier for the Evaluator Version.", @@ -103,6 +105,7 @@ in the Evaluation Report.", }, "CategoricalFeedbackLabel": { "docs": undefined, + "inline": undefined, "properties": { "sentiment": { "docs": "Whether the feedback sentiment is positive or negative.", @@ -120,6 +123,7 @@ in the Evaluation Report.", }, "ChatMessage": { "docs": undefined, + "inline": undefined, "properties": { "content": { "docs": "The content of the message.", @@ -166,6 +170,7 @@ in the Evaluation Report.", }, "ChatMessageWithToolCall": { "docs": undefined, + "inline": undefined, "properties": { "content": { "docs": "The content of the message.", @@ -229,6 +234,7 @@ in the Evaluation Report.", }, "CodeEvaluatorRequest": { "docs": undefined, + "inline": undefined, "properties": { "arguments_type": { "docs": "Whether this evaluator is target-free or target-required.", @@ -249,6 +255,7 @@ in the Evaluation Report.", }, "CommitRequest": { "docs": undefined, + "inline": undefined, "properties": { "commit_message": { "docs": "Message describing the changes made.", @@ -290,6 +297,7 @@ in the Evaluation Report.", "discriminated": false, "docs": "The content of the message.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -300,6 +308,7 @@ in the Evaluation Report.", }, "CreateDatapointRequest": { "docs": undefined, + "inline": undefined, "properties": { "inputs": { "docs": "The inputs to the prompt template.", @@ -322,6 +331,7 @@ in the Evaluation Report.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -340,6 +350,7 @@ in the Evaluation Report.", Evaluation benchmark your Prompt/Tool Versions. With the Datapoints in a Dataset Version, Logs corresponding to the Datapoint and each Evaluated Version are evaluated by the specified Evaluator Versions. Aggregated statistics are then calculated and presented in the Evaluation.", + "inline": undefined, "properties": { "dataset": { "docs": "The Dataset Version to use in this Evaluation.", @@ -360,6 +371,7 @@ Aggregated statistics are then calculated and presented in the Evaluation.", }, "CreatePromptLogResponse": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "String ID of log.", @@ -384,6 +396,7 @@ Aggregated statistics are then calculated and presented in the Evaluation.", }, "CreateToolLogResponse": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "String ID of log.", @@ -408,6 +421,7 @@ Aggregated statistics are then calculated and presented in the Evaluation.", }, "DashboardConfiguration": { "docs": undefined, + "inline": undefined, "properties": { "model_config_ids": { "type": "list", @@ -423,6 +437,7 @@ Aggregated statistics are then calculated and presented in the Evaluation.", }, "DatapointResponse": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "Unique identifier for the Datapoint. Starts with `dp_`.", @@ -449,6 +464,7 @@ Aggregated statistics are then calculated and presented in the Evaluation.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -463,6 +479,7 @@ Aggregated statistics are then calculated and presented in the Evaluation.", }, "DatasetRequest": { "docs": undefined, + "inline": undefined, "properties": { "version_id": { "docs": "Unique identifier for the Dataset Version to use in this evaluation. Starts with `dsv_`.", @@ -478,6 +495,7 @@ Aggregated statistics are then calculated and presented in the Evaluation.", Attributes defined here are common to all File Responses and should be overridden in the inheriting classes with documentation and appropriate Field definitions.", + "inline": undefined, "properties": { "commit_message": { "docs": "Message describing the changes made. If provided, a committed version of the Dataset is created. Otherwise, an uncommitted version is created.", @@ -531,6 +549,7 @@ in the inheriting classes with documentation and appropriate Field definitions." }, "EnvironmentResponse": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "type": "datetime", @@ -559,6 +578,7 @@ in the inheriting classes with documentation and appropriate Field definitions." "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -573,6 +593,7 @@ in the inheriting classes with documentation and appropriate Field definitions." }, "EvaluateeRequest": { "docs": undefined, + "inline": undefined, "properties": { "batch_id": { "docs": "Unique identifier for the batch of Logs to include in the Evaluation Report.", @@ -594,6 +615,7 @@ in the inheriting classes with documentation and appropriate Field definitions." }, "EvaluateeResponse": { "docs": undefined, + "inline": undefined, "properties": { "batch_id": { "docs": "Unique identifier for the batch of Logs to include in the Evaluation Report. ", @@ -615,6 +637,7 @@ in the inheriting classes with documentation and appropriate Field definitions." "docs": "This is similar to an `EvaluationResult` but is ephemeral as it is only for synchronous debug runs. It does not have an ID, or a reference to an evaluation run or even an evaluation function.", + "inline": undefined, "properties": { "datapoint_id": { "type": "optional", @@ -639,6 +662,7 @@ function.", }, "EvaluationEvaluatorResponse": { "docs": undefined, + "inline": undefined, "properties": { "orchestrated": { "docs": "Whether the Evaluator is orchestrated by Humanloop. Default is `True`. If `False`, a log for the Evaluator should be submitted by the user via the API.", @@ -654,6 +678,7 @@ function.", }, "EvaluationResponse": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "type": "datetime", @@ -697,6 +722,7 @@ function.", }, "EvaluationResultResponse": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "type": "datetime", @@ -736,6 +762,7 @@ function.", }, "EvaluationStats": { "docs": undefined, + "inline": undefined, "properties": { "overall_stats": { "docs": "Stats for the Evaluation Report as a whole.", @@ -765,6 +792,7 @@ function.", }, "EvaluatorActivationDeactivationRequest": { "docs": undefined, + "inline": undefined, "properties": { "evaluators_to_activate": { "docs": "Monitoring Evaluators to activate. These will be automatically run on new Logs.", @@ -783,6 +811,7 @@ function.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -799,6 +828,7 @@ function.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -823,6 +853,7 @@ function.", }, "EvaluatorConfigResponse": { "docs": undefined, + "inline": undefined, "properties": { "arguments_type": { "docs": "Whether this evaluator is target-free or target-required.", @@ -875,6 +906,7 @@ function.", }, "EvaluatorRequest": { "docs": undefined, + "inline": undefined, "properties": { "orchestrated": { "default": true, @@ -892,6 +924,7 @@ function.", }, "EvaluatorResponse": { "docs": "Request model for creating a new Evaluator", + "inline": undefined, "properties": { "commit_message": { "docs": "Message describing the changes made.", @@ -989,6 +1022,7 @@ function.", }, "FeedbackResponse": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "User defined timestamp for when the feedback was created. ", @@ -1025,6 +1059,7 @@ function.", "discriminated": false, "docs": "The type of feedback. The default feedback types available are 'rating', 'action', 'issue', 'correction', and 'comment'.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1039,6 +1074,7 @@ function.", "discriminated": false, "docs": "The feedback value to set. This would be the appropriate text for 'correction' or 'comment', or a label to apply for 'rating', 'action', or 'issue'.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1062,6 +1098,7 @@ function.", }, "FeedbackTypeModel": { "docs": undefined, + "inline": undefined, "properties": { "type": { "display-name": "Feedback type", @@ -1081,6 +1118,7 @@ function.", "discriminated": false, "docs": "The type of feedback. The default feedback types available are 'rating', 'action', 'issue', 'correction', and 'comment'.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1098,6 +1136,7 @@ function.", "discriminated": false, "docs": "The File that the deployed Version belongs to.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1118,6 +1157,7 @@ function.", }, "FunctionTool": { "docs": "A function tool to be called by the model where user owns runtime.", + "inline": undefined, "properties": { "arguments": { "type": "optional", @@ -1130,6 +1170,7 @@ function.", }, "FunctionToolChoice": { "docs": "A function tool to be called by the model where user owns runtime.", + "inline": undefined, "properties": { "name": "string", }, @@ -1139,6 +1180,7 @@ function.", }, "GenericConfigResponse": { "docs": undefined, + "inline": undefined, "properties": { "created_by": { "docs": "The user who created the config.", @@ -1171,6 +1213,7 @@ function.", }, "HTTPValidationError": { "docs": undefined, + "inline": undefined, "properties": { "detail": { "type": "optional>", @@ -1182,6 +1225,7 @@ function.", }, "HumanEvaluatorRequest": { "docs": undefined, + "inline": undefined, "properties": { "arguments_type": { "docs": "Whether this evaluator is target-free or target-required.", @@ -1198,6 +1242,7 @@ function.", }, "ImageChatContent": { "docs": undefined, + "inline": undefined, "properties": { "image_url": { "docs": "The message's image content.", @@ -1210,6 +1255,7 @@ function.", }, "ImageUrl": { "docs": undefined, + "inline": undefined, "properties": { "detail": { "docs": "Specify the detail level of the image provided to the model. For more details see: https://platform.openai.com/docs/guides/vision/low-or-high-fidelity-image-understanding", @@ -1237,6 +1283,7 @@ function.", }, "InputResponse": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "Type of input.", @@ -1251,6 +1298,7 @@ function.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1261,6 +1309,7 @@ function.", }, "LLMEvaluatorRequest": { "docs": undefined, + "inline": undefined, "properties": { "arguments_type": { "docs": "Whether this evaluator is target-free or target-required.", @@ -1295,6 +1344,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", }, "LinkedToolRequest": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "The description of the linked tool.", @@ -1323,6 +1373,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", }, "LinkedToolResponse": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "Description of the tool referenced by the model", @@ -1351,6 +1402,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", }, "ListDatasets": { "docs": undefined, + "inline": undefined, "properties": { "records": { "docs": "The list of Datasets.", @@ -1363,6 +1415,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", }, "ListEvaluators": { "docs": undefined, + "inline": undefined, "properties": { "records": { "docs": "The list of Evaluators.", @@ -1375,6 +1428,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", }, "ListPrompts": { "docs": undefined, + "inline": undefined, "properties": { "records": { "docs": "The list of Prompts.", @@ -1387,6 +1441,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", }, "ListTools": { "docs": undefined, + "inline": undefined, "properties": { "records": { "docs": "The list of Tools.", @@ -1399,6 +1454,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", }, "LogResponse": { "docs": "Request model for logging a datapoint.", + "inline": undefined, "properties": { "batch_ids": { "docs": "List of batch IDs the log belongs to.", @@ -1574,6 +1630,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", "discriminated": false, "docs": "Controls how the model uses tools. The following options are supported: 'none' forces the model to not call a tool; the default when no tools are provided as part of the model config. 'auto' the model can decide to call one of the provided tools; the default when tools are provided as part of the model config. Providing {'type': 'function', 'function': {name': }} forces the model to use the named function.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1588,6 +1645,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", }, "MetricValueResponse": { "docs": undefined, + "inline": undefined, "properties": { "metric_id": "string", "metric_name": "string", @@ -1599,6 +1657,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", }, "ModelConfigRequest": { "docs": "Model config used for logging both chat and completion.", + "inline": undefined, "properties": { "chat_template": { "docs": "Messages prepended to the list of messages sent to the provider. These messages that will take your specified inputs to form your final request to the provider model. Input variables within the template should be specified with syntax: {{INPUT_NAME}}.", @@ -1685,6 +1744,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", "discriminated": false, "docs": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1697,6 +1757,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1713,6 +1774,7 @@ Used by a File's PAPV (Positive Action Per View) metric.", "docs": "Model config request. Contains fields that are common to all (i.e. both chat and complete) endpoints.", + "inline": undefined, "properties": { "chat_template": { "docs": "Messages prepended to the list of messages sent to the provider. These messages that will take your specified inputs to form your final request to the provider model. NB: Input variables within the template should be specified with syntax: {{INPUT_NAME}}.", @@ -1805,6 +1867,7 @@ Contains fields that are common to all (i.e. both chat and complete) endpoints." "discriminated": false, "docs": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1818,6 +1881,7 @@ Contains fields that are common to all (i.e. both chat and complete) endpoints." The subset of ToolConfig parameters received by the chat endpoint. Does not have things like the signature or setup schema.", + "inline": undefined, "properties": { "description": { "docs": "The description of the tool shown to the model.", @@ -1883,6 +1947,7 @@ Does not have things like the signature or setup schema.", }, "MonitoringEvaluatorEnvironmentRequest": { "docs": undefined, + "inline": undefined, "properties": { "environment_id": { "docs": "Unique identifier for the Environment. The Evaluator Version deployed to this Environment will be used for monitoring.", @@ -1899,6 +1964,7 @@ Does not have things like the signature or setup schema.", }, "MonitoringEvaluatorResponse": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "type": "datetime", @@ -1935,6 +2001,7 @@ Does not have things like the signature or setup schema.", }, "MonitoringEvaluatorVersionRequest": { "docs": undefined, + "inline": undefined, "properties": { "evaluator_version_id": { "docs": "Unique identifier for the Evaluator Version to be used for monitoring.", @@ -1948,6 +2015,7 @@ Does not have things like the signature or setup schema.", "NumericEvaluatorVersionStats": { "docs": "Base attributes for stats for an Evaluator Version-Evaluated Version pair in the Evaluation Report.", + "inline": undefined, "properties": { "evaluator_version_id": { "docs": "Unique identifier for the Evaluator Version.", @@ -1999,6 +2067,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "OverallStats": { "docs": undefined, + "inline": undefined, "properties": { "num_datapoints": { "docs": "The total number of Datapoints in the Evaluation Report's Dataset Version.", @@ -2019,6 +2088,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "PaginatedDataDatapointResponse": { "docs": undefined, + "inline": undefined, "properties": { "page": "integer", "records": { @@ -2033,6 +2103,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "PaginatedDataDatasetResponse": { "docs": undefined, + "inline": undefined, "properties": { "page": "integer", "records": { @@ -2047,6 +2118,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "PaginatedDataEvaluationResponse": { "docs": undefined, + "inline": undefined, "properties": { "page": "integer", "records": { @@ -2061,6 +2133,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "PaginatedDataPromptLogResponse": { "docs": undefined, + "inline": undefined, "properties": { "page": "integer", "records": { @@ -2075,6 +2148,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "PaginatedDataSessionResponse": { "docs": undefined, + "inline": undefined, "properties": { "page": "integer", "records": { @@ -2111,6 +2185,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "PromptCallLogResponse": { "docs": "Sample specific response details for a Prompt call", + "inline": undefined, "properties": { "created_at": { "docs": "User defined timestamp for when the log was created. ", @@ -2167,6 +2242,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "PromptCallResponse": { "docs": "Response model for a Prompt call with potentially multiple log samples.", + "inline": undefined, "properties": { "batches": { "docs": "Array of Batch Ids that this log is part of. Batches are used to group Logs together for offline Evaluations", @@ -2246,6 +2322,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", - `'required'` means the model can decide to call one or more of the provided tools. - `{'type': 'function', 'function': {name': }}` forces the model to use the named function.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -2260,6 +2337,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "PromptCallStreamResponse": { "docs": "Response model for calling Prompt in streaming mode.", + "inline": undefined, "properties": { "created_at": { "docs": "User defined timestamp for when the log was created. ", @@ -2328,6 +2406,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "PromptKernelRequest": { "docs": undefined, + "inline": undefined, "properties": { "endpoint": { "docs": "The provider model endpoint used.", @@ -2403,6 +2482,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", "discriminated": false, "docs": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -2413,6 +2493,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "PromptLogResponse": { "docs": "Request for creating a Prompt log.", + "inline": undefined, "properties": { "batches": { "docs": "Array of Batch Ids that this log is part of. Batches are used to group Logs together for offline Evaluations", @@ -2540,6 +2621,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", - `'required'` means the model can decide to call one or more of the provided tools. - `{'type': 'function', 'function': {name': }}` forces the model to use the named function.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -2554,6 +2636,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "PromptResponse": { "docs": "Request model for creating a new Prompt", + "inline": undefined, "properties": { "commit_message": { "docs": "Message describing the changes made.", @@ -2682,6 +2765,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", "discriminated": false, "docs": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -2692,6 +2776,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "ProviderApiKeys": { "docs": undefined, + "inline": undefined, "properties": { "ai21": { "type": "optional", @@ -2721,6 +2806,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "ResponseFormat": { "docs": "Response format of the model.", + "inline": undefined, "properties": { "type": { "type": "literal<"json_object">", @@ -2732,6 +2818,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "SessionResponse": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "type": "datetime", @@ -2787,6 +2874,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", "discriminated": false, "docs": "For chat endpoint, provide a Chat template. For completion endpoint, provide a Prompt template. Input variables within the template should be specified with double curly bracket syntax: {{INPUT_NAME}}.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -2797,6 +2885,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "TextChatContent": { "docs": undefined, + "inline": undefined, "properties": { "text": { "docs": "The message's text content.", @@ -2820,6 +2909,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "ToolCall": { "docs": "A tool call to be made.", + "inline": undefined, "properties": { "function": { "type": "FunctionTool", @@ -2835,6 +2925,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", }, "ToolChoice": { "docs": "Tool choice to force the model to use a tool.", + "inline": undefined, "properties": { "function": { "type": "FunctionToolChoice", @@ -2852,6 +2943,7 @@ Observability is implemented by running monitoring Evaluators on Logs.", The subset of ToolConfig parameters received by the chat endpoint. Does not have things like the signature or setup schema.", + "inline": undefined, "properties": { "description": { "docs": "The description of the tool shown to the model.", @@ -2891,6 +2983,7 @@ Does not have things like the signature or setup schema.", }, "ToolConfigResponse": { "docs": undefined, + "inline": undefined, "properties": { "created_by": { "docs": "The user who created the config.", @@ -2951,6 +3044,7 @@ Does not have things like the signature or setup schema.", }, "ToolFunction": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "Description of the tool referenced by the model", @@ -2971,6 +3065,7 @@ Does not have things like the signature or setup schema.", }, "ToolKernelRequest": { "docs": undefined, + "inline": undefined, "properties": { "function": { "docs": "Callable function specification of the Tool shown to the model for tool calling.", @@ -2991,6 +3086,7 @@ Does not have things like the signature or setup schema.", }, "ToolResponse": { "docs": "Request to create a new Tool.", + "inline": undefined, "properties": { "commit_message": { "docs": "Message describing the changes made.", @@ -3072,6 +3168,7 @@ Does not have things like the signature or setup schema.", }, "ToolResultResponse": { "docs": "A result from a tool used to populate the prompt template", + "inline": undefined, "properties": { "id": "string", "name": "string", @@ -3096,6 +3193,7 @@ V4 uses organization and inline. Those are deprecated and will be removed in fav }, "ToolTemplateResponse": { "docs": "Template for a Humanloop runnable tool.", + "inline": undefined, "properties": { "description": { "docs": "Description of the tool referenced by the model", @@ -3149,6 +3247,7 @@ V4 uses organization and inline. Those are deprecated and will be removed in fav }, "UserResponse": { "docs": undefined, + "inline": undefined, "properties": { "email_address": { "docs": "The User's email address.", @@ -3169,6 +3268,7 @@ V4 uses organization and inline. Those are deprecated and will be removed in fav }, "ValidationError": { "docs": undefined, + "inline": undefined, "properties": { "loc": { "type": "list", @@ -3184,6 +3284,7 @@ V4 uses organization and inline. Those are deprecated and will be removed in fav "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3196,6 +3297,7 @@ V4 uses organization and inline. Those are deprecated and will be removed in fav "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3208,6 +3310,7 @@ V4 uses organization and inline. Those are deprecated and will be removed in fav "discriminated": false, "docs": "The specific Version being referenced.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3228,6 +3331,7 @@ V4 uses organization and inline. Those are deprecated and will be removed in fav }, "VersionDeploymentResponse": { "docs": "A variable reference to the Version deployed to an Environment", + "inline": undefined, "properties": { "environment": { "docs": "The Environment that the Version is deployed to.", @@ -3245,6 +3349,7 @@ V4 uses organization and inline. Those are deprecated and will be removed in fav }, "VersionIdResponse": { "docs": "A reference to a specific Version by its ID", + "inline": undefined, "properties": { "version": { "display-name": "Version", @@ -3276,6 +3381,7 @@ V4 uses organization and inline. Those are deprecated and will be removed in fav }, "VersionStats": { "docs": "Stats for an Evaluated Version in the Evaluation Report.", + "inline": undefined, "properties": { "evaluator_version_stats": { "docs": "Stats for each Evaluator Version used to evaluate this Evaluated Version.", @@ -3298,6 +3404,7 @@ V4 uses organization and inline. Those are deprecated and will be removed in fav "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3425,6 +3532,7 @@ types: - list source: openapi: ../openapi.yml + inline: true ChatMessage: properties: content: @@ -3537,6 +3645,7 @@ types: - list source: openapi: ../openapi.yml + inline: true CreateDatapointRequest: properties: inputs: @@ -3631,6 +3740,7 @@ types: - list source: openapi: ../openapi.yml + inline: true DatapointResponse: properties: inputs: @@ -3773,6 +3883,7 @@ types: - double source: openapi: ../openapi.yml + inline: true EvaluationDebugResultResponse: docs: >- This is similar to an `EvaluationResult` but is ephemeral as it is only @@ -3899,6 +4010,7 @@ types: - type: MonitoringEvaluatorEnvironmentRequest source: openapi: ../openapi.yml + inline: true EvaluatorActivationDeactivationRequestEvaluatorsToDeactivateItem: discriminated: false union: @@ -3906,6 +4018,7 @@ types: - type: MonitoringEvaluatorEnvironmentRequest source: openapi: ../openapi.yml + inline: true EvaluatorActivationDeactivationRequest: properties: evaluators_to_activate: @@ -4062,6 +4175,7 @@ types: - string source: openapi: ../openapi.yml + inline: true FeedbackResponseValue: discriminated: false docs: >- @@ -4073,6 +4187,7 @@ types: - string source: openapi: ../openapi.yml + inline: true FeedbackResponse: properties: type: @@ -4112,6 +4227,7 @@ types: - string source: openapi: ../openapi.yml + inline: true FeedbackTypeModel: properties: type: @@ -4321,6 +4437,7 @@ types: - double source: openapi: ../openapi.yml + inline: true LogResponseToolChoice: discriminated: false docs: >- @@ -4337,6 +4454,7 @@ types: - type: ToolChoice source: openapi: ../openapi.yml + inline: true LogResponse: docs: Request model for logging a datapoint. properties: @@ -4503,6 +4621,7 @@ types: - list source: openapi: ../openapi.yml + inline: true ModelConfigRequestToolsItem: discriminated: false union: @@ -4510,6 +4629,7 @@ types: - type: ModelConfigToolRequest source: openapi: ../openapi.yml + inline: true ModelConfigRequest: docs: Model config used for logging both chat and completion. properties: @@ -4610,6 +4730,7 @@ types: - list source: openapi: ../openapi.yml + inline: true ModelConfigResponse: docs: >- Model config request. @@ -5006,6 +5127,7 @@ types: - type: ToolChoice source: openapi: ../openapi.yml + inline: true PromptCallResponse: docs: Response model for a Prompt call with potentially multiple log samples. properties: @@ -5150,6 +5272,7 @@ types: - list source: openapi: ../openapi.yml + inline: true PromptKernelRequestStop: discriminated: false docs: >- @@ -5160,6 +5283,7 @@ types: - list source: openapi: ../openapi.yml + inline: true PromptKernelRequest: properties: model: @@ -5266,6 +5390,7 @@ types: - type: ToolChoice source: openapi: ../openapi.yml + inline: true PromptLogResponse: docs: Request for creating a Prompt log. properties: @@ -5395,6 +5520,7 @@ types: - list source: openapi: ../openapi.yml + inline: true PromptResponse: docs: Request model for creating a new Prompt properties: @@ -5781,6 +5907,7 @@ types: - integer source: openapi: ../openapi.yml + inline: true ValidationError: properties: loc: @@ -5799,6 +5926,7 @@ types: - type: EvaluatorResponse source: openapi: ../openapi.yml + inline: true VersionDeploymentResponse: docs: A variable reference to the Version deployed to an Environment properties: @@ -5821,6 +5949,7 @@ types: - type: EvaluatorResponse source: openapi: ../openapi.yml + inline: true VersionIdResponse: docs: A reference to a specific Version by its ID properties: @@ -5847,6 +5976,7 @@ types: - type: BooleanEvaluatorVersionStats source: openapi: ../openapi.yml + inline: true VersionStats: docs: Stats for an Evaluated Version in the Evaluation Report. properties: @@ -12845,6 +12975,7 @@ within the Prompt for monitoring purposes.", - `'required'` means the model can decide to call one or more of the provided tools. - `{'type': 'function', 'function': {name': }}` forces the model to use the named function.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -12865,6 +12996,7 @@ within the Prompt for monitoring purposes.", - `'required'` means the model can decide to call one or more of the provided tools. - `{'type': 'function', 'function': {name': }}` forces the model to use the named function.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -12881,6 +13013,7 @@ within the Prompt for monitoring purposes.", "discriminated": false, "docs": "The string (or list of strings) after which the model will stop generating. The returned text will not contain the stop sequence.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -12893,6 +13026,7 @@ within the Prompt for monitoring purposes.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -12909,6 +13043,7 @@ within the Prompt for monitoring purposes.", "discriminated": false, "docs": "For chat endpoint, provide a Chat template. For completion endpoint, provide a Prompt template. Input variables within the template should be specified with double curly bracket syntax: {{INPUT_NAME}}.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -14190,6 +14325,7 @@ types: - list source: openapi: ../openapi.yml + inline: true PromptRequestStop: discriminated: false docs: >- @@ -14200,6 +14336,7 @@ types: - list source: openapi: ../openapi.yml + inline: true PromptLogRequestToolChoice: discriminated: false docs: >- @@ -14224,6 +14361,7 @@ types: - type: root.ToolChoice source: openapi: ../openapi.yml + inline: true PromptCallRequestToolChoice: discriminated: false docs: >- @@ -14248,6 +14386,7 @@ types: - type: root.ToolChoice source: openapi: ../openapi.yml + inline: true PromptsCallResponse: discriminated: false union: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/hume.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/hume.json index 74ab8cf13fa..85e3504dc4d 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/hume.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/hume.json @@ -261,6 +261,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "BoundingBox": { "docs": "A bounding box around a face.", + "inline": undefined, "properties": { "h": { "docs": "Bounding box height.", @@ -285,6 +286,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "BurstPrediction": { "docs": undefined, + "inline": undefined, "properties": { "descriptions": { "docs": "Modality-specific descriptive features and their scores.", @@ -302,6 +304,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "Completed": { "docs": undefined, + "inline": undefined, "properties": { "created_timestamp_ms": { "docs": "When this job was created (Unix timestamp in milliseconds).", @@ -330,6 +333,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "DescriptionsScore": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "Name of the descriptive feature being expressed.", @@ -355,6 +359,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "EmotionScore": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "Name of the emotion being expressed.", @@ -375,6 +380,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "Error": { "docs": undefined, + "inline": undefined, "properties": { "file": { "docs": "A file path relative to the top level source URL or file.", @@ -391,6 +397,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "Face": { "docs": undefined, + "inline": undefined, "properties": { "descriptions": "optional", "facs": "optional", @@ -432,6 +439,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "FacePrediction": { "docs": undefined, + "inline": undefined, "properties": { "box": "BoundingBox", "descriptions": { @@ -465,6 +473,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "FacemeshPrediction": { "docs": undefined, + "inline": undefined, "properties": { "emotions": { "docs": "A high-dimensional embedding in emotion space.", @@ -477,6 +486,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "FacsScore": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "Name of the FACS 2.0 feature being expressed.", @@ -493,6 +503,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "Failed": { "docs": undefined, + "inline": undefined, "properties": { "created_timestamp_ms": { "docs": "When this job was created (Unix timestamp in milliseconds).", @@ -517,6 +528,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "File": { "docs": undefined, + "inline": undefined, "properties": { "content_type": { "docs": "The content type of the file.", @@ -549,6 +561,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "GroupedPredictionsBurstPrediction": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals.", @@ -562,6 +575,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "GroupedPredictionsFacePrediction": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals.", @@ -575,6 +589,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "GroupedPredictionsFacemeshPrediction": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals.", @@ -588,6 +603,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "GroupedPredictionsLanguagePrediction": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals.", @@ -601,6 +617,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "GroupedPredictionsNerPrediction": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals.", @@ -614,6 +631,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "GroupedPredictionsProsodyPrediction": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "An automatically generated label to identify individuals in your media file. Will be `unknown` if you have chosen to disable identification, or if the model is unable to distinguish between individuals.", @@ -627,6 +645,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "InProgress": { "docs": undefined, + "inline": undefined, "properties": { "created_timestamp_ms": { "docs": "When this job was created (Unix timestamp in milliseconds).", @@ -643,6 +662,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "JobId": { "docs": undefined, + "inline": undefined, "properties": { "job_id": { "docs": "The ID of the started job.", @@ -661,6 +681,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "JobRequest": { "docs": undefined, + "inline": undefined, "properties": { "job_id": { "docs": "The ID associated with this job.", @@ -691,6 +712,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "Language": { "docs": undefined, + "inline": undefined, "properties": { "granularity": "optional", "identify_speakers": { @@ -707,6 +729,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "LanguagePrediction": { "docs": undefined, + "inline": undefined, "properties": { "confidence": { "docs": "Value between `0.0` and `1.0` that indicates our transcription model’s relative confidence in this text.", @@ -743,6 +766,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "Models": { "docs": undefined, + "inline": undefined, "properties": { "burst": "optional", "face": "optional", @@ -757,6 +781,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "ModelsPredictions": { "docs": undefined, + "inline": undefined, "properties": { "burst": "optional", "face": "optional", @@ -771,6 +796,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "Ner": { "docs": undefined, + "inline": undefined, "properties": { "identify_speakers": { "default": false, @@ -784,6 +810,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "NerPrediction": { "docs": undefined, + "inline": undefined, "properties": { "confidence": { "docs": "Value between `0.0` and `1.0` that indicates our transcription model’s relative confidence in this text.", @@ -830,6 +857,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "PositionInterval": { "docs": "Position of a segment of text within a larger document, measured in characters. Uses zero-based indexing. The beginning index is inclusive and the end index is exclusive.", + "inline": undefined, "properties": { "begin": { "docs": "The index of the first character in the text segment, inclusive.", @@ -846,6 +874,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "Prediction": { "docs": undefined, + "inline": undefined, "properties": { "file": { "docs": "A file path relative to the top level source URL or file.", @@ -859,6 +888,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "PredictionsOptionalNullBurstPrediction": { "docs": undefined, + "inline": undefined, "properties": { "grouped_predictions": "list", "metadata": "optional", @@ -869,6 +899,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "PredictionsOptionalNullFacePrediction": { "docs": undefined, + "inline": undefined, "properties": { "grouped_predictions": "list", "metadata": "optional", @@ -879,6 +910,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "PredictionsOptionalNullFacemeshPrediction": { "docs": undefined, + "inline": undefined, "properties": { "grouped_predictions": "list", "metadata": "optional", @@ -889,6 +921,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "PredictionsOptionalTranscriptionMetadataLanguagePrediction": { "docs": undefined, + "inline": undefined, "properties": { "grouped_predictions": "list", "metadata": "optional", @@ -899,6 +932,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "PredictionsOptionalTranscriptionMetadataNerPrediction": { "docs": undefined, + "inline": undefined, "properties": { "grouped_predictions": "list", "metadata": "optional", @@ -909,6 +943,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "PredictionsOptionalTranscriptionMetadataProsodyPrediction": { "docs": undefined, + "inline": undefined, "properties": { "grouped_predictions": "list", "metadata": "optional", @@ -919,6 +954,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "Prosody": { "docs": "NOTE: the `granularity` field is ignored if transcription is not enabled or if the `window` field has been set.", + "inline": undefined, "properties": { "granularity": "optional", "identify_speakers": { @@ -934,6 +970,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "ProsodyPrediction": { "docs": undefined, + "inline": undefined, "properties": { "confidence": { "docs": "Value between `0.0` and `1.0` that indicates our transcription model’s relative confidence in this text.", @@ -959,6 +996,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "Queued": { "docs": undefined, + "inline": undefined, "properties": { "created_timestamp_ms": { "docs": "When this job was created (Unix timestamp in milliseconds).", @@ -971,6 +1009,7 @@ Compared to returning one estimate of sentiment, this enables a more nuanced ana }, "Request": { "docs": undefined, + "inline": undefined, "properties": { "callback_url": { "docs": "If provided, a `POST` request will be made to the URL with the generated predictions on completion or the error message on failure.", @@ -997,6 +1036,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "Results": { "docs": undefined, + "inline": undefined, "properties": { "errors": "list", "predictions": "list", @@ -1007,6 +1047,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "SentimentScore": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "Level of sentiment, ranging from `1` (negative) to `9` (positive)", @@ -1050,6 +1091,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive "extends": [ "File", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yaml", @@ -1057,6 +1099,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "SourceResult": { "docs": undefined, + "inline": undefined, "properties": { "error": { "docs": "An error message.", @@ -1074,6 +1117,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive "extends": [ "Url", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yaml", @@ -1100,6 +1144,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive "extends": [ "Completed", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yaml", @@ -1110,6 +1155,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive "extends": [ "Failed", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yaml", @@ -1120,6 +1166,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive "extends": [ "InProgress", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yaml", @@ -1130,6 +1177,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive "extends": [ "Queued", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yaml", @@ -1148,6 +1196,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "TimeInterval": { "docs": "A time range with a beginning and end, measured in seconds.", + "inline": undefined, "properties": { "begin": { "docs": "Beginning of time range in seconds.", @@ -1164,6 +1213,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "ToxicityScore": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "Category of toxicity.", @@ -1180,6 +1230,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "Transcription": { "docs": undefined, + "inline": undefined, "properties": { "language": "optional", }, @@ -1189,6 +1240,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "TranscriptionMetadata": { "docs": "Transcription metadata for your media file.", + "inline": undefined, "properties": { "confidence": { "docs": "Value between `0.0` and `1.0` indicating our transcription model’s relative confidence in the transcription of your media file.", @@ -1202,6 +1254,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "Url": { "docs": undefined, + "inline": undefined, "properties": { "url": { "docs": "The URL of the source media file.", @@ -1223,6 +1276,7 @@ If you wish to supply more than 100 URLs, consider providing them as an archive }, "Window": { "docs": undefined, + "inline": undefined, "properties": { "length": { "default": 4, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/inline-path-parameters.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/inline-path-parameters.json index a47eed7d1b8..8a25286f6d0 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/inline-path-parameters.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/inline-path-parameters.json @@ -82,6 +82,7 @@ "types": { "GetOrganizationUserResponse": { "docs": undefined, + "inline": undefined, "properties": { "results": "optional>", }, @@ -218,6 +219,7 @@ types: }, "SearchResponse": { "docs": undefined, + "inline": undefined, "properties": { "results": "optional>", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/inline-schema-reference.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/inline-schema-reference.json index cd447628f4a..9bc1aa13acb 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/inline-schema-reference.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/inline-schema-reference.json @@ -43,6 +43,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -55,6 +56,7 @@ }, "GetExampleResponseMessage": { "docs": undefined, + "inline": true, "properties": { "message": "optional", }, @@ -64,6 +66,7 @@ }, "NotFound": { "docs": undefined, + "inline": true, "properties": { "message": "optional", }, @@ -73,6 +76,7 @@ }, "Schema1": { "docs": undefined, + "inline": undefined, "properties": { "id": "optional", "name": "optional", @@ -83,6 +87,7 @@ }, "Schema2": { "docs": undefined, + "inline": undefined, "properties": { "age": "optional", "email": "optional", @@ -99,11 +104,13 @@ message: optional source: openapi: ../openapi.yml + inline: true GetExampleResponseMessage: properties: message: optional source: openapi: ../openapi.yml + inline: true GetExampleResponse: discriminated: false union: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/intercom.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/intercom.json index 55a9ceb8bfc..ada0fd71f41 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/intercom.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/intercom.json @@ -2746,6 +2746,7 @@ "types": { "ActivityLog": { "docs": "Activities performed by Admins.", + "inline": undefined, "properties": { "activity_description": { "docs": "A sentence or two describing the activity.", @@ -2850,6 +2851,7 @@ }, "ActivityLogList": { "docs": "A paginated list of activity logs.", + "inline": undefined, "properties": { "activity_logs": { "docs": "An array of activity logs", @@ -2869,6 +2871,7 @@ }, "ActivityLogMetadata": { "docs": "Additional data provided about Admin activity.", + "inline": undefined, "properties": { "auto_changed": { "docs": "Indicates if the status was changed automatically or manually.", @@ -2913,6 +2916,7 @@ }, "ActivityLogPerformedBy": { "docs": "Details about the Admin involved in the activity.", + "inline": true, "properties": { "email": { "docs": "The email of the admin.", @@ -2937,6 +2941,7 @@ }, "AddressableList": { "docs": "A list used to access other resources from a parent model.", + "inline": undefined, "properties": { "id": { "docs": "The id of the addressable object", @@ -2969,6 +2974,7 @@ }, "Admin": { "docs": "Admins are the teammate accounts that have access to a workspace", + "inline": undefined, "properties": { "app": { "docs": "App that the admin belongs to.", @@ -3025,6 +3031,7 @@ }, "AdminPriorityLevel": { "docs": "Admin priority levels for the team", + "inline": undefined, "properties": { "primary_admin_ids": { "docs": "The primary admin ids for the team", @@ -3041,6 +3048,7 @@ }, "AdminReplyConversationRequest": { "docs": "Payload of the request to reply on behalf of an admin", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is authoring the comment.", @@ -3080,6 +3088,7 @@ }, "AdminReplyTicketRequest": { "docs": "Payload of the request to reply on behalf of an admin", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is authoring the comment.", @@ -3120,6 +3129,7 @@ }, "AdminReplyTicketRequestReplyOptionsItem": { "docs": undefined, + "inline": true, "properties": { "text": { "docs": "The text to display in this quick reply option.", @@ -3142,6 +3152,7 @@ }, "AdminWithAppAvatar": { "docs": "This object represents the avatar associated with the admin.", + "inline": true, "properties": { "image_url": { "docs": "This object represents the avatar associated with the admin.", @@ -3165,6 +3176,7 @@ }, "Admins": { "docs": "A list of admins associated with a given workspace.", + "inline": undefined, "properties": { "admins": { "docs": "A list of admins associated with a given workspace.", @@ -3181,6 +3193,7 @@ }, "App": { "docs": "App is a workspace on Intercom", + "inline": undefined, "properties": { "created_at": { "docs": "When the app was created.", @@ -3218,6 +3231,7 @@ }, "ArticleContent": { "docs": "The Content of an Article.", + "inline": undefined, "properties": { "author_id": { "docs": "The ID of the author of the article.", @@ -3272,6 +3286,7 @@ }, "ArticleStatistics": { "docs": "The statistics of an article.", + "inline": undefined, "properties": { "conversions": { "docs": "The number of conversations started from the article.", @@ -3308,6 +3323,7 @@ }, "ArticleTranslatedContent": { "docs": "The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.", + "inline": undefined, "properties": { "ar": { "docs": "The content of the article in Arabic", @@ -3468,6 +3484,7 @@ }, "Articles": { "docs": "This will return a list of articles for the App.", + "inline": undefined, "properties": { "data": { "docs": "An array of Article objects", @@ -3491,6 +3508,7 @@ }, "AssignConversationRequest": { "docs": "Payload of the request to assign a conversation", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is performing the action.", @@ -3521,6 +3539,7 @@ }, "CloseConversationRequest": { "docs": "Payload of the request to close a conversation", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is performing the action.", @@ -3538,6 +3557,7 @@ }, "Collections": { "docs": "This will return a list of Collections for the App.", + "inline": undefined, "properties": { "data": { "docs": "An array of collection objects", @@ -3561,6 +3581,7 @@ }, "Companies": { "docs": "This will return a list of companies for the App.", + "inline": undefined, "properties": { "data": { "docs": "An array containing Company Objects.", @@ -3584,6 +3605,7 @@ }, "CompanyAttachedContacts": { "docs": "A list of Contact Objects", + "inline": undefined, "properties": { "data": { "docs": "An array containing Contact Objects", @@ -3607,6 +3629,7 @@ }, "CompanyAttachedSegments": { "docs": "A list of Segment Objects", + "inline": undefined, "properties": { "data": { "docs": "An array containing Segment Objects", @@ -3623,6 +3646,7 @@ }, "CompanyScroll": { "docs": "Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.", + "inline": undefined, "properties": { "data": { "type": "optional>", @@ -3649,6 +3673,7 @@ }, "ContactArchived": { "docs": "archived contact object", + "inline": undefined, "properties": { "archived": { "docs": "Whether the contact is archived or not.", @@ -3673,6 +3698,7 @@ }, "ContactAttachedCompanies": { "docs": "A list of Company Objects", + "inline": undefined, "properties": { "companies": { "docs": "An array containing Company Objects", @@ -3696,6 +3722,7 @@ }, "ContactCompanies": { "docs": "An object containing companies meta data about the companies that a contact has. Up to 10 will be displayed here. Use the url to get more.", + "inline": undefined, "properties": { "has_more": { "docs": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all", @@ -3722,6 +3749,7 @@ }, "ContactDeleted": { "docs": "deleted contact object", + "inline": undefined, "properties": { "deleted": { "docs": "Whether the contact is deleted or not.", @@ -3746,6 +3774,7 @@ }, "ContactList": { "docs": "Contacts are your users in Intercom.", + "inline": undefined, "properties": { "data": { "docs": "The list of contact objects", @@ -3769,6 +3798,7 @@ }, "ContactLocation": { "docs": "An object containing location meta data about a Intercom contact.", + "inline": undefined, "properties": { "city": { "docs": "The city that the contact is located in", @@ -3793,6 +3823,7 @@ }, "ContactNotes": { "docs": "An object containing notes meta data about the notes that a contact has. Up to 10 will be displayed here. Use the url to get more.", + "inline": undefined, "properties": { "data": { "docs": "This object represents the notes attached to a contact.", @@ -3823,6 +3854,7 @@ }, "ContactReference": { "docs": "reference to contact object", + "inline": undefined, "properties": { "external_id": { "docs": "The unique identifier for the contact which is provided by the Client.", @@ -3843,6 +3875,7 @@ }, "ContactReplyBaseRequest": { "docs": undefined, + "inline": undefined, "properties": { "attachment_urls": { "docs": "A list of image URLs that will be added as attachments. You can include up to 10 URLs.", @@ -3867,6 +3900,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -3887,6 +3921,7 @@ "extends": [ "ContactReplyBaseRequest", ], + "inline": undefined, "properties": { "attachment_files": { "docs": "A list of files that will be added as attachments.", @@ -3906,6 +3941,7 @@ "extends": [ "ContactReplyBaseRequest", ], + "inline": undefined, "properties": { "intercom_user_id": { "docs": "The identifier for the contact as given by Intercom.", @@ -3920,6 +3956,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -3940,6 +3977,7 @@ "extends": [ "ContactReplyBaseRequest", ], + "inline": undefined, "properties": { "user_id": { "docs": "The external_id you have defined for the contact.", @@ -3955,6 +3993,7 @@ "extends": [ "ContactReplyBaseRequest", ], + "inline": undefined, "properties": { "attachment_files": { "docs": "A list of files that will be added as attachments. You can include up to 10 files.", @@ -3971,6 +4010,7 @@ }, "ContactSocialProfiles": { "docs": "An object containing social profiles that a contact has.", + "inline": undefined, "properties": { "data": { "docs": "A list of social profiles objects associated with the contact.", @@ -3983,6 +4023,7 @@ }, "ContactSubscriptionTypes": { "docs": "An object containing Subscription Types meta data about the SubscriptionTypes that a contact has.", + "inline": undefined, "properties": { "data": { "docs": "This object represents the subscriptions attached to a contact.", @@ -4013,6 +4054,7 @@ }, "ContactTags": { "docs": "An object containing tags meta data about the tags that a contact has. Up to 10 will be displayed here. Use the url to get more.", + "inline": undefined, "properties": { "data": { "docs": "This object represents the tags attached to a contact.", @@ -4043,6 +4085,7 @@ }, "ContactUnarchived": { "docs": "unarchived contact object", + "inline": undefined, "properties": { "archived": { "docs": "Whether the contact is archived or not.", @@ -4067,6 +4110,7 @@ }, "Contacts": { "docs": "The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.", + "inline": undefined, "properties": { "contacts": { "docs": "The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.", @@ -4083,6 +4127,7 @@ }, "ContentSourcesList": { "docs": undefined, + "inline": undefined, "properties": { "content_sources": { "docs": "The content sources used by AI Agent in the conversation.", @@ -4102,6 +4147,7 @@ }, "ConversationAttachmentFiles": { "docs": "Properties of the attachment files in a conversation part", + "inline": undefined, "properties": { "content_type": { "docs": "The content type of the file", @@ -4122,6 +4168,7 @@ }, "ConversationFirstContactReply": { "docs": "An object containing information on the first users message. For a contact initiated message this will represent the users original message.", + "inline": undefined, "properties": { "created_at": { "docs": "", @@ -4142,6 +4189,7 @@ }, "ConversationList": { "docs": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.", + "inline": undefined, "properties": { "conversations": { "docs": "The list of conversation objects", @@ -4165,6 +4213,7 @@ }, "ConversationPart": { "docs": "A Conversation Part represents a message in the conversation.", + "inline": undefined, "properties": { "assigned_to": { "docs": "The id of the admin that was assigned the conversation by this conversation_part (null if there has been no change in assignment.)", @@ -4220,6 +4269,7 @@ }, "ConversationPartAuthor": { "docs": "The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank.", + "inline": undefined, "properties": { "email": { "docs": "The email of the author", @@ -4250,6 +4300,7 @@ }, "ConversationParts": { "docs": "A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.", + "inline": undefined, "properties": { "conversation_parts": { "docs": "A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.", @@ -4270,6 +4321,7 @@ }, "ConversationRating": { "docs": "The Conversation Rating object which contains information on the rating and/or remark added by a Contact and the Admin assigned to the conversation.", + "inline": undefined, "properties": { "contact": { "type": "optional", @@ -4296,6 +4348,7 @@ }, "ConversationSource": { "docs": "The Conversation Part that originated this conversation, which can be Contact, Admin, Campaign, Automated or Operator initiated.", + "inline": undefined, "properties": { "attachments": { "docs": "A list of attachments for the part.", @@ -4339,6 +4392,7 @@ }, "ConversationStatistics": { "docs": "A Statistics object containing all information required for reporting, with timestamps and calculated metrics.", + "inline": undefined, "properties": { "count_assignments": { "docs": "Number of assignments after first_contact_reply_at.", @@ -4423,6 +4477,7 @@ }, "ConversationTeammates": { "docs": "The list of teammates who participated in the conversation (wrote at least one conversation part).", + "inline": undefined, "properties": { "teammates": { "docs": "The list of teammates who participated in the conversation (wrote at least one conversation part).", @@ -4439,6 +4494,7 @@ }, "CreateArticleRequest": { "docs": "You can create an Article", + "inline": undefined, "properties": { "author_id": { "docs": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", @@ -4491,6 +4547,7 @@ "CreateMessageRequestOne": "unknown", "CreateOrUpdateCompanyRequest": { "docs": "You can create or update a Company", + "inline": undefined, "properties": { "company_id": { "docs": "The company id you have defined for the company. Can't be updated", @@ -4535,6 +4592,7 @@ }, "CreateOrUpdateTagRequest": { "docs": "You can create or update an existing tag.", + "inline": undefined, "properties": { "id": { "docs": "The id of tag to updates.", @@ -4551,6 +4609,7 @@ }, "CreatePhoneSwitchRequest": { "docs": "You can create an phone switch", + "inline": undefined, "properties": { "custom_attributes": { "type": "optional", @@ -4568,6 +4627,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -4584,6 +4644,7 @@ "docs": "The request payload for creating a ticket type. You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) ", + "inline": undefined, "properties": { "category": { "docs": "Category of the Ticket Type.", @@ -4630,6 +4691,7 @@ "docs": "Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed. ", + "inline": undefined, "properties": { "next": { "type": "optional", @@ -4663,6 +4725,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -4677,6 +4740,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -4694,6 +4758,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "CustomerRequestIntercomUserId": { "docs": undefined, + "inline": true, "properties": { "intercom_user_id": { "docs": "The identifier for the contact as given by Intercom.", @@ -4706,6 +4771,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "CustomerRequestUserId": { "docs": undefined, + "inline": true, "properties": { "user_id": { "docs": "The external_id you have defined for the contact who is being added as a participant.", @@ -4718,6 +4784,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DataAttributeList": { "docs": "A list of all data attributes belonging to a workspace for contacts, companies or conversations.", + "inline": undefined, "properties": { "data": { "docs": "A list of data attributes", @@ -4734,6 +4801,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DataEventList": { "docs": "This will return a list of data events for the App.", + "inline": undefined, "properties": { "events": { "docs": "A list of data events", @@ -4754,6 +4822,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DataEventListPages": { "docs": "Pagination", + "inline": true, "properties": { "next": "optional", "since": "optional", @@ -4764,6 +4833,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DataEventSummary": { "docs": "This will return a summary of data events for the App.", + "inline": undefined, "properties": { "email": { "docs": "The email address of the user", @@ -4792,6 +4862,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DataEventSummaryItem": { "docs": "This will return a summary of a data event for the App.", + "inline": undefined, "properties": { "count": { "docs": "The number of times the event was sent", @@ -4820,6 +4891,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DataExportCsv": { "docs": "A CSV output file", + "inline": undefined, "properties": { "company_id": { "docs": "The company ID of the user in relation to the message that was sent. Will return -1 if no company is present.", @@ -4932,6 +5004,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DeletedArticleObject": { "docs": "Response returned when an object is deleted", + "inline": undefined, "properties": { "deleted": { "docs": "Whether the article was deleted successfully or not.", @@ -4952,6 +5025,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DeletedCollectionObject": { "docs": "Response returned when an object is deleted", + "inline": undefined, "properties": { "deleted": { "docs": "Whether the collection was deleted successfully or not.", @@ -4972,6 +5046,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DeletedCompanyObject": { "docs": "Response returned when an object is deleted", + "inline": undefined, "properties": { "deleted": { "docs": "Whether the company was deleted successfully or not.", @@ -4992,6 +5067,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DeletedObject": { "docs": "Response returned when an object is deleted", + "inline": undefined, "properties": { "deleted": { "docs": "Whether the news item was deleted successfully or not.", @@ -5012,6 +5088,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "Email": { "docs": undefined, + "inline": true, "properties": { "email": { "docs": "The email you have defined for the contact who is being added as a participant.", @@ -5024,6 +5101,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "Error": { "docs": "The API will return an Error List for a failed request, which will contain one or more Error objects.", + "inline": undefined, "properties": { "errors": { "docs": "An array of one or more error objects", @@ -5050,6 +5128,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "ErrorErrorsItem": { "docs": undefined, + "inline": true, "properties": { "code": { "docs": "A string indicating the kind of error, used to further qualify the HTTP response code", @@ -5070,6 +5149,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "File": { "docs": "The value describing a file upload set for a custom attribute", + "inline": undefined, "properties": { "content_type": { "docs": "The type of file", @@ -5105,6 +5185,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "GroupContent": { "docs": "The Content of a Group.", + "inline": undefined, "properties": { "description": { "docs": "The description of the collection. Only available for collections.", @@ -5125,6 +5206,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "GroupTranslatedContent": { "docs": "The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.", + "inline": undefined, "properties": { "ar": { "docs": "The content of the group in Arabic", @@ -5363,6 +5445,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "LinkedObject": { "docs": "A linked conversation or ticket.", + "inline": undefined, "properties": { "category": { "docs": "Category of the Linked Ticket Object.", @@ -5383,6 +5466,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "LinkedObjectList": { "docs": "An object containing metadata about linked conversations and linked tickets. Up to 1000 can be returned.", + "inline": undefined, "properties": { "data": { "docs": "An array containing the linked conversations and linked tickets.", @@ -5417,6 +5501,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "MultipleFilterSearchRequest": { "docs": "Search using Intercoms Search APIs with more than one filter.", + "inline": undefined, "properties": { "operator": { "docs": "An operator to allow boolean inspection between multiple fields.", @@ -5444,6 +5529,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -5460,6 +5546,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "NewsItemRequest": { "docs": "A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.", + "inline": undefined, "properties": { "body": { "docs": "The news item body, which may contain HTML.", @@ -5510,6 +5597,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "NoteList": { "docs": "A paginated list of notes associated with a contact.", + "inline": undefined, "properties": { "data": { "docs": "An array of notes.", @@ -5533,6 +5621,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "OpenConversationRequest": { "docs": "Payload of the request to open a conversation", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is performing the action.", @@ -5548,6 +5637,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows. ", + "inline": undefined, "properties": { "next": { "docs": "A link to the next page of results. A response that does not contain a next link does not have further data to fetch.", @@ -5578,6 +5668,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "PaginatedResponse": { "docs": "Paginated Response", + "inline": undefined, "properties": { "data": { "docs": "An array of Objects", @@ -5632,6 +5723,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "PartAttachment": { "docs": "The file attached to a part", + "inline": undefined, "properties": { "content_type": { "docs": "The content type of the attachment", @@ -5668,6 +5760,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "PhoneSwitch": { "docs": "Phone Switch Response", + "inline": undefined, "properties": { "phone": { "docs": "Phone number in E.164 format, that has received the SMS to continue the conversation in the Messenger.", @@ -5704,6 +5797,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "RedactConversationRequestConversationPart": { "docs": "Payload of the request to redact a conversation part", + "inline": true, "properties": { "conversation_id": { "docs": "The id of the conversation.", @@ -5720,6 +5814,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "RedactConversationRequestSource": { "docs": "Payload of the request to redact a conversation source", + "inline": true, "properties": { "conversation_id": { "docs": "The id of the conversation.", @@ -5736,6 +5831,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "Reference": { "docs": "reference to another object", + "inline": undefined, "properties": { "id": { "docs": "", @@ -5754,6 +5850,7 @@ Their responses are likely to contain a pages object that hosts pagination links "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -5768,6 +5865,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "SearchRequest": { "docs": "Search using Intercoms Search APIs.", + "inline": undefined, "properties": { "pagination": { "type": "optional", @@ -5782,6 +5880,7 @@ Their responses are likely to contain a pages object that hosts pagination links "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -5796,6 +5895,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "SegmentList": { "docs": "This will return a list of Segment Objects. The result may also have a pages object if the response is paginated.", + "inline": undefined, "properties": { "pages": { "docs": "A pagination object, which may be empty, indicating no further pages to fetch.", @@ -5816,6 +5916,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "Segments": { "docs": "A list of segments objects attached to a specific contact.", + "inline": undefined, "properties": { "data": { "docs": "Segment objects associated with the contact.", @@ -5832,6 +5933,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "SingleFilterSearchRequest": { "docs": "Search using Intercoms Search APIs with a single filter.", + "inline": undefined, "properties": { "field": { "docs": "The accepted field that you want to search on.", @@ -5884,6 +5986,7 @@ Their responses are likely to contain a pages object that hosts pagination links "docs": "The SLA Applied object contains the details for which SLA has been applied to this conversation. Important: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null. ", + "inline": undefined, "properties": { "sla_name": { "docs": "The name of the SLA as given by the teammate when it was created.", @@ -5922,6 +6025,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "SnoozeConversationRequest": { "docs": "Payload of the request to snooze a conversation", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is performing the action.", @@ -5938,6 +6042,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "SocialProfile": { "docs": "A Social Profile allows you to label your contacts, companies, and conversations and list them using that Social Profile.", + "inline": undefined, "properties": { "name": { "docs": "The name of the Social media profile", @@ -5964,6 +6069,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "StartingAfterPaging": { "docs": undefined, + "inline": undefined, "properties": { "per_page": { "docs": "The number of results to fetch per page.", @@ -5980,6 +6086,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "SubscriptionTypeList": { "docs": "A list of subscription type objects.", + "inline": undefined, "properties": { "data": { "docs": "A list of subscription type objects associated with the workspace .", @@ -5996,6 +6103,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TagCompanyRequest": { "docs": "You can tag a single company or a list of companies.", + "inline": undefined, "properties": { "companies": { "docs": "The id or company_id of the company can be passed as input parameters.", @@ -6012,6 +6120,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TagCompanyRequestCompaniesItem": { "docs": undefined, + "inline": true, "properties": { "company_id": { "docs": "The company id you have defined for the company.", @@ -6028,6 +6137,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TagMultipleUsersRequest": { "docs": "You can tag a list of users.", + "inline": undefined, "properties": { "name": { "docs": "The name of the tag, which will be created if not found.", @@ -6041,6 +6151,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TagMultipleUsersRequestUsersItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The Intercom defined id representing the user.", @@ -6053,6 +6164,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "Tags": { "docs": "A list of tags objects associated with a conversation", + "inline": undefined, "properties": { "tags": { "docs": "A list of tags objects associated with the conversation.", @@ -6069,6 +6181,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TeamList": { "docs": "This will return a list of team objects for the App.", + "inline": undefined, "properties": { "teams": { "docs": "A list of team objects", @@ -6085,6 +6198,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TeamPriorityLevel": { "docs": "Admin priority levels for teams", + "inline": undefined, "properties": { "primary_team_ids": { "docs": "The primary team ids for the team", @@ -6107,6 +6221,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -6122,6 +6237,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketList": { "docs": "Tickets are how you track requests from your users.", + "inline": undefined, "properties": { "pages": { "type": "optional", @@ -6145,6 +6261,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketPartAuthor": { "docs": "The author that wrote or triggered the part. Can be a bot, admin, team or user.", + "inline": undefined, "properties": { "email": { "docs": "The email of the author", @@ -6187,6 +6304,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketParts": { "docs": "A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts.", + "inline": undefined, "properties": { "ticket_parts": { "docs": "A list of Ticket Part objects for each ticket. There is a limit of 500 parts.", @@ -6207,6 +6325,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketReply": { "docs": "A Ticket Part representing a note, comment, or quick_reply on a ticket", + "inline": undefined, "properties": { "attachments": { "docs": "A list of attachments for the part.", @@ -6267,6 +6386,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -6279,6 +6399,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketTypeAttribute": { "docs": "Ticket type attribute, used to define each data field to be captured in a ticket.", + "inline": undefined, "properties": { "archived": { "docs": "Whether the ticket type attribute is archived or not.", @@ -6359,6 +6480,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketTypeAttributeList": { "docs": "A list of attributes associated with a given ticket type.", + "inline": undefined, "properties": { "ticket_type_attributes": { "docs": "A list of ticket type attributes associated with a given ticket type.", @@ -6375,6 +6497,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketTypeList": { "docs": "A list of ticket types associated with a given workspace.", + "inline": undefined, "properties": { "ticket_types": { "docs": "A list of ticket_types associated with a given workspace.", @@ -6391,6 +6514,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "Translation": { "docs": "A translation object contains the localised details of a subscription type.", + "inline": undefined, "properties": { "description": { "docs": "The localised description of the subscription type.", @@ -6411,6 +6535,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "UntagCompanyRequest": { "docs": "You can tag a single company or a list of companies.", + "inline": undefined, "properties": { "companies": { "docs": "The id or company_id of the company can be passed as input parameters.", @@ -6427,6 +6552,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "UntagCompanyRequestCompaniesItem": { "docs": undefined, + "inline": true, "properties": { "company_id": { "docs": "The company id you have defined for the company.", @@ -6447,6 +6573,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "UpdateArticleRequest": { "docs": "You can Update an Article", + "inline": undefined, "properties": { "author_id": { "docs": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", @@ -6498,6 +6625,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a "docs": "The request payload for updating a ticket type. You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) ", + "inline": undefined, "properties": { "archived": { "docs": "The archived status of the ticket type.", @@ -6547,6 +6675,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( "UpdateVisitorRequestOne": "unknown", "Visitor": { "docs": "Visitors are useful for representing anonymous people that have not yet been identified. They usually represent website visitors. Visitors are not visible in Intercom platform. The Visitors resource provides methods to fetch, update, convert and delete.", + "inline": undefined, "properties": { "anonymous": { "docs": "Identifies if this visitor is anonymous.", @@ -6688,6 +6817,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorAvatar": { "docs": undefined, + "inline": true, "properties": { "image_url": { "docs": "This object represents the avatar associated with the visitor.", @@ -6711,6 +6841,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorCompanies": { "docs": undefined, + "inline": true, "properties": { "companies": "optional>", "type": { @@ -6724,6 +6855,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorDeletedObject": { "docs": "Response returned when an object is deleted", + "inline": undefined, "properties": { "id": { "docs": "The unique identifier for the visitor which is given by Intercom.", @@ -6744,6 +6876,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorLocationData": { "docs": undefined, + "inline": true, "properties": { "city_name": { "docs": "The city name of the visitor.", @@ -6785,6 +6918,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorSegments": { "docs": undefined, + "inline": true, "properties": { "segments": "optional>", "type": { @@ -6798,6 +6932,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorSocialProfiles": { "docs": undefined, + "inline": true, "properties": { "social_profiles": "optional>", "type": { @@ -6811,6 +6946,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorTags": { "docs": undefined, + "inline": true, "properties": { "tags": "optional>", "type": { @@ -6824,6 +6960,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorTagsTagsItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The id of the tag.", @@ -8238,6 +8375,7 @@ types: docs: The IP address of the admin. source: openapi: ../openapi.yml + inline: true ActivityLogActivityType: enum: - admin_assignment_limit_change @@ -8481,6 +8619,7 @@ types: format: uuid source: openapi: ../openapi.yml + inline: true AdminReplyTicketRequest: docs: Payload of the request to reply on behalf of an admin properties: @@ -8527,6 +8666,7 @@ types: format: uri source: openapi: ../openapi.yml + inline: true Admin: docs: Admins are the teammate accounts that have access to a workspace properties: @@ -9110,6 +9250,7 @@ types: participant. source: openapi: ../openapi.yml + inline: true ContactReplyIntercomUserIdRequest: docs: >- Payload of the request to reply on behalf of a contact using their @@ -9792,6 +9933,7 @@ types: docs: The identifier for the contact as given by Intercom. source: openapi: ../openapi.yml + inline: true CustomerRequestUserId: properties: user_id: @@ -9801,6 +9943,7 @@ types: a participant. source: openapi: ../openapi.yml + inline: true CustomerRequest: discriminated: false union: @@ -9829,6 +9972,7 @@ types: since: optional source: openapi: ../openapi.yml + inline: true DataEventList: docs: This will return a list of data events for the App. properties: @@ -10067,6 +10211,7 @@ types: was in error. source: openapi: ../openapi.yml + inline: true Error: docs: >- The API will return an Error List for a failed request, which will contain @@ -10346,6 +10491,7 @@ types: type: list source: openapi: ../openapi.yml + inline: true MultipleFilterSearchRequest: docs: Search using Intercoms Search APIs with more than one filter. properties: @@ -10540,6 +10686,7 @@ types: docs: The id of the conversation_part. source: openapi: ../openapi.yml + inline: true RedactConversationRequestSource: docs: Payload of the request to redact a conversation source properties: @@ -10551,6 +10698,7 @@ types: docs: The id of the source. source: openapi: ../openapi.yml + inline: true RedactConversationRequest: discriminant: type base-properties: {} @@ -10588,6 +10736,7 @@ types: - type: MultipleFilterSearchRequest source: openapi: ../openapi.yml + inline: true SearchRequest: docs: Search using Intercoms Search APIs. properties: @@ -10746,6 +10895,7 @@ types: docs: The company id you have defined for the company. source: openapi: ../openapi.yml + inline: true TagCompanyRequest: docs: You can tag a single company or a list of companies. properties: @@ -10775,6 +10925,7 @@ types: docs: The Intercom defined id representing the user. source: openapi: ../openapi.yml + inline: true TagMultipleUsersRequest: docs: You can tag a list of users. properties: @@ -11069,6 +11220,7 @@ types: docs: Always set to true source: openapi: ../openapi.yml + inline: true UntagCompanyRequest: docs: You can tag a single company or a list of companies. properties: @@ -11187,6 +11339,7 @@ types: format: uri source: openapi: ../openapi.yml + inline: true VisitorCompanies: properties: type: @@ -11195,6 +11348,7 @@ types: companies: optional> source: openapi: ../openapi.yml + inline: true VisitorLocationData: properties: type: @@ -11224,6 +11378,7 @@ types: docs: The timezone of the visitor. source: openapi: ../openapi.yml + inline: true VisitorSocialProfiles: properties: type: @@ -11232,6 +11387,7 @@ types: social_profiles: optional> source: openapi: ../openapi.yml + inline: true VisitorTagsTagsItem: properties: type: @@ -11245,6 +11401,7 @@ types: docs: The name of the tag. source: openapi: ../openapi.yml + inline: true VisitorTags: properties: type: @@ -11253,6 +11410,7 @@ types: tags: optional> source: openapi: ../openapi.yml + inline: true VisitorSegments: properties: type: @@ -11261,6 +11419,7 @@ types: segments: optional> source: openapi: ../openapi.yml + inline: true Visitor: docs: >- Visitors are useful for representing anonymous people that have not yet @@ -11807,6 +11966,7 @@ You can view the currently authorised admin along with the embedded app object ( "types": { "Admin": { "docs": "Admins are teammate accounts that have access to a workspace.", + "inline": undefined, "properties": { "avatar": { "docs": "Image for the associated team or teammate", @@ -12219,6 +12379,7 @@ types: "types": { "AiAgent": { "docs": "Data related to AI Agent involvement in the conversation.", + "inline": undefined, "properties": { "content_sources": { "type": "optional", @@ -12324,6 +12485,7 @@ imports: "types": { "ContentSource": { "docs": "The content source used by AI Agent in the conversation.", + "inline": undefined, "properties": { "content_type": { "docs": "The type of the content source.", @@ -14959,6 +15121,7 @@ imports: "extends": [ "Articles", ], + "inline": undefined, "properties": { "statistics": { "type": "optional", @@ -14981,6 +15144,7 @@ imports: }, "ArticleSearchHighlights": { "docs": "The highlighted results of an Article search. In the examples provided my search query is always "my query".", + "inline": undefined, "properties": { "article_id": { "docs": "The ID of the corresponding article.", @@ -15001,6 +15165,7 @@ imports: }, "ArticleSearchHighlightsHighlightedSummaryItemItem": { "docs": "An instance of highlighted summary text.", + "inline": true, "properties": { "text": { "docs": "The text of the title.", @@ -15027,6 +15192,7 @@ imports: }, "ArticleSearchHighlightsHighlightedTitleItem": { "docs": "A highlighted article title.", + "inline": true, "properties": { "text": { "docs": "The text of the title.", @@ -15053,6 +15219,7 @@ imports: }, "ArticleSearchResponse": { "docs": "The results of an Article search", + "inline": undefined, "properties": { "data": { "docs": "An object containing the results of the search.", @@ -15076,6 +15243,7 @@ imports: }, "ArticleSearchResponseData": { "docs": "An object containing the results of the search.", + "inline": true, "properties": { "articles": { "docs": "An array of Article objects", @@ -15092,6 +15260,7 @@ imports: }, "Articles": { "docs": "The data returned about your articles when you list them.", + "inline": undefined, "properties": { "author_id": { "docs": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", @@ -17553,6 +17722,7 @@ types: docs: The text of the title. source: openapi: ../openapi.yml + inline: true ArticleSearchHighlightsHighlightedSummaryItemItemType: enum: - highlight @@ -17571,6 +17741,7 @@ types: docs: The text of the title. source: openapi: ../openapi.yml + inline: true ArticleSearchHighlights: docs: >- The highlighted results of an Article search. In the examples provided my @@ -17599,6 +17770,7 @@ types: docs: A corresponding array of highlighted Article content source: openapi: ../openapi.yml + inline: true ArticleSearchResponse: docs: The results of an Article search properties: @@ -18728,6 +18900,7 @@ You can fetch all companies and filter by `segment_id` or `tag_id` as a query pa "types": { "Company": { "docs": "Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.", + "inline": undefined, "properties": { "app_id": { "docs": "The Intercom defined code of the workspace the company is associated to.", @@ -18811,6 +18984,7 @@ You can fetch all companies and filter by `segment_id` or `tag_id` as a query pa }, "CompanyPlan": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The id of the plan", @@ -18831,6 +19005,7 @@ You can fetch all companies and filter by `segment_id` or `tag_id` as a query pa }, "CompanySegments": { "docs": "The list of segments associated with the company", + "inline": true, "properties": { "segments": "optional>", "type": { @@ -18844,6 +19019,7 @@ You can fetch all companies and filter by `segment_id` or `tag_id` as a query pa }, "CompanyTags": { "docs": "The list of tags associated with the company", + "inline": true, "properties": { "tags": "optional>", "type": { @@ -19705,6 +19881,7 @@ types: docs: The name of the plan source: openapi: ../openapi.yml + inline: true CompanyTags: docs: The list of tags associated with the company properties: @@ -19714,6 +19891,7 @@ types: tags: optional> source: openapi: ../openapi.yml + inline: true CompanySegments: docs: The list of segments associated with the company properties: @@ -19723,6 +19901,7 @@ types: segments: optional> source: openapi: ../openapi.yml + inline: true Company: docs: >- Companies allow you to represent organizations using your product. Each @@ -21094,6 +21273,7 @@ The data property will show a combined list of: "types": { "Contact": { "docs": "Contact are the objects that represent your leads and users in Intercom.", + "inline": undefined, "properties": { "android_app_name": { "docs": "The name of the Android app which the contact is using.", @@ -21280,6 +21460,7 @@ The data property will show a combined list of: }, "ContactAvatar": { "docs": undefined, + "inline": true, "properties": { "image_url": { "docs": "An image URL containing the avatar of a contact.", @@ -22438,6 +22619,7 @@ types: format: uri source: openapi: ../openapi.yml + inline: true Contact: docs: Contact are the objects that represent your leads and users in Intercom. properties: @@ -27696,6 +27878,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -27713,6 +27896,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, }, "AttachContactToConversationRequestCustomerIntercomUserId": { "docs": undefined, + "inline": true, "properties": { "customer": { "type": "optional", @@ -27728,6 +27912,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, }, "AttachContactToConversationRequestCustomerUserId": { "docs": undefined, + "inline": true, "properties": { "customer": { "type": "optional", @@ -27743,6 +27928,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, }, "Conversation": { "docs": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.", + "inline": undefined, "properties": { "admin_assignee_id": { "docs": "The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null.", @@ -27864,6 +28050,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, }, "CreateConversationRequestFrom": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The identifier for the contact which is given by Intercom.", @@ -27897,6 +28084,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, }, "Email": { "docs": undefined, + "inline": true, "properties": { "customer": { "type": "optional", @@ -32104,6 +32292,7 @@ types: maxLength: 24 source: openapi: ../openapi.yml + inline: true ManageConversationRequestBody: discriminant: message_type base-properties: {} @@ -32127,6 +32316,7 @@ types: type: optional source: openapi: ../openapi.yml + inline: true AttachContactToConversationRequestCustomerUserId: properties: user_id: @@ -32138,6 +32328,7 @@ types: type: optional source: openapi: ../openapi.yml + inline: true Email: properties: email: @@ -32149,6 +32340,7 @@ types: type: optional source: openapi: ../openapi.yml + inline: true AttachContactToConversationRequestCustomer: discriminated: false union: @@ -32157,6 +32349,7 @@ types: - type: Email source: openapi: ../openapi.yml + inline: true ConversationState: enum: - open @@ -32264,6 +32457,7 @@ types: "types": { "CustomObjectInstance": { "docs": "A Custom Object Instance represents an instance of a custom object type. This allows you to create and set custom attributes to store data about your customers that is not already captured by Intercom. The parent object includes recommended default attributes and you can add your own custom attributes.", + "inline": undefined, "properties": { "custom_attributes": { "docs": "The custom attributes you have set on the custom object instance.", @@ -33238,6 +33432,7 @@ You can update a data attribute. }, "DataAttribute": { "docs": "Data Attributes are metadata used to describe your contact, company and conversation models. These include standard and custom attributes. By using the data attributes endpoint, you can get the global list of attributes for your workspace, as well as create and archive custom attributes.", + "inline": undefined, "properties": { "admin_id": { "docs": "Teammate who created the attribute. Only applicable to CDAs", @@ -34372,6 +34567,7 @@ You can optionally define the result page size as well with the `per_page` param "types": { "CreateDataEventSummariesRequestEventSummaries": { "docs": "A list of event summaries for the user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.", + "inline": true, "properties": { "count": { "docs": "The number of times the event occurred.", @@ -34396,6 +34592,7 @@ You can optionally define the result page size as well with the `per_page` param }, "DataEvent": { "docs": "Data events are used to notify Intercom of changes to your data.", + "inline": undefined, "properties": { "created_at": { "docs": "The time the event occurred as a UTC Unix timestamp", @@ -34438,6 +34635,7 @@ You can optionally define the result page size as well with the `per_page` param "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -34455,6 +34653,7 @@ You can optionally define the result page size as well with the `per_page` param }, "LisDataEventsRequestFilterEmail": { "docs": undefined, + "inline": true, "properties": { "email": "string", }, @@ -34464,6 +34663,7 @@ You can optionally define the result page size as well with the `per_page` param }, "LisDataEventsRequestFilterIntercomUserId": { "docs": undefined, + "inline": true, "properties": { "intercom_user_id": "string", }, @@ -34473,6 +34673,7 @@ You can optionally define the result page size as well with the `per_page` param }, "LisDataEventsRequestFilterUserId": { "docs": undefined, + "inline": true, "properties": { "user_id": "string", }, @@ -34488,16 +34689,19 @@ You can optionally define the result page size as well with the `per_page` param user_id: string source: openapi: ../openapi.yml + inline: true LisDataEventsRequestFilterIntercomUserId: properties: intercom_user_id: string source: openapi: ../openapi.yml + inline: true LisDataEventsRequestFilterEmail: properties: email: string source: openapi: ../openapi.yml + inline: true LisDataEventsRequestFilter: discriminated: false union: @@ -34530,6 +34734,7 @@ You can optionally define the result page size as well with the `per_page` param docs: The last time the event was sent source: openapi: ../openapi.yml + inline: true DataEvent: docs: Data events are used to notify Intercom of changes to your data. properties: @@ -35002,6 +35207,7 @@ Your exported message data will be streamed continuously back down to you in a g "types": { "DataExport": { "docs": "The data export api is used to view all message sent & viewed in a given timeframe.", + "inline": undefined, "properties": { "download_expires_at": { "docs": "The time after which you will not be able to access the data.", @@ -36651,6 +36857,7 @@ Collections will be returned in descending order on the `updated_at` attribute. "types": { "Collection": { "docs": "Collections are top level containers for Articles within the Help Center.", + "inline": undefined, "properties": { "created_at": { "docs": "The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.", @@ -36710,6 +36917,7 @@ Collections will be returned in descending order on the `updated_at` attribute. }, "HelpCenter": { "docs": "Help Centers contain collections", + "inline": undefined, "properties": { "created_at": { "docs": "The time when the Help Center was created.", @@ -36746,6 +36954,7 @@ Collections will be returned in descending order on the `updated_at` attribute. }, "HelpCenterList": { "docs": "A list of Help Centers belonging to the App", + "inline": undefined, "properties": { "data": { "docs": "An array of Help Center objects", @@ -38181,6 +38390,7 @@ This will return the Message model that has been created. "types": { "Message": { "docs": "Message are how you reach out to contacts in Intercom. They are created when an admin sends an outbound message to a contact.", + "inline": undefined, "properties": { "body": { "docs": "The message body, which may contain HTML.", @@ -38960,6 +39170,7 @@ types: "types": { "NewsItem": { "docs": "A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.", + "inline": undefined, "properties": { "body": { "docs": "The news item body, which may contain HTML.", @@ -39039,6 +39250,7 @@ types: Newsfeeds currently cannot be edited through the API, please refer to [this article](https://www.intercom.com/help/en/articles/6362267-getting-started-with-news) to set up your newsfeeds in Intercom. ", + "inline": undefined, "properties": { "created_at": { "docs": "Timestamp for when the newsfeed was created.", @@ -39063,6 +39275,7 @@ Newsfeeds currently cannot be edited through the API, please refer to [this arti }, "NewsfeedAssignment": { "docs": "Assigns a news item to a newsfeed.", + "inline": undefined, "properties": { "newsfeed_id": { "docs": "The unique identifier for the newsfeed which is given by Intercom. Publish dates cannot be in the future, to schedule news items use the dedicated feature in app (see this article).", @@ -39939,6 +40152,7 @@ types: "types": { "Note": { "docs": "Notes allow you to annotate and comment on your contacts.", + "inline": undefined, "properties": { "author": { "docs": "Optional. Represents the Admin that created the note.", @@ -39971,6 +40185,7 @@ types: }, "NoteContact": { "docs": "Represents the contact that the note was created about.", + "inline": true, "properties": { "id": { "docs": "The id of the contact.", @@ -40271,6 +40486,7 @@ types: docs: The id of the contact. source: openapi: ../openapi.yml + inline: true Note: docs: Notes allow you to annotate and comment on your contacts. properties: @@ -40420,6 +40636,7 @@ types: "types": { "Segment": { "docs": "A segment is a group of your contacts defined by the rules that you set.", + "inline": undefined, "properties": { "count": { "docs": "The number of items in the user segment. It's returned when `include_count=true` is included in the request.", @@ -40870,6 +41087,7 @@ This will return a subscription type model for the subscription type that was ad "types": { "SubscriptionType": { "docs": "A subscription type lets customers easily opt out of non-essential communications without missing what's important to them.", + "inline": undefined, "properties": { "consent_type": { "docs": "Describes the type of consent.", @@ -42204,6 +42422,7 @@ This will return a tag object. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -42224,6 +42443,7 @@ This will return a tag object. }, "Tag": { "docs": "A tag allows you to label your contacts, companies, and conversations and list them using that tag.", + "inline": undefined, "properties": { "applied_at": { "docs": "The time when the tag was applied to the object", @@ -42954,6 +43174,7 @@ types: "types": { "Team": { "docs": "Teams are groups of admins in Intercom.", + "inline": undefined, "properties": { "admin_ids": { "docs": "The list of admin IDs that are a part of the team.", @@ -45617,6 +45838,7 @@ The table below shows the operators you can use to define how you want to search "types": { "Contacts": { "docs": "The list of contacts affected by a ticket.", + "inline": undefined, "properties": { "contacts": { "docs": "The list of contacts affected by this ticket.", @@ -45635,6 +45857,7 @@ The table below shows the operators you can use to define how you want to search "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -45652,6 +45875,7 @@ The table below shows the operators you can use to define how you want to search }, "CreateTicketRequestContactsItemExternalId": { "docs": undefined, + "inline": true, "properties": { "external_id": { "docs": "The external_id you have defined for the contact who is being added as a participant.", @@ -45664,6 +45888,7 @@ The table below shows the operators you can use to define how you want to search }, "Email": { "docs": undefined, + "inline": true, "properties": { "email": { "docs": "The email you have defined for the contact who is being added as a participant. If a contact with this email does not exist, one will be created.", @@ -45676,6 +45901,7 @@ The table below shows the operators you can use to define how you want to search }, "ID": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The identifier for the contact as given by Intercom.", @@ -45690,6 +45916,7 @@ The table below shows the operators you can use to define how you want to search "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -45704,6 +45931,7 @@ The table below shows the operators you can use to define how you want to search }, "Ticket": { "docs": "Tickets are how you track requests from your users.", + "inline": undefined, "properties": { "admin_assignee_id": { "docs": "The id representing the admin assigned to the ticket.", @@ -45797,6 +46025,7 @@ The table below shows the operators you can use to define how you want to search }, "TicketPart": { "docs": "A Ticket Part represents a message in the ticket.", + "inline": undefined, "properties": { "assigned_to": { "docs": "The id of the admin that was assigned the ticket by this ticket_part (null if there has been no change in assignment.)", @@ -45892,6 +46121,7 @@ The table below shows the operators you can use to define how you want to search }, "TicketType": { "docs": "A ticket type, used to define the data fields to be captured in a ticket.", + "inline": undefined, "properties": { "archived": { "docs": "Whether the ticket type is archived or not.", @@ -45957,6 +46187,7 @@ The table below shows the operators you can use to define how you want to search }, "UpdateTicketRequestAssignment": { "docs": undefined, + "inline": true, "properties": { "admin_id": { "docs": "The ID of the admin performing the action.", @@ -46001,6 +46232,7 @@ types: docs: The identifier for the contact as given by Intercom. source: openapi: ../openapi.yml + inline: true CreateTicketRequestContactsItemExternalId: properties: external_id: @@ -46010,6 +46242,7 @@ types: a participant. source: openapi: ../openapi.yml + inline: true Email: properties: email: @@ -46020,6 +46253,7 @@ types: created. source: openapi: ../openapi.yml + inline: true CreateTicketRequestContactsItem: discriminated: false union: @@ -46028,6 +46262,7 @@ types: - type: Email source: openapi: ../openapi.yml + inline: true UpdateTicketRequestState: enum: - in_progress @@ -46048,6 +46283,7 @@ types: 0 to unassign it. source: openapi: ../openapi.yml + inline: true TicketCategory: enum: - Customer diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/json-string.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/json-string.json index 9c68f8b6963..516fcbe17fb 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/json-string.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/json-string.json @@ -8,6 +8,7 @@ "types": { "User": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/merge.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/merge.json index 95f50fc2068..5419f90792a 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/merge.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/merge.json @@ -8,6 +8,7 @@ "types": { "AccountDetails": { "docs": undefined, + "inline": undefined, "properties": { "category": "optional", "end_user_email_address": { @@ -58,6 +59,7 @@ The `LinkedAccount` object is used to represent an end user's link with a specif ### Usage Example View a list of your organization's `LinkedAccount` objects.", + "inline": undefined, "properties": { "category": "optional", "end_user_email_address": "string", @@ -79,6 +81,7 @@ View a list of your organization's `LinkedAccount` objects.", }, "AccountDetailsAndActionsIntegration": { "docs": undefined, + "inline": undefined, "properties": { "available_model_operations": "optional>", "categories": "list", @@ -108,6 +111,7 @@ View a list of your organization's `LinkedAccount` objects.", }, "AccountIntegration": { "docs": undefined, + "inline": undefined, "properties": { "api_endpoints_to_documentation_urls": { "docs": "Mapping of API endpoints to documentation urls for support. Example: {'GET': [['/common-model-scopes', 'https://docs.merge.dev/accounting/common-model-scopes/#common_model_scopes_retrieve'],['/common-model-actions', 'https://docs.merge.dev/accounting/common-model-actions/#common_model_actions_retrieve']], 'POST': []}", @@ -163,6 +167,7 @@ View a list of your organization's `LinkedAccount` objects.", }, "AccountToken": { "docs": undefined, + "inline": undefined, "properties": { "account_token": "string", "integration": "AccountIntegration", @@ -189,6 +194,7 @@ The `Activity` object is used to see all available model/operation combinations ### Usage Example Fetch all the actions available for the `Zenefits` integration.", + "inline": undefined, "properties": { "available_model_operations": "optional>", "integration": "AccountIntegration", @@ -205,6 +211,7 @@ The `BankInfo` object is used to represent the Bank Account information for an E ### Usage Example Fetch from the `LIST BankInfo` endpoint and filter by `ID` to show all bank information.", + "inline": undefined, "properties": { "account_number": { "docs": "The account number.", @@ -280,6 +287,7 @@ The `Benefit` object is used to represent a benefit that an employee has enrolle ### Usage Example Fetch from the `LIST Benefits` endpoint and filter by `ID` to show all benefits.", + "inline": undefined, "properties": { "benefit_plan_type": { "docs": "The type of benefit plan", @@ -387,6 +395,7 @@ Fetch from the `LIST Benefits` endpoint and filter by `ID` to show all benefits. }, "CommonModelScopesBodyRequest": { "docs": undefined, + "inline": undefined, "properties": { "disabled_fields": "list", "enabled_actions": "list", @@ -411,6 +420,7 @@ The `Company` object is used to represent a company within the HRIS / Payroll sy ### Usage Example Fetch from the `LIST Companies` endpoint and filter by `ID` to show all companies.", + "inline": undefined, "properties": { "display_name": { "docs": "The company's display name.", @@ -454,6 +464,7 @@ Fetch from the `LIST Companies` endpoint and filter by `ID` to show all companie }, "ConditionSchema": { "docs": undefined, + "inline": undefined, "properties": { "common_model": { "docs": "The common model for which a condition schema is defined.", @@ -1035,6 +1046,7 @@ The `DataPassthrough` object is used to send information to an otherwise-unsuppo ### Usage Example Create a `DataPassthrough` to get team hierarchies from your Rippling integration.", + "inline": undefined, "properties": { "base_url_override": { "type": "optional", @@ -1084,6 +1096,7 @@ Create a `DataPassthrough` to get team hierarchies from your Rippling integratio }, "DebugModeLog": { "docs": undefined, + "inline": undefined, "properties": { "dashboard_view": "string", "log_id": "string", @@ -1095,6 +1108,7 @@ Create a `DataPassthrough` to get team hierarchies from your Rippling integratio }, "DebugModelLogSummary": { "docs": undefined, + "inline": undefined, "properties": { "method": "string", "status_code": "integer", @@ -1111,6 +1125,7 @@ The `Deduction` object is used to represent an array of the wages withheld from ### Usage Example Fetch from the `LIST Deductions` endpoint and filter by `ID` to show all deductions.", + "inline": undefined, "properties": { "company_deduction": { "docs": "The amount of money that is withheld on behalf of an employee by the company.", @@ -1168,6 +1183,7 @@ The `Earning` object is used to represent an array of different compensations th ### Usage Example Fetch from the `LIST Earnings` endpoint and filter by `ID` to show all earnings.", + "inline": undefined, "properties": { "amount": { "docs": "The amount earned.", @@ -1241,6 +1257,7 @@ The `Employee` object is used to represent any person who has been employed by a ### Usage Example Fetch from the `LIST Employee` endpoint and filter by `ID` to show all employees.", + "inline": undefined, "properties": { "avatar": { "docs": "The URL of the employee's avatar image.", @@ -1464,6 +1481,7 @@ Fetch from the `LIST Employee` endpoint and filter by `ID` to show all employees }, "EmployeeEndpointRequest": { "docs": undefined, + "inline": undefined, "properties": { "model": "EmployeeRequest", }, @@ -1478,6 +1496,7 @@ The `EmployeePayrollRun` object is used to represent an employee's pay statement ### Usage Example Fetch from the `LIST EmployeePayrollRun` endpoint and filter by `ID` to show all employee payroll runs.", + "inline": undefined, "properties": { "check_date": { "docs": "The day and time the payroll run was checked.", @@ -1557,6 +1576,7 @@ The `Employee` object is used to represent any person who has been employed by a ### Usage Example Fetch from the `LIST Employee` endpoint and filter by `ID` to show all employees.", + "inline": undefined, "properties": { "avatar": { "docs": "The URL of the employee's avatar image.", @@ -1754,6 +1774,7 @@ Fetch from the `LIST Employee` endpoint and filter by `ID` to show all employees }, "EmployeeResponse": { "docs": undefined, + "inline": undefined, "properties": { "errors": "list", "logs": "optional>", @@ -1773,6 +1794,7 @@ Please note: When there is a change in pay or title, integrations with historica ### Usage Example Fetch from the `LIST Employments` endpoint and filter by `ID` to show all employees.", + "inline": undefined, "properties": { "effective_date": { "docs": "The position's effective date.", @@ -2248,6 +2270,7 @@ Fetch from the `LIST Employments` endpoint and filter by `ID` to show all employ }, "EndUserDetailsRequest": { "docs": undefined, + "inline": undefined, "properties": { "categories": { "docs": "The integration categories to show in Merge Link.", @@ -2321,6 +2344,7 @@ Fetch from the `LIST Employments` endpoint and filter by `ID` to show all employ }, "ErrorValidationProblem": { "docs": undefined, + "inline": undefined, "properties": { "detail": "string", "problem_type": "string", @@ -2396,6 +2420,7 @@ The `GenerateRemoteKey` object is used to represent a request for a new remote k ### Usage Example Post a `GenerateRemoteKey` to create a new remote key.", + "inline": undefined, "properties": { "name": { "type": "string", @@ -2418,6 +2443,7 @@ The `Group` object is used to represent any subset of employees, such as `PayGro ### Usage Example Fetch from the `LIST Employee` endpoint and expand groups to view an employee's groups.", + "inline": undefined, "properties": { "field_mappings": "optional>", "id": { @@ -2490,6 +2516,7 @@ Fetch from the `LIST Employee` endpoint and expand groups to view an employee's }, "IgnoreCommonModelRequest": { "docs": undefined, + "inline": undefined, "properties": { "message": { "type": "optional", @@ -2508,6 +2535,7 @@ Fetch from the `LIST Employee` endpoint and expand groups to view an employee's }, "Issue": { "docs": undefined, + "inline": undefined, "properties": { "end_user": "optional>", "error_description": "string", @@ -2549,6 +2577,7 @@ Fetch from the `LIST Employee` endpoint and expand groups to view an employee's }, "LinkToken": { "docs": undefined, + "inline": undefined, "properties": { "integration_name": "optional", "link_token": "string", @@ -2560,6 +2589,7 @@ Fetch from the `LIST Employee` endpoint and expand groups to view an employee's }, "LinkedAccountCondition": { "docs": undefined, + "inline": undefined, "properties": { "common_model": { "docs": "The common model for a specific condition.", @@ -2595,6 +2625,7 @@ Fetch from the `LIST Employee` endpoint and expand groups to view an employee's }, "LinkedAccountConditionRequest": { "docs": undefined, + "inline": undefined, "properties": { "condition_schema_id": { "docs": "The ID indicating which condition schema to use for a specific condition.", @@ -2624,6 +2655,7 @@ Fetch from the `LIST Employee` endpoint and expand groups to view an employee's }, "LinkedAccountSelectiveSyncConfiguration": { "docs": undefined, + "inline": undefined, "properties": { "linked_account_conditions": { "docs": "The conditions belonging to a selective sync.", @@ -2636,6 +2668,7 @@ Fetch from the `LIST Employee` endpoint and expand groups to view an employee's }, "LinkedAccountSelectiveSyncConfigurationRequest": { "docs": undefined, + "inline": undefined, "properties": { "linked_account_conditions": { "docs": "The conditions belonging to a selective sync.", @@ -2648,6 +2681,7 @@ Fetch from the `LIST Employee` endpoint and expand groups to view an employee's }, "LinkedAccountStatus": { "docs": undefined, + "inline": undefined, "properties": { "can_make_request": "boolean", "linked_account_status": "string", @@ -2663,6 +2697,7 @@ The `Location` object is used to represent an address that can be associated wit ### Usage Example Fetch from the `LIST Locations` endpoint and filter by `ID` to show all office locations.", + "inline": undefined, "properties": { "city": { "docs": "The location's city.", @@ -3011,6 +3046,7 @@ Fetch from the `LIST Locations` endpoint and filter by `ID` to show all office l }, "MetaResponse": { "docs": undefined, + "inline": undefined, "properties": { "has_conditional_params": "boolean", "has_required_linked_account_params": "boolean", @@ -3050,6 +3086,7 @@ The `ModelOperation` object is used to represent the operations that are current ### Usage Example View what operations are supported for the `Candidate` endpoint.", + "inline": undefined, "properties": { "available_operations": "list", "model_name": "string", @@ -3067,6 +3104,7 @@ The `MultipartFormField` object is used to represent fields in an HTTP request u ### Usage Example Create a `MultipartFormField` to define a multipart form entry.", + "inline": undefined, "properties": { "content_type": { "docs": "The MIME type of the file, if the field is for a file.", @@ -3123,6 +3161,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "OperatorSchema": { "docs": undefined, + "inline": undefined, "properties": { "is_unique": { "docs": "Whether the operator can be repeated multiple times.", @@ -3139,6 +3178,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedAccountDetailsAndActionsList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3150,6 +3190,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedBankInfoList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3161,6 +3202,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedBenefitList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3172,6 +3214,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedCompanyList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3183,6 +3226,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedConditionSchemaList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3194,6 +3238,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedEmployeeList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3205,6 +3250,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedEmployeePayrollRunList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3216,6 +3262,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedEmploymentList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3227,6 +3274,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedGroupList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3238,6 +3286,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedIssueList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3249,6 +3298,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedLocationList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3260,6 +3310,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedPayGroupList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3271,6 +3322,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedPayrollRunList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3282,6 +3334,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedSyncStatusList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3293,6 +3346,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedTeamList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3304,6 +3358,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedTimeOffBalanceList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3315,6 +3370,7 @@ Create a `MultipartFormField` to define a multipart form entry.", }, "PaginatedTimeOffList": { "docs": undefined, + "inline": undefined, "properties": { "next": "optional", "previous": "optional", @@ -3978,6 +4034,7 @@ The `PayGroup` object is used to represent a subset of employees that are put to ### Usage Example Fetch from the `LIST PayGroup` endpoint and filter by `ID` to show all pay group information.", + "inline": undefined, "properties": { "field_mappings": "optional>", "id": { @@ -4043,6 +4100,7 @@ The `PayrollRun` object is used to represent a group of pay statements for a spe ### Usage Example Fetch from the `LIST PayrollRuns` endpoint and filter by `ID` to show all payroll runs.", + "inline": undefined, "properties": { "check_date": { "docs": "The day and time the payroll run was checked.", @@ -4138,6 +4196,7 @@ Fetch from the `LIST PayrollRuns` endpoint and filter by `ID` to show all payrol }, "RemoteData": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional>", "path": "string", @@ -4153,6 +4212,7 @@ The `RemoteKey` object is used to represent a request for a new remote key. ### Usage Example Post a `GenerateRemoteKey` to receive a new `RemoteKey`.", + "inline": undefined, "properties": { "key": "string", "name": "string", @@ -4168,6 +4228,7 @@ The `RemoteKeyForRegeneration` object is used to exchange an old remote key for ### Usage Example Post a `RemoteKeyForRegeneration` to swap out an old remote key for a new one", + "inline": undefined, "properties": { "name": { "type": "string", @@ -4190,6 +4251,7 @@ The `RemoteResponse` object is used to represent information returned from a thi ### Usage Example View the `RemoteResponse` returned from your `DataPassthrough`.", + "inline": undefined, "properties": { "headers": "optional>", "method": "string", @@ -4298,6 +4360,7 @@ The `SyncStatus` object is used to represent the syncing state of an account ### Usage Example View the `SyncStatus` for an account to see how recently its models were synced.", + "inline": undefined, "properties": { "is_initial_sync": "boolean", "last_sync_start": "optional", @@ -4337,6 +4400,7 @@ The `Tax` object is used to represent an array of the tax deductions for a given ### Usage Example Fetch from the `LIST Taxes` endpoint and filter by `ID` to show all taxes.", + "inline": undefined, "properties": { "amount": { "docs": "The tax amount.", @@ -4394,6 +4458,7 @@ The `Team` object is used to represent a subdivision of the company, usually a d ### Usage Example If you're building a way to filter by `Team`, you'd hit the `GET Teams` endpoint to fetch the `Teams`, and then use the `ID` of the team your user selects to filter the `GET Employees` endpoint.", + "inline": undefined, "properties": { "field_mappings": "optional>", "id": { @@ -4444,6 +4509,7 @@ The `TimeOff` object is used to represent all employees' Time Off entries. ### Usage Example Fetch from the `LIST TimeOffs` endpoint and filter by `ID` to show all time off requests.", + "inline": undefined, "properties": { "amount": { "docs": "The time off quantity measured by the prescribed “units”.", @@ -4541,6 +4607,7 @@ The `TimeOffBalance` object is used to represent current balances for an employe ### Usage Example Fetch from the `LIST TimeOffBalances` endpoint and filter by `ID` to show all time off balances.", + "inline": undefined, "properties": { "balance": { "docs": "The current remaining PTO balance, always measured in terms of hours.", @@ -4601,6 +4668,7 @@ Fetch from the `LIST TimeOffBalances` endpoint and filter by `ID` to show all ti }, "TimeOffEndpointRequest": { "docs": undefined, + "inline": undefined, "properties": { "model": "TimeOffRequest", }, @@ -4615,6 +4683,7 @@ The `TimeOff` object is used to represent all employees' Time Off entries. ### Usage Example Fetch from the `LIST TimeOffs` endpoint and filter by `ID` to show all time off requests.", + "inline": undefined, "properties": { "amount": { "docs": "The time off quantity measured by the prescribed “units”.", @@ -4689,6 +4758,7 @@ Fetch from the `LIST TimeOffs` endpoint and filter by `ID` to show all time off }, "TimeOffResponse": { "docs": undefined, + "inline": undefined, "properties": { "errors": "list", "logs": "optional>", @@ -4729,6 +4799,7 @@ Fetch from the `LIST TimeOffs` endpoint and filter by `ID` to show all time off }, "ValidationProblemSource": { "docs": undefined, + "inline": undefined, "properties": { "pointer": "string", }, @@ -4738,6 +4809,7 @@ Fetch from the `LIST TimeOffs` endpoint and filter by `ID` to show all time off }, "WarningValidationProblem": { "docs": undefined, + "inline": undefined, "properties": { "detail": "string", "problem_type": "string", @@ -4750,6 +4822,7 @@ Fetch from the `LIST TimeOffs` endpoint and filter by `ID` to show all time off }, "WebhookReceiver": { "docs": undefined, + "inline": undefined, "properties": { "event": "string", "is_active": "boolean", @@ -4761,6 +4834,7 @@ Fetch from the `LIST TimeOffs` endpoint and filter by `ID` to show all time off }, "WebhookReceiverRequest": { "docs": undefined, + "inline": undefined, "properties": { "event": { "type": "string", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/multi-url-generators-yml.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/multi-url-generators-yml.json index 2136dc9d29b..af8583529ca 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/multi-url-generators-yml.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/multi-url-generators-yml.json @@ -126,6 +126,7 @@ "types": { "Token": { "docs": undefined, + "inline": undefined, "properties": { "accessToken": "optional", "expiresIn": "optional", @@ -137,6 +138,7 @@ }, "User": { "docs": undefined, + "inline": undefined, "properties": { "createdAt": "optional", "email": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/non-alphanumeric-characters.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/non-alphanumeric-characters.json index 43fd15d72e3..0e93f21bc04 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/non-alphanumeric-characters.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/non-alphanumeric-characters.json @@ -72,6 +72,7 @@ }, "Settings": { "docs": undefined, + "inline": undefined, "properties": { "separator": "optional", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/ntropy.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/ntropy.json index 0d731e2be4b..3f6b0f5c44f 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/ntropy.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/ntropy.json @@ -42,6 +42,7 @@ "types": { "Account": { "docs": undefined, + "inline": undefined, "properties": { "closing_balance": { "type": "optional", @@ -65,6 +66,7 @@ }, "AccountHolder": { "docs": undefined, + "inline": undefined, "properties": { "address": { "type": "optional
", @@ -82,6 +84,7 @@ }, "AccountHolderExternal": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "The timestamp of when the account holder was created.", @@ -154,6 +157,7 @@ }, "Address": { "docs": undefined, + "inline": undefined, "properties": { "city": { "type": "optional", @@ -177,6 +181,7 @@ }, "BankStatement": { "docs": "Represents a bank statement with details about the file and its status.", + "inline": undefined, "properties": { "created_at": { "docs": "The date and time when the job was created.", @@ -208,6 +213,7 @@ }, "BankStatementAccount": { "docs": undefined, + "inline": undefined, "properties": { "closing_balance": { "docs": "The closing balance of the account for the statement period.", @@ -264,6 +270,7 @@ }, "BankStatementError": { "docs": undefined, + "inline": undefined, "properties": { "code": { "type": "BankStatementErrorCode", @@ -286,6 +293,7 @@ }, "BankStatementFile": { "docs": undefined, + "inline": undefined, "properties": { "no_pages": { "docs": "The number of pages in the bank statement file.", @@ -302,6 +310,7 @@ }, "BankStatementResults": { "docs": undefined, + "inline": undefined, "properties": { "accounts": { "docs": "List of accounts in the bank statement.", @@ -325,6 +334,7 @@ }, "BankStatementTransaction": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "The amount of the transaction in the `currency`. Must be a positive value. For example, if the `currency` is USD, then it's the amount in dollars.", @@ -386,6 +396,7 @@ }, "Batch": { "docs": "The `Batch` object represents the status and progress of an asynchronous batch enrichment job.", + "inline": undefined, "properties": { "created_at": { "docs": "The timestamp of when the batch was created.", @@ -419,6 +430,7 @@ "BatchResult": { "docs": "The `BatchResult` object represents the result of a batch enrichment job, including its status and enriched transactions.", + "inline": undefined, "properties": { "id": { "docs": "A unique identifier for the batch.", @@ -453,6 +465,7 @@ enriched transactions.", }, "Categories": { "docs": undefined, + "inline": undefined, "properties": { "accounting": { "docs": "The corresponding accounting category. Only available for `business` transactions.", @@ -481,6 +494,7 @@ enriched transactions.", }, "CategorySet": { "docs": undefined, + "inline": undefined, "properties": { "incoming": { "type": "list", @@ -495,6 +509,7 @@ enriched transactions.", }, "Counterparty": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The unique UUID identifier of the entity", @@ -946,6 +961,7 @@ enriched transactions.", }, "CustomCategorySet": { "docs": undefined, + "inline": undefined, "properties": { "incoming": { "type": "list", @@ -986,6 +1002,7 @@ enriched transactions.", }, "EnrichedTransaction": { "docs": undefined, + "inline": undefined, "properties": { "categories": { "type": "optional", @@ -1020,6 +1037,7 @@ enriched transactions.", }, "EnrichmentResult": { "docs": undefined, + "inline": undefined, "properties": { "transactions": { "docs": "A list of enriched transactions resulting from the enrichment of this batch.", @@ -1032,6 +1050,7 @@ enriched transactions.", }, "Entities": { "docs": "Entities found by identity identification", + "inline": undefined, "properties": { "counterparty": { "type": "optional", @@ -1046,6 +1065,7 @@ enriched transactions.", }, "Entity": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The unique UUID identifier of the entity", @@ -1092,6 +1112,7 @@ enriched transactions.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -1163,6 +1184,7 @@ enriched transactions.", }, "FnCall!": { "docs": undefined, + "inline": true, "properties": { "!": { "type": "expression", @@ -1174,6 +1196,7 @@ enriched transactions.", }, "FnCall&&": { "docs": undefined, + "inline": true, "properties": { "&&": "list", }, @@ -1183,6 +1206,7 @@ enriched transactions.", }, "FnCall*": { "docs": undefined, + "inline": true, "properties": { "*": "list", }, @@ -1192,6 +1216,7 @@ enriched transactions.", }, "FnCall+": { "docs": undefined, + "inline": true, "properties": { "+": "list", }, @@ -1201,6 +1226,7 @@ enriched transactions.", }, "FnCall-": { "docs": undefined, + "inline": true, "properties": { "-": "list", }, @@ -1210,6 +1236,7 @@ enriched transactions.", }, "FnCall/": { "docs": undefined, + "inline": true, "properties": { "/": "list", }, @@ -1219,6 +1246,7 @@ enriched transactions.", }, "FnCall//": { "docs": undefined, + "inline": true, "properties": { "//": "list", }, @@ -1228,6 +1256,7 @@ enriched transactions.", }, "FnCall<": { "docs": undefined, + "inline": true, "properties": { "<": "list", }, @@ -1237,6 +1266,7 @@ enriched transactions.", }, "FnCall<=": { "docs": undefined, + "inline": true, "properties": { "<=": "list", }, @@ -1246,6 +1276,7 @@ enriched transactions.", }, "FnCall==": { "docs": undefined, + "inline": true, "properties": { "==": "list", }, @@ -1255,6 +1286,7 @@ enriched transactions.", }, "FnCall>": { "docs": undefined, + "inline": true, "properties": { ">": "list", }, @@ -1264,6 +1296,7 @@ enriched transactions.", }, "FnCall>=": { "docs": undefined, + "inline": true, "properties": { ">=": "list", }, @@ -1273,6 +1306,7 @@ enriched transactions.", }, "FnCallEndsWith": { "docs": undefined, + "inline": true, "properties": { "ends_with": "list", }, @@ -1282,6 +1316,7 @@ enriched transactions.", }, "FnCallGet": { "docs": undefined, + "inline": true, "properties": { "get": { "type": "properties", @@ -1293,6 +1328,7 @@ enriched transactions.", }, "FnCallHasLabel": { "docs": undefined, + "inline": true, "properties": { "has_label": { "type": "expression", @@ -1304,6 +1340,7 @@ enriched transactions.", }, "FnCallHasMcc": { "docs": undefined, + "inline": true, "properties": { "has_mcc": { "type": "expression", @@ -1315,6 +1352,7 @@ enriched transactions.", }, "FnCallIsSubstring": { "docs": undefined, + "inline": true, "properties": { "is_substring": "list", }, @@ -1324,6 +1362,7 @@ enriched transactions.", }, "FnCallStartsWith": { "docs": undefined, + "inline": true, "properties": { "starts_with": "list", }, @@ -1333,6 +1372,7 @@ enriched transactions.", }, "FnCallToLower": { "docs": undefined, + "inline": true, "properties": { "to_lower": { "type": "expression", @@ -1344,6 +1384,7 @@ enriched transactions.", }, "FnCallToUpper": { "docs": undefined, + "inline": true, "properties": { "to_upper": { "type": "expression", @@ -1355,6 +1396,7 @@ enriched transactions.", }, "FnCall||": { "docs": undefined, + "inline": true, "properties": { "||": "list", }, @@ -1364,6 +1406,7 @@ enriched transactions.", }, "HTTPValidationError": { "docs": undefined, + "inline": undefined, "properties": { "detail": { "type": "optional>", @@ -1375,6 +1418,7 @@ enriched transactions.", }, "Intermediary": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The unique UUID identifier of the entity", @@ -1416,6 +1460,7 @@ enriched transactions.", }, "Location": { "docs": undefined, + "inline": undefined, "properties": { "raw_address": { "docs": "An unstructured string containing the address", @@ -1433,6 +1478,7 @@ enriched transactions.", "LocationInput": { "docs": "Location of where the transaction has taken place. This can greatly improve entity identification, especially under ambiguity.", + "inline": undefined, "properties": { "country": { "docs": "The country where the transaction was made in ISO 3166-2 format", @@ -1449,6 +1495,7 @@ under ambiguity.", }, "LocationStructured": { "docs": undefined, + "inline": undefined, "properties": { "apple_maps_url": { "docs": "A URL link to view the location on Apple Maps", @@ -1503,6 +1550,7 @@ under ambiguity.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -1529,6 +1577,7 @@ under ambiguity.", }, "ModifyLabelsAddLabel": { "docs": undefined, + "inline": true, "properties": { "add_label": { "type": "expression", @@ -1540,6 +1589,7 @@ under ambiguity.", }, "ModifyLabelsAddMcc": { "docs": undefined, + "inline": true, "properties": { "add_mcc": { "type": "expression", @@ -1551,6 +1601,7 @@ under ambiguity.", }, "ModifyLabelsRemoveLabel": { "docs": undefined, + "inline": true, "properties": { "remove_label": { "type": "expression", @@ -1562,6 +1613,7 @@ under ambiguity.", }, "ModifyLabelsRemoveMcc": { "docs": undefined, + "inline": true, "properties": { "remove_mcc": { "type": "expression", @@ -1573,6 +1625,7 @@ under ambiguity.", }, "ModifyLabelsSetLabels": { "docs": undefined, + "inline": true, "properties": { "set_labels": "list", }, @@ -1582,6 +1635,7 @@ under ambiguity.", }, "ModifyLabelsSetMcc": { "docs": undefined, + "inline": true, "properties": { "set_mcc": "list", }, @@ -1591,6 +1645,7 @@ under ambiguity.", }, "PagedResponseAccountHolderExternal": { "docs": undefined, + "inline": undefined, "properties": { "data": { "type": "list", @@ -1603,6 +1658,7 @@ under ambiguity.", }, "PagedResponseBankStatement": { "docs": undefined, + "inline": undefined, "properties": { "data": { "type": "list", @@ -1615,6 +1671,7 @@ under ambiguity.", }, "PagedResponseBatch": { "docs": undefined, + "inline": undefined, "properties": { "data": { "type": "list", @@ -1627,6 +1684,7 @@ under ambiguity.", }, "PagedResponseReport": { "docs": undefined, + "inline": undefined, "properties": { "data": { "type": "list", @@ -1641,6 +1699,7 @@ under ambiguity.", }, "PagedResponseTransaction": { "docs": undefined, + "inline": undefined, "properties": { "data": { "type": "list", @@ -1653,6 +1712,7 @@ under ambiguity.", }, "PagedResponseWebhook": { "docs": undefined, + "inline": undefined, "properties": { "data": { "type": "list", @@ -1666,6 +1726,7 @@ under ambiguity.", "Recurrence": { "docs": "The `Recurrence` object represents the recurrence pattern of a transaction. It provides information about whether a transaction is a one-time event or a part of a recurring series.", + "inline": undefined, "properties": { "type": { "docs": "Whether the transaction is a one-time transfer `one-off`, regularly with varying pricing `recurring` or with fixed pricing `subscription`", @@ -1678,6 +1739,7 @@ whether a transaction is a one-time event or a part of a recurring series.", }, "RecurrenceGroup": { "docs": undefined, + "inline": undefined, "properties": { "average_amount": { "docs": "The average amount per transaction in this group", @@ -1769,6 +1831,7 @@ whether a transaction is a one-time event or a part of a recurring series.", }, "Report": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "The date and time when the report was created.", @@ -1828,6 +1891,7 @@ whether a transaction is a one-time event or a part of a recurring series.", }, "StatementInfo": { "docs": undefined, + "inline": undefined, "properties": { "account_holder": { "type": "optional", @@ -1863,6 +1927,7 @@ whether a transaction is a one-time event or a part of a recurring series.", }, "SyncEnrichmentOutput": { "docs": undefined, + "inline": undefined, "properties": { "transactions": { "docs": "A list of enriched transactions resulting from the enrichment of this batch.", @@ -1875,6 +1940,7 @@ whether a transaction is a one-time event or a part of a recurring series.", }, "Transaction": { "docs": undefined, + "inline": undefined, "properties": { "account_holder_id": { "docs": "The unique ID of the account holder of the transaction", @@ -1961,6 +2027,7 @@ whether a transaction is a one-time event or a part of a recurring series.", }, "TransactionError": { "docs": undefined, + "inline": undefined, "properties": { "code": { "type": "TransactionErrorCode", @@ -1983,6 +2050,7 @@ whether a transaction is a one-time event or a part of a recurring series.", }, "TransactionInput": { "docs": undefined, + "inline": undefined, "properties": { "account_holder_id": { "docs": "The unique ID of the account holder. Unsetting it will disable [categorization](./docs/v3/enrichment/entities).", @@ -2047,6 +2115,7 @@ whether a transaction is a one-time event or a part of a recurring series.", }, "ValidationError": { "docs": undefined, + "inline": undefined, "properties": { "loc": { "type": "list", @@ -2062,6 +2131,7 @@ whether a transaction is a one-time event or a part of a recurring series.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -2072,6 +2142,7 @@ whether a transaction is a one-time event or a part of a recurring series.", }, "Webhook": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "The date and time when the webhook was created.", @@ -2153,6 +2224,7 @@ whether a transaction is a one-time event or a part of a recurring series.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -2172,6 +2244,7 @@ whether a transaction is a one-time event or a part of a recurring series.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -2184,6 +2257,7 @@ whether a transaction is a one-time event or a part of a recurring series.", }, "if": { "docs": undefined, + "inline": undefined, "properties": { "else": { "type": "optional>", @@ -2221,6 +2295,7 @@ whether a transaction is a one-time event or a part of a recurring series.", }, "set": { "docs": undefined, + "inline": undefined, "properties": { "set": { "type": "EditableTxProp", @@ -3506,6 +3581,7 @@ types: - integer source: openapi: ../openapi.yml + inline: true ValidationError: properties: loc: @@ -3594,112 +3670,133 @@ types: '&&': list source: openapi: ../openapi.yml + inline: true FnCall||: properties: '||': list source: openapi: ../openapi.yml + inline: true FnCall==: properties: '==': list source: openapi: ../openapi.yml + inline: true FnCall+: properties: +: list source: openapi: ../openapi.yml + inline: true FnCall-: properties: '-': list source: openapi: ../openapi.yml + inline: true FnCall*: properties: '*': list source: openapi: ../openapi.yml + inline: true FnCall/: properties: /: list source: openapi: ../openapi.yml + inline: true FnCall//: properties: //: list source: openapi: ../openapi.yml + inline: true FnCall<: properties: <: list source: openapi: ../openapi.yml + inline: true FnCall<=: properties: <=: list source: openapi: ../openapi.yml + inline: true FnCall>: properties: '>': list source: openapi: ../openapi.yml + inline: true FnCall>=: properties: '>=': list source: openapi: ../openapi.yml + inline: true FnCall!: properties: '!': type: expression source: openapi: ../openapi.yml + inline: true FnCallIsSubstring: properties: is_substring: list source: openapi: ../openapi.yml + inline: true FnCallStartsWith: properties: starts_with: list source: openapi: ../openapi.yml + inline: true FnCallEndsWith: properties: ends_with: list source: openapi: ../openapi.yml + inline: true FnCallToLower: properties: to_lower: type: expression source: openapi: ../openapi.yml + inline: true FnCallToUpper: properties: to_upper: type: expression source: openapi: ../openapi.yml + inline: true FnCallHasLabel: properties: has_label: type: expression source: openapi: ../openapi.yml + inline: true FnCallHasMcc: properties: has_mcc: type: expression source: openapi: ../openapi.yml + inline: true FnCallGet: properties: get: type: properties source: openapi: ../openapi.yml + inline: true FnCall: discriminated: false union: @@ -3750,34 +3847,40 @@ types: type: expression source: openapi: ../openapi.yml + inline: true ModifyLabelsRemoveLabel: properties: remove_label: type: expression source: openapi: ../openapi.yml + inline: true ModifyLabelsSetLabels: properties: set_labels: list source: openapi: ../openapi.yml + inline: true ModifyLabelsAddMcc: properties: add_mcc: type: expression source: openapi: ../openapi.yml + inline: true ModifyLabelsRemoveMcc: properties: remove_mcc: type: expression source: openapi: ../openapi.yml + inline: true ModifyLabelsSetMcc: properties: set_mcc: list source: openapi: ../openapi.yml + inline: true ModifyLabels: discriminated: false union: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/oauth.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/oauth.json index 55f9269234b..4fa557b7ba4 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/oauth.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/oauth.json @@ -129,6 +129,7 @@ }, "AuthGetTokenResponse": { "docs": undefined, + "inline": undefined, "properties": { "access_token": "optional", "expires_in": { diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/only-include-referenced-schemas.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/only-include-referenced-schemas.json index 5128a4ed477..85b24e896f7 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/only-include-referenced-schemas.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/only-include-referenced-schemas.json @@ -2745,6 +2745,7 @@ "types": { "ActivityLog": { "docs": "Activities performed by Admins.", + "inline": undefined, "properties": { "activity_description": { "docs": "A sentence or two describing the activity.", @@ -2849,6 +2850,7 @@ }, "ActivityLogList": { "docs": "A paginated list of activity logs.", + "inline": undefined, "properties": { "activity_logs": { "docs": "An array of activity logs", @@ -2868,6 +2870,7 @@ }, "ActivityLogMetadata": { "docs": "Additional data provided about Admin activity.", + "inline": undefined, "properties": { "auto_changed": { "docs": "Indicates if the status was changed automatically or manually.", @@ -2912,6 +2915,7 @@ }, "ActivityLogPerformedBy": { "docs": "Details about the Admin involved in the activity.", + "inline": true, "properties": { "email": { "docs": "The email of the admin.", @@ -2936,6 +2940,7 @@ }, "AddressableList": { "docs": "A list used to access other resources from a parent model.", + "inline": undefined, "properties": { "id": { "docs": "The id of the addressable object", @@ -2968,6 +2973,7 @@ }, "Admin": { "docs": "Admins are the teammate accounts that have access to a workspace", + "inline": undefined, "properties": { "app": { "docs": "App that the admin belongs to.", @@ -3024,6 +3030,7 @@ }, "AdminPriorityLevel": { "docs": "Admin priority levels for the team", + "inline": undefined, "properties": { "primary_admin_ids": { "docs": "The primary admin ids for the team", @@ -3040,6 +3047,7 @@ }, "AdminReplyConversationRequest": { "docs": "Payload of the request to reply on behalf of an admin", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is authoring the comment.", @@ -3079,6 +3087,7 @@ }, "AdminReplyTicketRequest": { "docs": "Payload of the request to reply on behalf of an admin", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is authoring the comment.", @@ -3119,6 +3128,7 @@ }, "AdminReplyTicketRequestReplyOptionsItem": { "docs": undefined, + "inline": true, "properties": { "text": { "docs": "The text to display in this quick reply option.", @@ -3141,6 +3151,7 @@ }, "AdminWithAppAvatar": { "docs": "This object represents the avatar associated with the admin.", + "inline": true, "properties": { "image_url": { "docs": "This object represents the avatar associated with the admin.", @@ -3164,6 +3175,7 @@ }, "Admins": { "docs": "A list of admins associated with a given workspace.", + "inline": undefined, "properties": { "admins": { "docs": "A list of admins associated with a given workspace.", @@ -3180,6 +3192,7 @@ }, "App": { "docs": "App is a workspace on Intercom", + "inline": undefined, "properties": { "created_at": { "docs": "When the app was created.", @@ -3217,6 +3230,7 @@ }, "ArticleContent": { "docs": "The Content of an Article.", + "inline": undefined, "properties": { "author_id": { "docs": "The ID of the author of the article.", @@ -3271,6 +3285,7 @@ }, "ArticleStatistics": { "docs": "The statistics of an article.", + "inline": undefined, "properties": { "conversions": { "docs": "The number of conversations started from the article.", @@ -3307,6 +3322,7 @@ }, "ArticleTranslatedContent": { "docs": "The Translated Content of an Article. The keys are the locale codes and the values are the translated content of the article.", + "inline": undefined, "properties": { "ar": { "docs": "The content of the article in Arabic", @@ -3467,6 +3483,7 @@ }, "Articles": { "docs": "This will return a list of articles for the App.", + "inline": undefined, "properties": { "data": { "docs": "An array of Article objects", @@ -3490,6 +3507,7 @@ }, "AssignConversationRequest": { "docs": "Payload of the request to assign a conversation", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is performing the action.", @@ -3520,6 +3538,7 @@ }, "CloseConversationRequest": { "docs": "Payload of the request to close a conversation", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is performing the action.", @@ -3537,6 +3556,7 @@ }, "Collections": { "docs": "This will return a list of Collections for the App.", + "inline": undefined, "properties": { "data": { "docs": "An array of collection objects", @@ -3560,6 +3580,7 @@ }, "Companies": { "docs": "This will return a list of companies for the App.", + "inline": undefined, "properties": { "data": { "docs": "An array containing Company Objects.", @@ -3583,6 +3604,7 @@ }, "CompanyAttachedContacts": { "docs": "A list of Contact Objects", + "inline": undefined, "properties": { "data": { "docs": "An array containing Contact Objects", @@ -3606,6 +3628,7 @@ }, "CompanyAttachedSegments": { "docs": "A list of Segment Objects", + "inline": undefined, "properties": { "data": { "docs": "An array containing Segment Objects", @@ -3622,6 +3645,7 @@ }, "CompanyScroll": { "docs": "Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.", + "inline": undefined, "properties": { "data": { "type": "optional>", @@ -3648,6 +3672,7 @@ }, "ContactArchived": { "docs": "archived contact object", + "inline": undefined, "properties": { "archived": { "docs": "Whether the contact is archived or not.", @@ -3672,6 +3697,7 @@ }, "ContactAttachedCompanies": { "docs": "A list of Company Objects", + "inline": undefined, "properties": { "companies": { "docs": "An array containing Company Objects", @@ -3695,6 +3721,7 @@ }, "ContactCompanies": { "docs": "An object containing companies meta data about the companies that a contact has. Up to 10 will be displayed here. Use the url to get more.", + "inline": undefined, "properties": { "has_more": { "docs": "Whether there's more Addressable Objects to be viewed. If true, use the url to view all", @@ -3721,6 +3748,7 @@ }, "ContactDeleted": { "docs": "deleted contact object", + "inline": undefined, "properties": { "deleted": { "docs": "Whether the contact is deleted or not.", @@ -3745,6 +3773,7 @@ }, "ContactList": { "docs": "Contacts are your users in Intercom.", + "inline": undefined, "properties": { "data": { "docs": "The list of contact objects", @@ -3768,6 +3797,7 @@ }, "ContactLocation": { "docs": "An object containing location meta data about a Intercom contact.", + "inline": undefined, "properties": { "city": { "docs": "The city that the contact is located in", @@ -3792,6 +3822,7 @@ }, "ContactNotes": { "docs": "An object containing notes meta data about the notes that a contact has. Up to 10 will be displayed here. Use the url to get more.", + "inline": undefined, "properties": { "data": { "docs": "This object represents the notes attached to a contact.", @@ -3822,6 +3853,7 @@ }, "ContactReference": { "docs": "reference to contact object", + "inline": undefined, "properties": { "external_id": { "docs": "The unique identifier for the contact which is provided by the Client.", @@ -3842,6 +3874,7 @@ }, "ContactReplyBaseRequest": { "docs": undefined, + "inline": undefined, "properties": { "attachment_urls": { "docs": "A list of image URLs that will be added as attachments. You can include up to 10 URLs.", @@ -3866,6 +3899,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -3886,6 +3920,7 @@ "extends": [ "ContactReplyBaseRequest", ], + "inline": undefined, "properties": { "attachment_files": { "docs": "A list of files that will be added as attachments.", @@ -3905,6 +3940,7 @@ "extends": [ "ContactReplyBaseRequest", ], + "inline": undefined, "properties": { "intercom_user_id": { "docs": "The identifier for the contact as given by Intercom.", @@ -3919,6 +3955,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -3939,6 +3976,7 @@ "extends": [ "ContactReplyBaseRequest", ], + "inline": undefined, "properties": { "user_id": { "docs": "The external_id you have defined for the contact.", @@ -3954,6 +3992,7 @@ "extends": [ "ContactReplyBaseRequest", ], + "inline": undefined, "properties": { "attachment_files": { "docs": "A list of files that will be added as attachments. You can include up to 10 files.", @@ -3970,6 +4009,7 @@ }, "ContactSocialProfiles": { "docs": "An object containing social profiles that a contact has.", + "inline": undefined, "properties": { "data": { "docs": "A list of social profiles objects associated with the contact.", @@ -3982,6 +4022,7 @@ }, "ContactTags": { "docs": "An object containing tags meta data about the tags that a contact has. Up to 10 will be displayed here. Use the url to get more.", + "inline": undefined, "properties": { "data": { "docs": "This object represents the tags attached to a contact.", @@ -4012,6 +4053,7 @@ }, "ContactUnarchived": { "docs": "unarchived contact object", + "inline": undefined, "properties": { "archived": { "docs": "Whether the contact is archived or not.", @@ -4036,6 +4078,7 @@ }, "Contacts": { "docs": "The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.", + "inline": undefined, "properties": { "contacts": { "docs": "The list of contacts (users or leads) involved in this conversation. This will only contain one customer unless more were added via the group conversation feature.", @@ -4052,6 +4095,7 @@ }, "ContentSourcesList": { "docs": undefined, + "inline": undefined, "properties": { "content_sources": { "docs": "The content sources used by AI Agent in the conversation.", @@ -4071,6 +4115,7 @@ }, "ConversationAttachmentFiles": { "docs": "Properties of the attachment files in a conversation part", + "inline": undefined, "properties": { "content_type": { "docs": "The content type of the file", @@ -4091,6 +4136,7 @@ }, "ConversationFirstContactReply": { "docs": "An object containing information on the first users message. For a contact initiated message this will represent the users original message.", + "inline": undefined, "properties": { "created_at": { "docs": "", @@ -4111,6 +4157,7 @@ }, "ConversationList": { "docs": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.", + "inline": undefined, "properties": { "conversations": { "docs": "The list of conversation objects", @@ -4134,6 +4181,7 @@ }, "ConversationPart": { "docs": "A Conversation Part represents a message in the conversation.", + "inline": undefined, "properties": { "assigned_to": { "docs": "The id of the admin that was assigned the conversation by this conversation_part (null if there has been no change in assignment.)", @@ -4189,6 +4237,7 @@ }, "ConversationPartAuthor": { "docs": "The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank.", + "inline": undefined, "properties": { "email": { "docs": "The email of the author", @@ -4219,6 +4268,7 @@ }, "ConversationParts": { "docs": "A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.", + "inline": undefined, "properties": { "conversation_parts": { "docs": "A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.", @@ -4239,6 +4289,7 @@ }, "ConversationRating": { "docs": "The Conversation Rating object which contains information on the rating and/or remark added by a Contact and the Admin assigned to the conversation.", + "inline": undefined, "properties": { "contact": { "type": "optional", @@ -4265,6 +4316,7 @@ }, "ConversationSource": { "docs": "The Conversation Part that originated this conversation, which can be Contact, Admin, Campaign, Automated or Operator initiated.", + "inline": undefined, "properties": { "attachments": { "docs": "A list of attachments for the part.", @@ -4308,6 +4360,7 @@ }, "ConversationStatistics": { "docs": "A Statistics object containing all information required for reporting, with timestamps and calculated metrics.", + "inline": undefined, "properties": { "count_assignments": { "docs": "Number of assignments after first_contact_reply_at.", @@ -4392,6 +4445,7 @@ }, "ConversationTeammates": { "docs": "The list of teammates who participated in the conversation (wrote at least one conversation part).", + "inline": undefined, "properties": { "teammates": { "docs": "The list of teammates who participated in the conversation (wrote at least one conversation part).", @@ -4408,6 +4462,7 @@ }, "CreateArticleRequest": { "docs": "You can create an Article", + "inline": undefined, "properties": { "author_id": { "docs": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", @@ -4460,6 +4515,7 @@ "CreateMessageRequestOne": "unknown", "CreateOrUpdateCompanyRequest": { "docs": "You can create or update a Company", + "inline": undefined, "properties": { "company_id": { "docs": "The company id you have defined for the company. Can't be updated", @@ -4504,6 +4560,7 @@ }, "CreateOrUpdateTagRequest": { "docs": "You can create or update an existing tag.", + "inline": undefined, "properties": { "id": { "docs": "The id of tag to updates.", @@ -4520,6 +4577,7 @@ }, "CreatePhoneSwitchRequest": { "docs": "You can create an phone switch", + "inline": undefined, "properties": { "custom_attributes": { "type": "optional", @@ -4537,6 +4595,7 @@ "docs": "The request payload for creating a ticket type. You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) ", + "inline": undefined, "properties": { "category": { "docs": "Category of the Ticket Type.", @@ -4583,6 +4642,7 @@ "docs": "Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed. ", + "inline": undefined, "properties": { "next": { "type": "optional", @@ -4616,6 +4676,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -4630,6 +4691,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -4647,6 +4709,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "CustomerRequestIntercomUserId": { "docs": undefined, + "inline": true, "properties": { "intercom_user_id": { "docs": "The identifier for the contact as given by Intercom.", @@ -4659,6 +4722,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "CustomerRequestUserId": { "docs": undefined, + "inline": true, "properties": { "user_id": { "docs": "The external_id you have defined for the contact who is being added as a participant.", @@ -4671,6 +4735,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DataAttributeList": { "docs": "A list of all data attributes belonging to a workspace for contacts, companies or conversations.", + "inline": undefined, "properties": { "data": { "docs": "A list of data attributes", @@ -4687,6 +4752,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DataEventSummary": { "docs": "This will return a summary of data events for the App.", + "inline": undefined, "properties": { "email": { "docs": "The email address of the user", @@ -4715,6 +4781,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DataEventSummaryItem": { "docs": "This will return a summary of a data event for the App.", + "inline": undefined, "properties": { "count": { "docs": "The number of times the event was sent", @@ -4743,6 +4810,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DeletedArticleObject": { "docs": "Response returned when an object is deleted", + "inline": undefined, "properties": { "deleted": { "docs": "Whether the article was deleted successfully or not.", @@ -4763,6 +4831,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DeletedCollectionObject": { "docs": "Response returned when an object is deleted", + "inline": undefined, "properties": { "deleted": { "docs": "Whether the collection was deleted successfully or not.", @@ -4783,6 +4852,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DeletedCompanyObject": { "docs": "Response returned when an object is deleted", + "inline": undefined, "properties": { "deleted": { "docs": "Whether the company was deleted successfully or not.", @@ -4803,6 +4873,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "DeletedObject": { "docs": "Response returned when an object is deleted", + "inline": undefined, "properties": { "deleted": { "docs": "Whether the news item was deleted successfully or not.", @@ -4823,6 +4894,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "Email": { "docs": undefined, + "inline": true, "properties": { "email": { "docs": "The email you have defined for the contact who is being added as a participant.", @@ -4835,6 +4907,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "Error": { "docs": "The API will return an Error List for a failed request, which will contain one or more Error objects.", + "inline": undefined, "properties": { "errors": { "docs": "An array of one or more error objects", @@ -4861,6 +4934,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "ErrorErrorsItem": { "docs": undefined, + "inline": true, "properties": { "code": { "docs": "A string indicating the kind of error, used to further qualify the HTTP response code", @@ -4881,6 +4955,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "File": { "docs": "The value describing a file upload set for a custom attribute", + "inline": undefined, "properties": { "content_type": { "docs": "The type of file", @@ -4916,6 +4991,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "GroupContent": { "docs": "The Content of a Group.", + "inline": undefined, "properties": { "description": { "docs": "The description of the collection. Only available for collections.", @@ -4936,6 +5012,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "GroupTranslatedContent": { "docs": "The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.", + "inline": undefined, "properties": { "ar": { "docs": "The content of the group in Arabic", @@ -5096,6 +5173,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "LinkedObject": { "docs": "A linked conversation or ticket.", + "inline": undefined, "properties": { "category": { "docs": "Category of the Linked Ticket Object.", @@ -5116,6 +5194,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "LinkedObjectList": { "docs": "An object containing metadata about linked conversations and linked tickets. Up to 1000 can be returned.", + "inline": undefined, "properties": { "data": { "docs": "An array containing the linked conversations and linked tickets.", @@ -5150,6 +5229,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "MultipleFilterSearchRequest": { "docs": "Search using Intercoms Search APIs with more than one filter.", + "inline": undefined, "properties": { "operator": { "docs": "An operator to allow boolean inspection between multiple fields.", @@ -5177,6 +5257,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -5193,6 +5274,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "NewsItemRequest": { "docs": "A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.", + "inline": undefined, "properties": { "body": { "docs": "The news item body, which may contain HTML.", @@ -5243,6 +5325,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "NoteList": { "docs": "A paginated list of notes associated with a contact.", + "inline": undefined, "properties": { "data": { "docs": "An array of notes.", @@ -5266,6 +5349,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul }, "OpenConversationRequest": { "docs": "Payload of the request to open a conversation", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is performing the action.", @@ -5281,6 +5365,7 @@ A "cursor" or pointer is used to keep track of the current position in the resul Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows. ", + "inline": undefined, "properties": { "next": { "docs": "A link to the next page of results. A response that does not contain a next link does not have further data to fetch.", @@ -5311,6 +5396,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "PaginatedResponse": { "docs": "Paginated Response", + "inline": undefined, "properties": { "data": { "docs": "An array of Objects", @@ -5365,6 +5451,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "PartAttachment": { "docs": "The file attached to a part", + "inline": undefined, "properties": { "content_type": { "docs": "The content type of the attachment", @@ -5401,6 +5488,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "PhoneSwitch": { "docs": "Phone Switch Response", + "inline": undefined, "properties": { "phone": { "docs": "Phone number in E.164 format, that has received the SMS to continue the conversation in the Messenger.", @@ -5437,6 +5525,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "RedactConversationRequestConversationPart": { "docs": "Payload of the request to redact a conversation part", + "inline": true, "properties": { "conversation_id": { "docs": "The id of the conversation.", @@ -5453,6 +5542,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "RedactConversationRequestSource": { "docs": "Payload of the request to redact a conversation source", + "inline": true, "properties": { "conversation_id": { "docs": "The id of the conversation.", @@ -5469,6 +5559,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "Reference": { "docs": "reference to another object", + "inline": undefined, "properties": { "id": { "docs": "", @@ -5487,6 +5578,7 @@ Their responses are likely to contain a pages object that hosts pagination links "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -5501,6 +5593,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "SearchRequest": { "docs": "Search using Intercoms Search APIs.", + "inline": undefined, "properties": { "pagination": { "type": "optional", @@ -5515,6 +5608,7 @@ Their responses are likely to contain a pages object that hosts pagination links "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -5529,6 +5623,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "SegmentList": { "docs": "This will return a list of Segment Objects. The result may also have a pages object if the response is paginated.", + "inline": undefined, "properties": { "pages": { "docs": "A pagination object, which may be empty, indicating no further pages to fetch.", @@ -5549,6 +5644,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "Segments": { "docs": "A list of segments objects attached to a specific contact.", + "inline": undefined, "properties": { "data": { "docs": "Segment objects associated with the contact.", @@ -5565,6 +5661,7 @@ Their responses are likely to contain a pages object that hosts pagination links }, "SingleFilterSearchRequest": { "docs": "Search using Intercoms Search APIs with a single filter.", + "inline": undefined, "properties": { "field": { "docs": "The accepted field that you want to search on.", @@ -5617,6 +5714,7 @@ Their responses are likely to contain a pages object that hosts pagination links "docs": "The SLA Applied object contains the details for which SLA has been applied to this conversation. Important: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null. ", + "inline": undefined, "properties": { "sla_name": { "docs": "The name of the SLA as given by the teammate when it was created.", @@ -5655,6 +5753,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "SnoozeConversationRequest": { "docs": "Payload of the request to snooze a conversation", + "inline": undefined, "properties": { "admin_id": { "docs": "The id of the admin who is performing the action.", @@ -5671,6 +5770,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "SocialProfile": { "docs": "A Social Profile allows you to label your contacts, companies, and conversations and list them using that Social Profile.", + "inline": undefined, "properties": { "name": { "docs": "The name of the Social media profile", @@ -5697,6 +5797,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "StartingAfterPaging": { "docs": undefined, + "inline": undefined, "properties": { "per_page": { "docs": "The number of results to fetch per page.", @@ -5713,6 +5814,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "SubscriptionTypeList": { "docs": "A list of subscription type objects.", + "inline": undefined, "properties": { "data": { "docs": "A list of subscription type objects associated with the workspace .", @@ -5729,6 +5831,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TagCompanyRequest": { "docs": "You can tag a single company or a list of companies.", + "inline": undefined, "properties": { "companies": { "docs": "The id or company_id of the company can be passed as input parameters.", @@ -5745,6 +5848,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TagCompanyRequestCompaniesItem": { "docs": undefined, + "inline": true, "properties": { "company_id": { "docs": "The company id you have defined for the company.", @@ -5761,6 +5865,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TagMultipleUsersRequest": { "docs": "You can tag a list of users.", + "inline": undefined, "properties": { "name": { "docs": "The name of the tag, which will be created if not found.", @@ -5774,6 +5879,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TagMultipleUsersRequestUsersItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The Intercom defined id representing the user.", @@ -5786,6 +5892,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "Tags": { "docs": "A list of tags objects associated with a conversation", + "inline": undefined, "properties": { "tags": { "docs": "A list of tags objects associated with the conversation.", @@ -5802,6 +5909,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TeamList": { "docs": "This will return a list of team objects for the App.", + "inline": undefined, "properties": { "teams": { "docs": "A list of team objects", @@ -5818,6 +5926,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TeamPriorityLevel": { "docs": "Admin priority levels for teams", + "inline": undefined, "properties": { "primary_team_ids": { "docs": "The primary team ids for the team", @@ -5840,6 +5949,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -5855,6 +5965,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketList": { "docs": "Tickets are how you track requests from your users.", + "inline": undefined, "properties": { "pages": { "type": "optional", @@ -5878,6 +5989,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketPartAuthor": { "docs": "The author that wrote or triggered the part. Can be a bot, admin, team or user.", + "inline": undefined, "properties": { "email": { "docs": "The email of the author", @@ -5920,6 +6032,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketParts": { "docs": "A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts.", + "inline": undefined, "properties": { "ticket_parts": { "docs": "A list of Ticket Part objects for each ticket. There is a limit of 500 parts.", @@ -5940,6 +6053,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketReply": { "docs": "A Ticket Part representing a note, comment, or quick_reply on a ticket", + "inline": undefined, "properties": { "attachments": { "docs": "A list of attachments for the part.", @@ -6000,6 +6114,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -6012,6 +6127,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketTypeAttribute": { "docs": "Ticket type attribute, used to define each data field to be captured in a ticket.", + "inline": undefined, "properties": { "archived": { "docs": "Whether the ticket type attribute is archived or not.", @@ -6092,6 +6208,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketTypeAttributeList": { "docs": "A list of attributes associated with a given ticket type.", + "inline": undefined, "properties": { "ticket_type_attributes": { "docs": "A list of ticket type attributes associated with a given ticket type.", @@ -6108,6 +6225,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "TicketTypeList": { "docs": "A list of ticket types associated with a given workspace.", + "inline": undefined, "properties": { "ticket_types": { "docs": "A list of ticket_types associated with a given workspace.", @@ -6124,6 +6242,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "Translation": { "docs": "A translation object contains the localised details of a subscription type.", + "inline": undefined, "properties": { "description": { "docs": "The localised description of the subscription type.", @@ -6144,6 +6263,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "UntagCompanyRequest": { "docs": "You can tag a single company or a list of companies.", + "inline": undefined, "properties": { "companies": { "docs": "The id or company_id of the company can be passed as input parameters.", @@ -6160,6 +6280,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "UntagCompanyRequestCompaniesItem": { "docs": undefined, + "inline": true, "properties": { "company_id": { "docs": "The company id you have defined for the company.", @@ -6180,6 +6301,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a }, "UpdateArticleRequest": { "docs": "You can Update an Article", + "inline": undefined, "properties": { "author_id": { "docs": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", @@ -6231,6 +6353,7 @@ Important: if there are any canceled sla_events for the conversation - meaning a "docs": "The request payload for updating a ticket type. You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet](https://twemoji-cheatsheet.vercel.app/) ", + "inline": undefined, "properties": { "archived": { "docs": "The archived status of the ticket type.", @@ -6280,6 +6403,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( "UpdateVisitorRequestOne": "unknown", "Visitor": { "docs": "Visitors are useful for representing anonymous people that have not yet been identified. They usually represent website visitors. Visitors are not visible in Intercom platform. The Visitors resource provides methods to fetch, update, convert and delete.", + "inline": undefined, "properties": { "anonymous": { "docs": "Identifies if this visitor is anonymous.", @@ -6421,6 +6545,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorAvatar": { "docs": undefined, + "inline": true, "properties": { "image_url": { "docs": "This object represents the avatar associated with the visitor.", @@ -6444,6 +6569,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorCompanies": { "docs": undefined, + "inline": true, "properties": { "companies": "optional>", "type": { @@ -6457,6 +6583,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorLocationData": { "docs": undefined, + "inline": true, "properties": { "city_name": { "docs": "The city name of the visitor.", @@ -6498,6 +6625,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorSegments": { "docs": undefined, + "inline": true, "properties": { "segments": "optional>", "type": { @@ -6511,6 +6639,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorSocialProfiles": { "docs": undefined, + "inline": true, "properties": { "social_profiles": "optional>", "type": { @@ -6524,6 +6653,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorTags": { "docs": undefined, + "inline": true, "properties": { "tags": "optional>", "type": { @@ -6537,6 +6667,7 @@ You can copy the `icon` property for your ticket type from [Twemoji Cheatsheet]( }, "VisitorTagsTagsItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The id of the tag.", @@ -7951,6 +8082,7 @@ types: docs: The IP address of the admin. source: openapi: ../openapi.yml + inline: true ActivityLogActivityType: enum: - admin_assignment_limit_change @@ -8194,6 +8326,7 @@ types: format: uuid source: openapi: ../openapi.yml + inline: true AdminReplyTicketRequest: docs: Payload of the request to reply on behalf of an admin properties: @@ -8240,6 +8373,7 @@ types: format: uri source: openapi: ../openapi.yml + inline: true Admin: docs: Admins are the teammate accounts that have access to a workspace properties: @@ -8823,6 +8957,7 @@ types: participant. source: openapi: ../openapi.yml + inline: true ContactReplyIntercomUserIdRequest: docs: >- Payload of the request to reply on behalf of a contact using their @@ -9473,6 +9608,7 @@ types: docs: The identifier for the contact as given by Intercom. source: openapi: ../openapi.yml + inline: true CustomerRequestUserId: properties: user_id: @@ -9482,6 +9618,7 @@ types: a participant. source: openapi: ../openapi.yml + inline: true CustomerRequest: discriminated: false union: @@ -9618,6 +9755,7 @@ types: was in error. source: openapi: ../openapi.yml + inline: true Error: docs: >- The API will return an Error List for a failed request, which will contain @@ -9854,6 +9992,7 @@ types: type: list source: openapi: ../openapi.yml + inline: true MultipleFilterSearchRequest: docs: Search using Intercoms Search APIs with more than one filter. properties: @@ -10048,6 +10187,7 @@ types: docs: The id of the conversation_part. source: openapi: ../openapi.yml + inline: true RedactConversationRequestSource: docs: Payload of the request to redact a conversation source properties: @@ -10059,6 +10199,7 @@ types: docs: The id of the source. source: openapi: ../openapi.yml + inline: true RedactConversationRequest: discriminant: type base-properties: {} @@ -10096,6 +10237,7 @@ types: - type: MultipleFilterSearchRequest source: openapi: ../openapi.yml + inline: true SearchRequest: docs: Search using Intercoms Search APIs. properties: @@ -10254,6 +10396,7 @@ types: docs: The company id you have defined for the company. source: openapi: ../openapi.yml + inline: true TagCompanyRequest: docs: You can tag a single company or a list of companies. properties: @@ -10283,6 +10426,7 @@ types: docs: The Intercom defined id representing the user. source: openapi: ../openapi.yml + inline: true TagMultipleUsersRequest: docs: You can tag a list of users. properties: @@ -10577,6 +10721,7 @@ types: docs: Always set to true source: openapi: ../openapi.yml + inline: true UntagCompanyRequest: docs: You can tag a single company or a list of companies. properties: @@ -10695,6 +10840,7 @@ types: format: uri source: openapi: ../openapi.yml + inline: true VisitorCompanies: properties: type: @@ -10703,6 +10849,7 @@ types: companies: optional> source: openapi: ../openapi.yml + inline: true VisitorLocationData: properties: type: @@ -10732,6 +10879,7 @@ types: docs: The timezone of the visitor. source: openapi: ../openapi.yml + inline: true VisitorSocialProfiles: properties: type: @@ -10740,6 +10888,7 @@ types: social_profiles: optional> source: openapi: ../openapi.yml + inline: true VisitorTagsTagsItem: properties: type: @@ -10753,6 +10902,7 @@ types: docs: The name of the tag. source: openapi: ../openapi.yml + inline: true VisitorTags: properties: type: @@ -10761,6 +10911,7 @@ types: tags: optional> source: openapi: ../openapi.yml + inline: true VisitorSegments: properties: type: @@ -10769,6 +10920,7 @@ types: segments: optional> source: openapi: ../openapi.yml + inline: true Visitor: docs: >- Visitors are useful for representing anonymous people that have not yet @@ -11300,6 +11452,7 @@ You can view the currently authorised admin along with the embedded app object ( "types": { "Admin": { "docs": "Admins are teammate accounts that have access to a workspace.", + "inline": undefined, "properties": { "avatar": { "docs": "Image for the associated team or teammate", @@ -11712,6 +11865,7 @@ types: "types": { "AiAgent": { "docs": "Data related to AI Agent involvement in the conversation.", + "inline": undefined, "properties": { "content_sources": { "type": "optional", @@ -11817,6 +11971,7 @@ imports: "types": { "ContentSource": { "docs": "The content source used by AI Agent in the conversation.", + "inline": undefined, "properties": { "content_type": { "docs": "The type of the content source.", @@ -14452,6 +14607,7 @@ imports: "extends": [ "Articles", ], + "inline": undefined, "properties": { "statistics": { "type": "optional", @@ -14474,6 +14630,7 @@ imports: }, "ArticleSearchHighlights": { "docs": "The highlighted results of an Article search. In the examples provided my search query is always "my query".", + "inline": undefined, "properties": { "article_id": { "docs": "The ID of the corresponding article.", @@ -14494,6 +14651,7 @@ imports: }, "ArticleSearchHighlightsHighlightedSummaryItemItem": { "docs": "An instance of highlighted summary text.", + "inline": true, "properties": { "text": { "docs": "The text of the title.", @@ -14520,6 +14678,7 @@ imports: }, "ArticleSearchHighlightsHighlightedTitleItem": { "docs": "A highlighted article title.", + "inline": true, "properties": { "text": { "docs": "The text of the title.", @@ -14546,6 +14705,7 @@ imports: }, "ArticleSearchResponse": { "docs": "The results of an Article search", + "inline": undefined, "properties": { "data": { "docs": "An object containing the results of the search.", @@ -14569,6 +14729,7 @@ imports: }, "ArticleSearchResponseData": { "docs": "An object containing the results of the search.", + "inline": true, "properties": { "articles": { "docs": "An array of Article objects", @@ -14585,6 +14746,7 @@ imports: }, "Articles": { "docs": "The data returned about your articles when you list them.", + "inline": undefined, "properties": { "author_id": { "docs": "The id of the author of the article. For multilingual articles, this will be the id of the author of the default language's content. Must be a teammate on the help center's workspace.", @@ -17046,6 +17208,7 @@ types: docs: The text of the title. source: openapi: ../openapi.yml + inline: true ArticleSearchHighlightsHighlightedSummaryItemItemType: enum: - highlight @@ -17064,6 +17227,7 @@ types: docs: The text of the title. source: openapi: ../openapi.yml + inline: true ArticleSearchHighlights: docs: >- The highlighted results of an Article search. In the examples provided my @@ -17092,6 +17256,7 @@ types: docs: A corresponding array of highlighted Article content source: openapi: ../openapi.yml + inline: true ArticleSearchResponse: docs: The results of an Article search properties: @@ -18221,6 +18386,7 @@ You can fetch all companies and filter by `segment_id` or `tag_id` as a query pa "types": { "Company": { "docs": "Companies allow you to represent organizations using your product. Each company will have its own description and be associated with contacts. You can fetch, create, update and list companies.", + "inline": undefined, "properties": { "app_id": { "docs": "The Intercom defined code of the workspace the company is associated to.", @@ -18304,6 +18470,7 @@ You can fetch all companies and filter by `segment_id` or `tag_id` as a query pa }, "CompanyPlan": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The id of the plan", @@ -18324,6 +18491,7 @@ You can fetch all companies and filter by `segment_id` or `tag_id` as a query pa }, "CompanySegments": { "docs": "The list of segments associated with the company", + "inline": true, "properties": { "segments": "optional>", "type": { @@ -18337,6 +18505,7 @@ You can fetch all companies and filter by `segment_id` or `tag_id` as a query pa }, "CompanyTags": { "docs": "The list of tags associated with the company", + "inline": true, "properties": { "tags": "optional>", "type": { @@ -19198,6 +19367,7 @@ types: docs: The name of the plan source: openapi: ../openapi.yml + inline: true CompanyTags: docs: The list of tags associated with the company properties: @@ -19207,6 +19377,7 @@ types: tags: optional> source: openapi: ../openapi.yml + inline: true CompanySegments: docs: The list of segments associated with the company properties: @@ -19216,6 +19387,7 @@ types: segments: optional> source: openapi: ../openapi.yml + inline: true Company: docs: >- Companies allow you to represent organizations using your product. Each @@ -20587,6 +20759,7 @@ The data property will show a combined list of: "types": { "Contact": { "docs": "Contact are the objects that represent your leads and users in Intercom.", + "inline": undefined, "properties": { "android_app_name": { "docs": "The name of the Android app which the contact is using.", @@ -20773,6 +20946,7 @@ The data property will show a combined list of: }, "ContactAvatar": { "docs": undefined, + "inline": true, "properties": { "image_url": { "docs": "An image URL containing the avatar of a contact.", @@ -21931,6 +22105,7 @@ types: format: uri source: openapi: ../openapi.yml + inline: true Contact: docs: Contact are the objects that represent your leads and users in Intercom. properties: @@ -27189,6 +27364,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -27206,6 +27382,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, }, "AttachContactToConversationRequestCustomerIntercomUserId": { "docs": undefined, + "inline": true, "properties": { "customer": { "type": "optional", @@ -27221,6 +27398,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, }, "AttachContactToConversationRequestCustomerUserId": { "docs": undefined, + "inline": true, "properties": { "customer": { "type": "optional", @@ -27236,6 +27414,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, }, "Conversation": { "docs": "Conversations are how you can communicate with users in Intercom. They are created when a contact replies to an outbound message, or when one admin directly sends a message to a single contact.", + "inline": undefined, "properties": { "admin_assignee_id": { "docs": "The id of the admin assigned to the conversation. If it's not assigned to an admin it will return null.", @@ -27357,6 +27536,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, }, "CreateConversationRequestFrom": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The identifier for the contact which is given by Intercom.", @@ -27390,6 +27570,7 @@ If you want to reply to a coveration or take an action such as assign, unassign, }, "Email": { "docs": undefined, + "inline": true, "properties": { "customer": { "type": "optional", @@ -31597,6 +31778,7 @@ types: maxLength: 24 source: openapi: ../openapi.yml + inline: true ManageConversationRequestBody: discriminant: message_type base-properties: {} @@ -31620,6 +31802,7 @@ types: type: optional source: openapi: ../openapi.yml + inline: true AttachContactToConversationRequestCustomerUserId: properties: user_id: @@ -31631,6 +31814,7 @@ types: type: optional source: openapi: ../openapi.yml + inline: true Email: properties: email: @@ -31642,6 +31826,7 @@ types: type: optional source: openapi: ../openapi.yml + inline: true AttachContactToConversationRequestCustomer: discriminated: false union: @@ -31650,6 +31835,7 @@ types: - type: Email source: openapi: ../openapi.yml + inline: true ConversationState: enum: - open @@ -31757,6 +31943,7 @@ types: "types": { "CustomObjectInstance": { "docs": "A Custom Object Instance represents an instance of a custom object type. This allows you to create and set custom attributes to store data about your customers that is not already captured by Intercom. The parent object includes recommended default attributes and you can add your own custom attributes.", + "inline": undefined, "properties": { "custom_attributes": { "docs": "The custom attributes you have set on the custom object instance.", @@ -32731,6 +32918,7 @@ You can update a data attribute. }, "DataAttribute": { "docs": "Data Attributes are metadata used to describe your contact, company and conversation models. These include standard and custom attributes. By using the data attributes endpoint, you can get the global list of attributes for your workspace, as well as create and archive custom attributes.", + "inline": undefined, "properties": { "admin_id": { "docs": "Teammate who created the attribute. Only applicable to CDAs", @@ -33865,6 +34053,7 @@ You can optionally define the result page size as well with the `per_page` param "types": { "CreateDataEventSummariesRequestEventSummaries": { "docs": "A list of event summaries for the user. Each event summary should contain the event name, the time the event occurred, and the number of times the event occurred. The event name should be a past tense 'verb-noun' combination, to improve readability, for example `updated-plan`.", + "inline": true, "properties": { "count": { "docs": "The number of times the event occurred.", @@ -33891,6 +34080,7 @@ You can optionally define the result page size as well with the `per_page` param "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -33908,6 +34098,7 @@ You can optionally define the result page size as well with the `per_page` param }, "LisDataEventsRequestFilterEmail": { "docs": undefined, + "inline": true, "properties": { "email": "string", }, @@ -33917,6 +34108,7 @@ You can optionally define the result page size as well with the `per_page` param }, "LisDataEventsRequestFilterIntercomUserId": { "docs": undefined, + "inline": true, "properties": { "intercom_user_id": "string", }, @@ -33926,6 +34118,7 @@ You can optionally define the result page size as well with the `per_page` param }, "LisDataEventsRequestFilterUserId": { "docs": undefined, + "inline": true, "properties": { "user_id": "string", }, @@ -33941,16 +34134,19 @@ You can optionally define the result page size as well with the `per_page` param user_id: string source: openapi: ../openapi.yml + inline: true LisDataEventsRequestFilterIntercomUserId: properties: intercom_user_id: string source: openapi: ../openapi.yml + inline: true LisDataEventsRequestFilterEmail: properties: email: string source: openapi: ../openapi.yml + inline: true LisDataEventsRequestFilter: discriminated: false union: @@ -33983,6 +34179,7 @@ You can optionally define the result page size as well with the `per_page` param docs: The last time the event was sent source: openapi: ../openapi.yml + inline: true imports: root: __package__.yml service: @@ -34420,6 +34617,7 @@ Your exported message data will be streamed continuously back down to you in a g "types": { "DataExport": { "docs": "The data export api is used to view all message sent & viewed in a given timeframe.", + "inline": undefined, "properties": { "download_expires_at": { "docs": "The time after which you will not be able to access the data.", @@ -36069,6 +36267,7 @@ Collections will be returned in descending order on the `updated_at` attribute. "types": { "Collection": { "docs": "Collections are top level containers for Articles within the Help Center.", + "inline": undefined, "properties": { "created_at": { "docs": "The time when the article was created (seconds). For multilingual articles, this will be the timestamp of creation of the default language's content.", @@ -36128,6 +36327,7 @@ Collections will be returned in descending order on the `updated_at` attribute. }, "HelpCenter": { "docs": "Help Centers contain collections", + "inline": undefined, "properties": { "created_at": { "docs": "The time when the Help Center was created.", @@ -36164,6 +36364,7 @@ Collections will be returned in descending order on the `updated_at` attribute. }, "HelpCenterList": { "docs": "A list of Help Centers belonging to the App", + "inline": undefined, "properties": { "data": { "docs": "An array of Help Center objects", @@ -37599,6 +37800,7 @@ This will return the Message model that has been created. "types": { "Message": { "docs": "Message are how you reach out to contacts in Intercom. They are created when an admin sends an outbound message to a contact.", + "inline": undefined, "properties": { "body": { "docs": "The message body, which may contain HTML.", @@ -38378,6 +38580,7 @@ types: "types": { "NewsItem": { "docs": "A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.", + "inline": undefined, "properties": { "body": { "docs": "The news item body, which may contain HTML.", @@ -38457,6 +38660,7 @@ types: Newsfeeds currently cannot be edited through the API, please refer to [this article](https://www.intercom.com/help/en/articles/6362267-getting-started-with-news) to set up your newsfeeds in Intercom. ", + "inline": undefined, "properties": { "created_at": { "docs": "Timestamp for when the newsfeed was created.", @@ -38481,6 +38685,7 @@ Newsfeeds currently cannot be edited through the API, please refer to [this arti }, "NewsfeedAssignment": { "docs": "Assigns a news item to a newsfeed.", + "inline": undefined, "properties": { "newsfeed_id": { "docs": "The unique identifier for the newsfeed which is given by Intercom. Publish dates cannot be in the future, to schedule news items use the dedicated feature in app (see this article).", @@ -39357,6 +39562,7 @@ types: "types": { "Note": { "docs": "Notes allow you to annotate and comment on your contacts.", + "inline": undefined, "properties": { "author": { "docs": "Optional. Represents the Admin that created the note.", @@ -39389,6 +39595,7 @@ types: }, "NoteContact": { "docs": "Represents the contact that the note was created about.", + "inline": true, "properties": { "id": { "docs": "The id of the contact.", @@ -39689,6 +39896,7 @@ types: docs: The id of the contact. source: openapi: ../openapi.yml + inline: true Note: docs: Notes allow you to annotate and comment on your contacts. properties: @@ -39838,6 +40046,7 @@ types: "types": { "Segment": { "docs": "A segment is a group of your contacts defined by the rules that you set.", + "inline": undefined, "properties": { "count": { "docs": "The number of items in the user segment. It's returned when `include_count=true` is included in the request.", @@ -40288,6 +40497,7 @@ This will return a subscription type model for the subscription type that was ad "types": { "SubscriptionType": { "docs": "A subscription type lets customers easily opt out of non-essential communications without missing what's important to them.", + "inline": undefined, "properties": { "consent_type": { "docs": "Describes the type of consent.", @@ -41622,6 +41832,7 @@ This will return a tag object. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -41642,6 +41853,7 @@ This will return a tag object. }, "Tag": { "docs": "A tag allows you to label your contacts, companies, and conversations and list them using that tag.", + "inline": undefined, "properties": { "applied_at": { "docs": "The time when the tag was applied to the object", @@ -42372,6 +42584,7 @@ types: "types": { "Team": { "docs": "Teams are groups of admins in Intercom.", + "inline": undefined, "properties": { "admin_ids": { "docs": "The list of admin IDs that are a part of the team.", @@ -45035,6 +45248,7 @@ The table below shows the operators you can use to define how you want to search "types": { "Contacts": { "docs": "The list of contacts affected by a ticket.", + "inline": undefined, "properties": { "contacts": { "docs": "The list of contacts affected by this ticket.", @@ -45053,6 +45267,7 @@ The table below shows the operators you can use to define how you want to search "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -45070,6 +45285,7 @@ The table below shows the operators you can use to define how you want to search }, "CreateTicketRequestContactsItemExternalId": { "docs": undefined, + "inline": true, "properties": { "external_id": { "docs": "The external_id you have defined for the contact who is being added as a participant.", @@ -45082,6 +45298,7 @@ The table below shows the operators you can use to define how you want to search }, "Email": { "docs": undefined, + "inline": true, "properties": { "email": { "docs": "The email you have defined for the contact who is being added as a participant. If a contact with this email does not exist, one will be created.", @@ -45094,6 +45311,7 @@ The table below shows the operators you can use to define how you want to search }, "ID": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The identifier for the contact as given by Intercom.", @@ -45108,6 +45326,7 @@ The table below shows the operators you can use to define how you want to search "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -45122,6 +45341,7 @@ The table below shows the operators you can use to define how you want to search }, "Ticket": { "docs": "Tickets are how you track requests from your users.", + "inline": undefined, "properties": { "admin_assignee_id": { "docs": "The id representing the admin assigned to the ticket.", @@ -45215,6 +45435,7 @@ The table below shows the operators you can use to define how you want to search }, "TicketPart": { "docs": "A Ticket Part represents a message in the ticket.", + "inline": undefined, "properties": { "assigned_to": { "docs": "The id of the admin that was assigned the ticket by this ticket_part (null if there has been no change in assignment.)", @@ -45310,6 +45531,7 @@ The table below shows the operators you can use to define how you want to search }, "TicketType": { "docs": "A ticket type, used to define the data fields to be captured in a ticket.", + "inline": undefined, "properties": { "archived": { "docs": "Whether the ticket type is archived or not.", @@ -45375,6 +45597,7 @@ The table below shows the operators you can use to define how you want to search }, "UpdateTicketRequestAssignment": { "docs": undefined, + "inline": true, "properties": { "admin_id": { "docs": "The ID of the admin performing the action.", @@ -45419,6 +45642,7 @@ types: docs: The identifier for the contact as given by Intercom. source: openapi: ../openapi.yml + inline: true CreateTicketRequestContactsItemExternalId: properties: external_id: @@ -45428,6 +45652,7 @@ types: a participant. source: openapi: ../openapi.yml + inline: true Email: properties: email: @@ -45438,6 +45663,7 @@ types: created. source: openapi: ../openapi.yml + inline: true CreateTicketRequestContactsItem: discriminated: false union: @@ -45446,6 +45672,7 @@ types: - type: Email source: openapi: ../openapi.yml + inline: true UpdateTicketRequestState: enum: - in_progress @@ -45466,6 +45693,7 @@ types: 0 to unassign it. source: openapi: ../openapi.yml + inline: true TicketCategory: enum: - Customer diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/permit.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/permit.json index b29b1af9e1c..61a8144055b 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/permit.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/permit.json @@ -22,6 +22,7 @@ "types": { "ActionBlockEditable": { "docs": undefined, + "inline": undefined, "properties": { "attributes": { "type": "optional>", @@ -41,6 +42,7 @@ }, "ActionBlockRead": { "docs": undefined, + "inline": undefined, "properties": { "attributes": { "type": "optional>", @@ -74,6 +76,7 @@ }, "AddRolePermissions": { "docs": undefined, + "inline": undefined, "properties": { "permissions": { "docs": "List of permissions to assign to the role. If a permission is already granted to the role it is skipped. Each permission can be either a resource action id, or `{resource_key}:{action_key}`, i.e: the "permission name".", @@ -86,6 +89,7 @@ }, "AttributeBlockEditable": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "optional description string explaining what data this attribute will store", @@ -102,6 +106,7 @@ }, "AttributeBlockRead": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "optional description string explaining what data this attribute will store", @@ -146,6 +151,7 @@ }, "BulkRoleAssignmentReport": { "docs": undefined, + "inline": undefined, "properties": { "assignments_created": { "default": 0, @@ -158,6 +164,7 @@ }, "BulkRoleUnAssignmentReport": { "docs": undefined, + "inline": undefined, "properties": { "assignments_removed": { "default": 0, @@ -170,6 +177,7 @@ }, "ConditionSetRead": { "docs": undefined, + "inline": undefined, "properties": { "autogenerated": { "default": false, @@ -272,6 +280,7 @@ }, "ConditionSetRuleRead": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Date and time when the condition set rule was created (ISO_8601 format).", @@ -354,6 +363,7 @@ }, "EnvironmentCopyScope": { "docs": undefined, + "inline": undefined, "properties": { "resource_sets": { "docs": "Resource sets to copy", @@ -378,6 +388,7 @@ }, "EnvironmentCopyScopeFilters": { "docs": undefined, + "inline": undefined, "properties": { "exclude": { "docs": "Object to exclude (use * as wildcard)", @@ -394,6 +405,7 @@ }, "EnvironmentCopyTarget": { "docs": undefined, + "inline": undefined, "properties": { "existing": { "docs": "Identifier of an existing environment to copy into", @@ -410,6 +422,7 @@ }, "EnvironmentCreate": { "docs": undefined, + "inline": undefined, "properties": { "custom_branch_name": { "docs": "when using gitops feature, an optional branch name for the environment", @@ -448,6 +461,7 @@ }, "EnvironmentRead": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Date and time when the environment was created (ISO_8601 format).", @@ -518,6 +532,7 @@ }, "EnvironmentStats": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Date and time when the environment was created (ISO_8601 format).", @@ -594,6 +609,7 @@ }, "HTTPValidationError": { "docs": undefined, + "inline": undefined, "properties": { "detail": { "type": "optional>", @@ -605,6 +621,7 @@ }, "IdentityRead": { "docs": undefined, + "inline": undefined, "properties": { "auth0_info": { "docs": "Raw user info json coming from our identity provider and matching a specific account identity", @@ -643,6 +660,7 @@ }, "InviteRead": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Date and time when the invite was created (ISO_8601 format).", @@ -729,6 +747,7 @@ }, "JwksObj": { "docs": undefined, + "inline": undefined, "properties": { "keys": { "docs": "The keys to match against the request headers", @@ -780,6 +799,7 @@ }, "OrgMemberReadWithGrants": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Date and time when the account member was created (ISO_8601 format).", @@ -871,6 +891,7 @@ }, "OrganizationRead": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Date and time when the organization was created (ISO_8601 format).", @@ -913,6 +934,7 @@ }, "OrganizationReadWithAPIKey": { "docs": undefined, + "inline": undefined, "properties": { "api_key_id": { "type": "optional", @@ -967,6 +989,7 @@ }, "PDPConfigRead": { "docs": undefined, + "inline": undefined, "properties": { "client_secret": "string", "environment_id": { @@ -1018,6 +1041,7 @@ }, "PaginatedResultConditionSetRead": { "docs": undefined, + "inline": undefined, "properties": { "data": { "docs": "List of Condition Sets", @@ -1051,6 +1075,7 @@ }, "PaginatedResultResourceRead": { "docs": undefined, + "inline": undefined, "properties": { "data": { "docs": "List of Resources", @@ -1084,6 +1109,7 @@ }, "PaginatedResultResourceRoleRead": { "docs": undefined, + "inline": undefined, "properties": { "data": { "docs": "List of Resource Roles", @@ -1117,6 +1143,7 @@ }, "PaginatedResultRoleRead": { "docs": undefined, + "inline": undefined, "properties": { "data": { "docs": "List of Roles", @@ -1150,6 +1177,7 @@ }, "PaginatedResultTenantRead": { "docs": undefined, + "inline": undefined, "properties": { "data": { "docs": "List of Tenants", @@ -1183,6 +1211,7 @@ }, "PaginatedResultUserRead": { "docs": undefined, + "inline": undefined, "properties": { "data": { "docs": "List of Users", @@ -1216,6 +1245,7 @@ }, "Permission": { "docs": undefined, + "inline": undefined, "properties": { "access_level": { "type": "MemberAccessLevel", @@ -1275,6 +1305,7 @@ }, "ProjectRead": { "docs": undefined, + "inline": undefined, "properties": { "active_policy_repo_id": { "docs": "the id of the policy repo to use for this project", @@ -1352,6 +1383,7 @@ The actions represents the ways you can interact with a protected resource.", }, "RemoveRolePermissions": { "docs": undefined, + "inline": undefined, "properties": { "permissions": { "docs": "List of permissions to remove from the role. If a permission is not found it is skipped. Each permission can be either a resource action id, or `{resource_key}:{action_key}`,i.e: the "permission name".", @@ -1364,6 +1396,7 @@ The actions represents the ways you can interact with a protected resource.", }, "ResourceActionGroupRead": { "docs": undefined, + "inline": undefined, "properties": { "actions": { "type": "optional>", @@ -1455,6 +1488,7 @@ The actions represents the ways you can interact with a protected resource.", }, "ResourceActionRead": { "docs": undefined, + "inline": undefined, "properties": { "attributes": { "docs": "optional dictionary of key-value pairs that can be used to store arbitrary metadata about this action. This metadata can be used to filter actions using query parameters with attr_ prefix", @@ -1541,6 +1575,7 @@ The actions represents the ways you can interact with a protected resource.", }, "ResourceAttributeCreate": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "An optional longer description of what this attribute respresents in your system", @@ -1567,6 +1602,7 @@ The actions represents the ways you can interact with a protected resource.", }, "ResourceAttributeRead": { "docs": undefined, + "inline": undefined, "properties": { "built_in": { "docs": "Whether the attribute is built-in, and managed by the Permit system.", @@ -1653,6 +1689,7 @@ The actions represents the ways you can interact with a protected resource.", }, "ResourceAttributeUpdate": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "An optional longer description of what this attribute respresents in your system", @@ -1669,6 +1706,7 @@ The actions represents the ways you can interact with a protected resource.", }, "ResourceInstanceRead": { "docs": undefined, + "inline": undefined, "properties": { "attributes": { "docs": "Arbitraty resource attributes that will be used to enforce attribute-based access control policies.", @@ -1761,6 +1799,7 @@ The actions represents the ways you can interact with a protected resource.", }, "ResourceRead": { "docs": undefined, + "inline": undefined, "properties": { "action_groups": { "type": "optional>>", @@ -1847,6 +1886,7 @@ The actions represents the ways you can interact with a protected resource.", }, "ResourceRoleList": { "docs": undefined, + "inline": undefined, "properties": { "roles": { "display-name": "Roles", @@ -1859,6 +1899,7 @@ The actions represents the ways you can interact with a protected resource.", }, "ResourceRoleRead": { "docs": undefined, + "inline": undefined, "properties": { "attributes": { "docs": "optional dictionary of key-value pairs that can be used to store arbitrary metadata about this role. This metadata can be used to filter role using query parameters with attr_ prefix, currently supports only 'equals' operator", @@ -1949,6 +1990,7 @@ The actions represents the ways you can interact with a protected resource.", }, "RoleAssignmentCreate": { "docs": undefined, + "inline": undefined, "properties": { "role": { "docs": "the role that will be assigned (accepts either the role id or the role key)", @@ -1969,6 +2011,7 @@ The actions represents the ways you can interact with a protected resource.", }, "RoleAssignmentRead": { "docs": undefined, + "inline": undefined, "properties": { "created_at": { "docs": "Date and time when the role assignment was created (ISO_8601 format).", @@ -2063,6 +2106,7 @@ The actions represents the ways you can interact with a protected resource.", }, "RoleAssignmentRemove": { "docs": undefined, + "inline": undefined, "properties": { "role": { "docs": "the role that will be unassigned (accepts either the role id or the role key)", @@ -2083,6 +2127,7 @@ The actions represents the ways you can interact with a protected resource.", }, "RoleBlock": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "optional description string explaining what this role represents, or what permissions are granted to it.", @@ -2099,6 +2144,7 @@ The actions represents the ways you can interact with a protected resource.", }, "RoleList": { "docs": undefined, + "inline": undefined, "properties": { "roles": { "display-name": "Roles", @@ -2111,6 +2157,7 @@ The actions represents the ways you can interact with a protected resource.", }, "RoleRead": { "docs": undefined, + "inline": undefined, "properties": { "attributes": { "docs": "optional dictionary of key-value pairs that can be used to store arbitrary metadata about this role. This metadata can be used to filter role using query parameters with attr_ prefix, currently supports only 'equals' operator", @@ -2193,6 +2240,7 @@ The actions represents the ways you can interact with a protected resource.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -2209,6 +2257,7 @@ The actions represents the ways you can interact with a protected resource.", }, "Statistics": { "docs": undefined, + "inline": undefined, "properties": { "has_decision_logs": "boolean", "members": { @@ -2271,6 +2320,7 @@ The actions represents the ways you can interact with a protected resource.", }, "TenantCreate": { "docs": undefined, + "inline": undefined, "properties": { "attributes": { "docs": "Arbitraty tenant attributes that will be used to enforce attribute-based access control policies.", @@ -2301,6 +2351,7 @@ The actions represents the ways you can interact with a protected resource.", }, "TenantCreateBulkOperationResult": { "docs": undefined, + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.json", @@ -2308,6 +2359,7 @@ The actions represents the ways you can interact with a protected resource.", }, "TenantDeleteBulkOperationResult": { "docs": undefined, + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.json", @@ -2315,6 +2367,7 @@ The actions represents the ways you can interact with a protected resource.", }, "TenantRead": { "docs": undefined, + "inline": undefined, "properties": { "attributes": { "docs": "Arbitraty tenant attributes that will be used to enforce attribute-based access control policies.", @@ -2391,6 +2444,7 @@ The actions represents the ways you can interact with a protected resource.", }, "UserCreate": { "docs": undefined, + "inline": undefined, "properties": { "attributes": { "docs": "Arbitrary user attributes that will be used to enforce attribute-based access control policies.", @@ -2431,6 +2485,7 @@ The actions represents the ways you can interact with a protected resource.", }, "UserCreateBulkOperationResult": { "docs": undefined, + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.json", @@ -2438,6 +2493,7 @@ The actions represents the ways you can interact with a protected resource.", }, "UserDeleteBulkOperationResult": { "docs": undefined, + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.json", @@ -2445,6 +2501,7 @@ The actions represents the ways you can interact with a protected resource.", }, "UserInTenant": { "docs": undefined, + "inline": undefined, "properties": { "roles": { "docs": "List of roles assigned to the user in that tenant", @@ -2465,6 +2522,7 @@ The actions represents the ways you can interact with a protected resource.", }, "UserRead": { "docs": undefined, + "inline": undefined, "properties": { "associated_tenants": { "type": "optional>", @@ -2546,6 +2604,7 @@ The actions represents the ways you can interact with a protected resource.", }, "UserReplaceBulkOperationResult": { "docs": undefined, + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.json", @@ -2553,6 +2612,7 @@ The actions represents the ways you can interact with a protected resource.", }, "UserRole": { "docs": undefined, + "inline": undefined, "properties": { "role": { "docs": "the role that is assigned", @@ -2579,6 +2639,7 @@ The actions represents the ways you can interact with a protected resource.", }, "ValidationError": { "docs": undefined, + "inline": undefined, "properties": { "loc": { "type": "list", @@ -2594,6 +2655,7 @@ The actions represents the ways you can interact with a protected resource.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -3853,6 +3915,7 @@ types: - type: PaginatedResultRoleRead source: openapi: ../openapi.json + inline: true ResourceRoleList: properties: roles: @@ -4345,6 +4408,7 @@ types: - integer source: openapi: ../openapi.json + inline: true ValidationError: properties: loc: @@ -6455,6 +6519,7 @@ Fields that will be provided will be completely overwritten.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -14526,6 +14591,7 @@ Fields that will be provided will be completely overwritten.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -16495,6 +16561,7 @@ Fields that will be provided will be completely overwritten.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -17658,6 +17725,7 @@ Fields that will be provided will be completely overwritten.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/query-params.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/query-params.json index 8106b4ca053..7805574f7b8 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/query-params.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/query-params.json @@ -54,6 +54,7 @@ "types": { "SearchRequestFilter": { "docs": undefined, + "inline": undefined, "properties": { "age": "optional", "location": "optional", @@ -65,6 +66,7 @@ }, "SearchRequestFilterLocation": { "docs": undefined, + "inline": true, "properties": { "city": "optional", "coordinates": "optional", @@ -76,6 +78,7 @@ }, "SearchRequestFilterLocationCoordinates": { "docs": undefined, + "inline": true, "properties": { "latitude": "optional", "longitude": "optional", @@ -95,6 +98,7 @@ }, "SearchResponse": { "docs": undefined, + "inline": undefined, "properties": { "results": "optional>", }, @@ -111,6 +115,7 @@ longitude: optional source: openapi: ../openapi.yml + inline: true SearchRequestFilterLocation: properties: city: optional @@ -118,6 +123,7 @@ coordinates: optional source: openapi: ../openapi.yml + inline: true SearchRequestFilter: properties: name: optional diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/readonly.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/readonly.json index f674df642c1..82e436f7c5a 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/readonly.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/readonly.json @@ -112,6 +112,7 @@ "types": { "UserRead": { "docs": undefined, + "inline": undefined, "properties": { "createdAt": "optional", "email": "optional", @@ -126,6 +127,7 @@ }, "UserSettingsRead": { "docs": undefined, + "inline": undefined, "properties": { "lastModified": "optional", "notifications": "optional", @@ -147,6 +149,7 @@ }, "UserStatsRead": { "docs": undefined, + "inline": undefined, "properties": { "accountStatus": "optional", "lastLoginTime": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/request-response-description.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/request-response-description.json index 42a5c8e8d06..6026fd7fecf 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/request-response-description.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/request-response-description.json @@ -42,6 +42,7 @@ "types": { "Schema1": { "docs": "Schema 1 description", + "inline": undefined, "properties": { "id": "optional", "name": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/rightbrain.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/rightbrain.json index 5ea4a3e78fc..3b35a54d507 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/rightbrain.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/rightbrain.json @@ -131,6 +131,7 @@ "types": { "AsyncJobResult": { "docs": undefined, + "inline": undefined, "properties": { "status": "string", "task_id": { @@ -167,6 +168,7 @@ }, "BodyFetchOrgOrgIdProjectProjectIdDatasourceBoxConnectionIdFetchPost": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "list", @@ -178,6 +180,7 @@ }, "BodyFetchOrgOrgIdProjectProjectIdDatasourceConfluenceConnectionIdFetchPost": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "list", @@ -189,6 +192,7 @@ }, "BodyFetchOrgOrgIdProjectProjectIdDatasourceDropboxConnectionIdFetchPost": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "list", @@ -200,6 +204,7 @@ }, "BodyFetchOrgOrgIdProjectProjectIdDatasourceGdriveConnectionIdFetchPost": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "list", @@ -211,6 +216,7 @@ }, "BodyFetchOrgOrgIdProjectProjectIdDatasourceNotionConnectionIdFetchPost": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "list", @@ -222,6 +228,7 @@ }, "BodyFetchOrgOrgIdProjectProjectIdDatasourceOnedriveConnectionIdFetchPost": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "list", @@ -233,6 +240,7 @@ }, "BodyFetchOrgOrgIdProjectProjectIdDatasourceSharepointConnectionIdFetchPost": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "list", @@ -244,6 +252,7 @@ }, "Chat": { "docs": undefined, + "inline": undefined, "properties": { "collection_id": { "type": "string", @@ -298,6 +307,7 @@ }, "ChatConfig": { "docs": undefined, + "inline": undefined, "properties": { "chat_guardrails": { "docs": "Conversational Guardrails can be defined to run against Chat `input` (i.e. the users query) or on Chat `output` (i.e. the LLM output)", @@ -337,6 +347,7 @@ }, "ChatDocument": { "docs": undefined, + "inline": undefined, "properties": { "chunks": "integer", "connection_id": { @@ -386,6 +397,7 @@ }, "ChatDocumentEmbeddingInstance": { "docs": undefined, + "inline": undefined, "properties": { "chat_document_id": { "type": "string", @@ -416,6 +428,7 @@ }, "ChatDocumentEmbeddingRecord": { "docs": undefined, + "inline": undefined, "properties": { "document": "string", "id": { @@ -434,6 +447,7 @@ }, "ChatDocumentQueryResult": { "docs": undefined, + "inline": undefined, "properties": { "chat_document_id": { "type": "string", @@ -469,6 +483,7 @@ }, "ChatGuardrail": { "docs": undefined, + "inline": undefined, "properties": { "description": "string", "id": { @@ -485,6 +500,7 @@ }, "ChatModel": { "docs": undefined, + "inline": undefined, "properties": { "alias": { "docs": "Human readable name for the LLM.", @@ -514,6 +530,7 @@ }, "Collection": { "docs": undefined, + "inline": undefined, "properties": { "created": { "type": "datetime", @@ -562,6 +579,7 @@ }, "CollectionEmbeddingUpdate": { "docs": undefined, + "inline": undefined, "properties": { "embedding_instance_ids": { "type": "list", @@ -573,6 +591,7 @@ }, "CollectionStatsResponse": { "docs": undefined, + "inline": undefined, "properties": { "documents_by_source": { "type": "list", @@ -585,6 +604,7 @@ }, "ComposeContent": { "docs": undefined, + "inline": undefined, "properties": { "existing_content": "string", }, @@ -594,6 +614,7 @@ }, "ComposeGenerate": { "docs": undefined, + "inline": undefined, "properties": { "structure": { "type": "list", @@ -605,6 +626,7 @@ }, "ComposeInit": { "docs": undefined, + "inline": undefined, "properties": { "audience": { "type": "optional", @@ -657,6 +679,7 @@ }, "ComposeSectionTalkingPoint": { "docs": undefined, + "inline": undefined, "properties": { "section_heading": "string", }, @@ -666,6 +689,7 @@ }, "ComposeSectionUpdate": { "docs": undefined, + "inline": undefined, "properties": { "instructions": { "type": "list", @@ -682,6 +706,7 @@ }, "ConversationalGuardrails": { "docs": undefined, + "inline": undefined, "properties": { "input": { "docs": "List of valid Input Conversational Guardrails to enable", @@ -698,6 +723,7 @@ }, "Datasource": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "string", @@ -716,6 +742,7 @@ }, "DatasourceConfiguration": { "docs": undefined, + "inline": undefined, "properties": { "name": "string", "private": "boolean", @@ -727,6 +754,7 @@ }, "DatasourceConnection": { "docs": undefined, + "inline": undefined, "properties": { "config": { "type": "optional>", @@ -781,6 +809,7 @@ }, "DatasourceConnectionPublic": { "docs": undefined, + "inline": undefined, "properties": { "config": { "type": "optional>", @@ -830,6 +859,7 @@ }, "DatasourceSyncRun": { "docs": undefined, + "inline": undefined, "properties": { "created": { "type": "datetime", @@ -866,6 +896,7 @@ }, "DocumentCreateTask": { "docs": undefined, + "inline": undefined, "properties": { "info": { "type": "optional>", @@ -881,6 +912,7 @@ }, "DocumentStatusResponse": { "docs": undefined, + "inline": undefined, "properties": { "group_id": "string", "task_count": "integer", @@ -894,6 +926,7 @@ }, "EmptyErrorDetails": { "docs": undefined, + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.yml", @@ -919,6 +952,7 @@ }, "HTTPValidationError": { "docs": undefined, + "inline": undefined, "properties": { "detail": { "type": "optional>", @@ -930,6 +964,7 @@ }, "HydraWebhookTokenHookSession": { "docs": undefined, + "inline": undefined, "properties": { "client_id": "string", "id_token": { @@ -942,6 +977,7 @@ }, "HydraWebhookTokenHookSessionIDTokenClaims": { "docs": undefined, + "inline": undefined, "properties": { "id_token_claims": { "type": "map", @@ -953,6 +989,7 @@ }, "IAMMember": { "docs": undefined, + "inline": undefined, "properties": { "avatar_url": { "docs": "If avatar of the member, if it is supported by their subject type.", @@ -984,6 +1021,7 @@ Some entities, such as Organizations, may contain members that exist without any }, "IAMObjectErrorDetails": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", @@ -996,6 +1034,7 @@ Some entities, such as Organizations, may contain members that exist without any }, "IAMPermissionTest": { "docs": undefined, + "inline": undefined, "properties": { "member": { "type": "optional", @@ -1022,6 +1061,7 @@ Some entities, such as Organizations, may contain members that exist without any "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1034,6 +1074,7 @@ Some entities, such as Organizations, may contain members that exist without any }, "InitialComposeSection": { "docs": undefined, + "inline": undefined, "properties": { "ideas": { "type": "optional>", @@ -1047,6 +1088,7 @@ Some entities, such as Organizations, may contain members that exist without any }, "InputConversationalGuardrailDefinition": { "docs": undefined, + "inline": undefined, "properties": { "name": { "type": "Name", @@ -1058,6 +1100,7 @@ Some entities, such as Organizations, may contain members that exist without any }, "InvalidMemberErrorDetails": { "docs": undefined, + "inline": undefined, "properties": { "resource": { "type": "optional", @@ -1072,6 +1115,7 @@ Some entities, such as Organizations, may contain members that exist without any }, "InvalidMemberErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "invalidMemberError": { "docs": "Metadata detailing more information about the error.", @@ -1088,6 +1132,7 @@ Some entities, such as Organizations, may contain members that exist without any }, "InvalidRoleErrorDetails": { "docs": undefined, + "inline": undefined, "properties": { "resource": { "type": "optional", @@ -1100,6 +1145,7 @@ Some entities, such as Organizations, may contain members that exist without any }, "InvalidRoleErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "invalidRoleError": { "docs": "Metadata detailing more information about the error.", @@ -1116,6 +1162,7 @@ Some entities, such as Organizations, may contain members that exist without any }, "InvalidSubjectTypeErrorDetails": { "docs": undefined, + "inline": undefined, "properties": { "subject": { "type": "optional", @@ -1127,6 +1174,7 @@ Some entities, such as Organizations, may contain members that exist without any }, "InvalidSubjectTypeErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "invalidSubjectTypeError": { "docs": "Metadata detailing more information about the error.", @@ -1144,6 +1192,7 @@ Some entities, such as Organizations, may contain members that exist without any "KratosIdentity": { "docs": undefined, "extra-properties": true, + "inline": undefined, "properties": { "id": { "type": "string", @@ -1163,6 +1212,7 @@ Some entities, such as Organizations, may contain members that exist without any "KratosIdentityTraits": { "docs": undefined, "extra-properties": true, + "inline": undefined, "properties": { "avatar_url": { "type": "optional", @@ -1207,6 +1257,7 @@ Some entities, such as Organizations, may contain members that exist without any }, "KratosWebhook": { "docs": undefined, + "inline": undefined, "properties": { "bio": { "type": "optional", @@ -1255,6 +1306,7 @@ Some entities, such as Organizations, may contain members that exist without any "KratosWebhookDetailedMessage": { "docs": "Sourced from detailedMessage in: https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", + "inline": undefined, "properties": { "context": { "type": "optional", @@ -1272,6 +1324,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", "KratosWebhookErrorMessage": { "docs": "Sourced from errorMessage in: https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", + "inline": undefined, "properties": { "instance_ptr": "string", "messages": { @@ -1285,6 +1338,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", "KratosWebhookResponse": { "docs": "Sourced from rawHookResponse in: https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", + "inline": undefined, "properties": { "identity": { "type": "optional", @@ -1371,6 +1425,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "MalformedResourceIdentifierErrorDetails": { "docs": undefined, + "inline": undefined, "properties": { "expected_format": "string", "field": "string", @@ -1382,6 +1437,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "MalformedResourceIdentifierErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "malformedResourceIdentifierError": { "docs": "Metadata detailing more information about the error.", @@ -1398,6 +1454,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "MissingAuthenticationErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "message": { "docs": "Human readable representation of the error", @@ -1414,6 +1471,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "MultipleRolesNotAllowedErrorDetails": { "docs": undefined, + "inline": undefined, "properties": { "resource": { "type": "optional", @@ -1428,6 +1486,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "MultipleRolesNotAllowedErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "message": { "docs": "Human readable representation of the error", @@ -1453,6 +1512,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "OAuthClientCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "client_id": { "type": "string", @@ -1490,6 +1550,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "Object": { "docs": undefined, + "inline": undefined, "properties": { "createdTime": { "type": "optional", @@ -1541,6 +1602,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "Org": { "docs": undefined, + "inline": undefined, "properties": { "avatar_url": { "type": "optional", @@ -1592,6 +1654,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "OrganizationDomain": { "docs": undefined, + "inline": undefined, "properties": { "domain": "string", "id": { @@ -1613,6 +1676,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "OrganizationInvite": { "docs": undefined, + "inline": undefined, "properties": { "email_address": { "type": "string", @@ -1642,6 +1706,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "OrganizationInviteAlreadyExistsErrorDetails": { "docs": undefined, + "inline": undefined, "properties": { "email_address": "string", "organization_id": "string", @@ -1652,6 +1717,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "OrganizationInviteAlreadyExistsErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "message": { "docs": "Human readable representation of the error", @@ -1668,6 +1734,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "OrganizationMemberAlreadyExistsErrorDetails": { "docs": undefined, + "inline": undefined, "properties": { "member_id": "string", "organization_id": "string", @@ -1678,6 +1745,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "OrganizationMemberAlreadyExistsErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "message": { "docs": "Human readable representation of the error", @@ -1694,6 +1762,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "OutputConversationalGuardrailDefinition": { "docs": undefined, + "inline": undefined, "properties": { "name": { "type": "literal<"source_validation">", @@ -1705,6 +1774,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetChat": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -1721,6 +1791,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetChatDocument": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -1737,6 +1808,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetChatDocumentEmbeddingRecord": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -1753,6 +1825,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetCollection": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -1769,6 +1842,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetDatasourceSyncRun": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -1785,6 +1859,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetIamMember": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -1801,6 +1876,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetOrganizationDomain": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -1817,6 +1893,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetOrganizationInvite": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -1833,6 +1910,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetProject": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -1849,6 +1927,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetTask": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -1865,6 +1944,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetTaskForwarder": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -1881,6 +1961,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginatedResultSetTaskRun": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Contains pagination information for the result set.", @@ -1897,6 +1978,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PaginationDetails": { "docs": undefined, + "inline": undefined, "properties": { "has_next": { "docs": "Indicates whether there are more results available in the next page.", @@ -1917,6 +1999,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PermissionCheckFailedErrorDetails": { "docs": undefined, + "inline": undefined, "properties": { "permission": "string", "resource": { @@ -1932,6 +2015,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "PermissionCheckFailedErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "message": { "docs": "Human readable representation of the error", @@ -1948,6 +2032,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "Project": { "docs": undefined, + "inline": undefined, "properties": { "avatar_url": { "type": "optional", @@ -1987,6 +2072,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "ProjectConfig": { "docs": undefined, + "inline": undefined, "properties": { "chat_guardrails": { "type": "optional", @@ -2025,6 +2111,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "ProjectWithDatasources": { "docs": undefined, + "inline": undefined, "properties": { "avatar_url": { "type": "optional", @@ -2083,6 +2170,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "SourceRow": { "docs": undefined, + "inline": undefined, "properties": { "count": "integer", "source": { @@ -2117,6 +2205,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "Task": { "docs": undefined, + "inline": undefined, "properties": { "created": { "docs": "When the Task was created.", @@ -2169,6 +2258,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "TaskForwarder": { "docs": undefined, + "inline": undefined, "properties": { "config": { "docs": "Configuration parameters for the Task Forwarder such as a `destination` URL.", @@ -2221,6 +2311,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "TaskForwarderConfig": { "docs": undefined, + "inline": undefined, "properties": { "destination_url": { "docs": "The URL where Task Run result will be forwarded. Must be a valid HTTPS URL.", @@ -2233,6 +2324,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "TaskForwarderSensitiveConfig": { "docs": undefined, + "inline": undefined, "properties": { "signing_key": { "docs": "A secret key used to sign the forwarded data for verification purposes.", @@ -2245,6 +2337,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "TaskLLMConfig": { "docs": undefined, + "inline": undefined, "properties": { "temperature": { "default": 0.2, @@ -2265,6 +2358,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "TaskRAG": { "docs": undefined, + "inline": undefined, "properties": { "collection_id": { "type": "string", @@ -2283,6 +2377,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "TaskRevision": { "docs": undefined, + "inline": undefined, "properties": { "active": { "default": false, @@ -2421,6 +2516,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "TaskRun": { "docs": undefined, + "inline": undefined, "properties": { "created": { "docs": "The timestamp when the Task Run was created.", @@ -2472,6 +2568,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "User": { "docs": undefined, + "inline": undefined, "properties": { "avatar_url": { "type": "optional", @@ -2505,6 +2602,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", }, "ValidationError": { "docs": undefined, + "inline": undefined, "properties": { "loc": { "type": "list", @@ -2520,6 +2618,7 @@ https://github.com/ory/kratos/blob/master/selfservice/hook/web_hook.go", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3352,6 +3451,7 @@ types: - type: KratosIdentity source: openapi: ../openapi.yml + inline: true KratosWebhookResponse: docs: |- Sourced from rawHookResponse in: @@ -4061,6 +4161,7 @@ types: - integer source: openapi: ../openapi.yml + inline: true ValidationError: properties: loc: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/rules.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/rules.json index 3cafaa6db95..082e1bbf8ef 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/rules.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/rules.json @@ -46,6 +46,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -56,6 +57,7 @@ }, "GetExampleResponseMessage": { "docs": undefined, + "inline": true, "properties": { "message": "optional", }, @@ -65,6 +67,7 @@ }, "Schema": { "docs": undefined, + "inline": undefined, "properties": { "age": { "default": 50, @@ -135,6 +138,7 @@ message: optional source: openapi: ../openapi.yml + inline: true GetExampleResponse: discriminated: false union: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/seam.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/seam.json index 15d60a3d54e..ab1cf1a0152 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/seam.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/seam.json @@ -20,6 +20,7 @@ "types": { "AccessCode": { "docs": undefined, + "inline": undefined, "properties": { "access_code_id": { "docs": "Unique identifier for the access code.", @@ -151,6 +152,7 @@ }, "AcsAccessGroup": { "docs": undefined, + "inline": undefined, "properties": { "access_group_type": { "docs": " @@ -234,6 +236,7 @@ }, "AcsCredential": { "docs": undefined, + "inline": undefined, "properties": { "access_method": "AcsCredentialAccessMethod", "acs_credential_id": { @@ -328,6 +331,7 @@ }, "AcsCredentialErrorsItem": { "docs": undefined, + "inline": true, "properties": { "error_code": "string", "message": "string", @@ -349,6 +353,7 @@ }, "AcsCredentialPool": { "docs": undefined, + "inline": undefined, "properties": { "acs_credential_pool_id": { "type": "string", @@ -396,6 +401,7 @@ }, "AcsCredentialProvisioningAutomation": { "docs": undefined, + "inline": undefined, "properties": { "acs_credential_provisioning_automation_id": { "type": "string", @@ -441,6 +447,7 @@ }, "AcsCredentialVisionlineMetadata": { "docs": undefined, + "inline": true, "properties": { "card_function_type": "AcsCredentialVisionlineMetadataCardFunctionType", "common_acs_entrance_ids": "optional>", @@ -462,6 +469,7 @@ }, "AcsCredentialWarningsItem": { "docs": undefined, + "inline": true, "properties": { "message": "string", "warning_code": "string", @@ -472,6 +480,7 @@ }, "AcsEntrance": { "docs": undefined, + "inline": undefined, "properties": { "acs_entrance_id": { "type": "string", @@ -503,6 +512,7 @@ }, "AcsEntranceErrorsItem": { "docs": undefined, + "inline": true, "properties": { "error_code": "string", "message": "string", @@ -513,6 +523,7 @@ }, "AcsEntranceLatchMetadata": { "docs": undefined, + "inline": true, "properties": { "accessibility_type": "string", "door_name": "string", @@ -525,6 +536,7 @@ }, "AcsEntranceVisionlineMetadata": { "docs": undefined, + "inline": true, "properties": { "door_category": "AcsEntranceVisionlineMetadataDoorCategory", "door_name": "string", @@ -554,6 +566,7 @@ }, "AcsEntranceVisionlineMetadataProfilesItem": { "docs": undefined, + "inline": true, "properties": { "visionline_door_profile_id": "string", "visionline_door_profile_type": "AcsEntranceVisionlineMetadataProfilesItemVisionlineDoorProfileType", @@ -574,6 +587,7 @@ }, "AcsSystem": { "docs": undefined, + "inline": undefined, "properties": { "acs_system_id": { "type": "string", @@ -643,6 +657,7 @@ }, "AcsSystemErrorsItemSeamBridgeDisconnected": { "docs": undefined, + "inline": true, "properties": { "created_at": "datetime", "message": "string", @@ -653,6 +668,7 @@ }, "AcsSystemErrorsItemVisionlineInstanceUnreachable": { "docs": undefined, + "inline": true, "properties": { "created_at": "datetime", "message": "string", @@ -698,6 +714,7 @@ }, "AcsSystemWarningsItem": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.json", @@ -705,6 +722,7 @@ }, "AcsUser": { "docs": undefined, + "inline": undefined, "properties": { "access_schedule": "optional", "acs_system_id": { @@ -784,6 +802,7 @@ }, "AcsUserAccessSchedule": { "docs": undefined, + "inline": true, "properties": { "ends_at": "datetime", "starts_at": "datetime", @@ -808,6 +827,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -933,6 +953,7 @@ }, "ActionAttemptActionAttemptId": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -960,6 +981,7 @@ }, "ActionAttemptActionAttemptIdError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -970,6 +992,7 @@ }, "ActionAttemptEight": { "docs": "Resetting sandbox workspace failed.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -997,6 +1020,7 @@ }, "ActionAttemptEightError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -1007,6 +1031,7 @@ }, "ActionAttemptEighteen": { "docs": "Setting fan mode.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1034,6 +1059,7 @@ }, "ActionAttemptEleven": { "docs": "Setting HVAC to cool failed.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1061,6 +1087,7 @@ }, "ActionAttemptElevenError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -1071,6 +1098,7 @@ }, "ActionAttemptFifteen": { "docs": "Setting HVAC to heat-cool mode.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1098,6 +1126,7 @@ }, "ActionAttemptFive": { "docs": "Unlocking door failed.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1125,6 +1154,7 @@ }, "ActionAttemptFiveError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -1135,6 +1165,7 @@ }, "ActionAttemptForty": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1162,6 +1193,7 @@ }, "ActionAttemptFortyOne": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1189,6 +1221,7 @@ }, "ActionAttemptFortyOneError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -1199,6 +1232,7 @@ }, "ActionAttemptFortyThree": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1226,6 +1260,7 @@ }, "ActionAttemptFortyTwo": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1253,6 +1288,7 @@ }, "ActionAttemptFour": { "docs": "Unlocking door succeeded.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1280,6 +1316,7 @@ }, "ActionAttemptFourResult": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.json", @@ -1287,6 +1324,7 @@ }, "ActionAttemptFourteen": { "docs": "Setting HVAC to heat mode failed.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1314,6 +1352,7 @@ }, "ActionAttemptFourteenError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -1324,6 +1363,7 @@ }, "ActionAttemptNine": { "docs": "Setting HVAC to cool.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1351,6 +1391,7 @@ }, "ActionAttemptNineteen": { "docs": "Setting fan mode succeeded.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1378,6 +1419,7 @@ }, "ActionAttemptNineteenResult": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.json", @@ -1385,6 +1427,7 @@ }, "ActionAttemptOne": { "docs": "Locking door succeeded.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1412,6 +1455,7 @@ }, "ActionAttemptOneResult": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.json", @@ -1419,6 +1463,7 @@ }, "ActionAttemptSeven": { "docs": "Resetting sandbox workspace succeeded.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1446,6 +1491,7 @@ }, "ActionAttemptSevenResult": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.json", @@ -1453,6 +1499,7 @@ }, "ActionAttemptSeventeen": { "docs": "Setting heat-cool mode failed.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1480,6 +1527,7 @@ }, "ActionAttemptSeventeenError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -1490,6 +1538,7 @@ }, "ActionAttemptSix": { "docs": "Resetting sandbox workspace.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1517,6 +1566,7 @@ }, "ActionAttemptSixteen": { "docs": "Setting HVAC to heat-cool mode succeeded.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1544,6 +1594,7 @@ }, "ActionAttemptSixteenResult": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.json", @@ -1551,6 +1602,7 @@ }, "ActionAttemptTen": { "docs": "Setting HVAC to cool succeeded.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1578,6 +1630,7 @@ }, "ActionAttemptTenResult": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.json", @@ -1585,6 +1638,7 @@ }, "ActionAttemptThirteen": { "docs": "Setting HVAC to heat mode succeeded.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1612,6 +1666,7 @@ }, "ActionAttemptThirteenResult": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.json", @@ -1619,6 +1674,7 @@ }, "ActionAttemptThirty": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1646,6 +1702,7 @@ }, "ActionAttemptThirtyEight": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1673,6 +1730,7 @@ }, "ActionAttemptThirtyEightError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -1683,6 +1741,7 @@ }, "ActionAttemptThirtyFive": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1710,6 +1769,7 @@ }, "ActionAttemptThirtyFiveError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -1720,6 +1780,7 @@ }, "ActionAttemptThirtyFour": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1747,6 +1808,7 @@ }, "ActionAttemptThirtyNine": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1774,6 +1836,7 @@ }, "ActionAttemptThirtyOne": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1801,6 +1864,7 @@ }, "ActionAttemptThirtySeven": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1828,6 +1892,7 @@ }, "ActionAttemptThirtySix": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1855,6 +1920,7 @@ }, "ActionAttemptThirtyThree": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1882,6 +1948,7 @@ }, "ActionAttemptThirtyTwo": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1909,6 +1976,7 @@ }, "ActionAttemptThirtyTwoError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -1919,6 +1987,7 @@ }, "ActionAttemptThree": { "docs": "Unlocking door.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1946,6 +2015,7 @@ }, "ActionAttemptTwelve": { "docs": "Setting HVAC to heat mode.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -1973,6 +2043,7 @@ }, "ActionAttemptTwenty": { "docs": "Setting fan mode failed.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2000,6 +2071,7 @@ }, "ActionAttemptTwentyEight": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2027,6 +2099,7 @@ }, "ActionAttemptTwentyError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -2037,6 +2110,7 @@ }, "ActionAttemptTwentyFive": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2064,6 +2138,7 @@ }, "ActionAttemptTwentyFour": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2091,6 +2166,7 @@ }, "ActionAttemptTwentyNine": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2118,6 +2194,7 @@ }, "ActionAttemptTwentyNineError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -2128,6 +2205,7 @@ }, "ActionAttemptTwentyOne": { "docs": "Turning HVAC off.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2155,6 +2233,7 @@ }, "ActionAttemptTwentySeven": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2182,6 +2261,7 @@ }, "ActionAttemptTwentySix": { "docs": undefined, + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2209,6 +2289,7 @@ }, "ActionAttemptTwentySixError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -2219,6 +2300,7 @@ }, "ActionAttemptTwentyThree": { "docs": "Turning HVAC off failed.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2246,6 +2328,7 @@ }, "ActionAttemptTwentyThreeError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -2256,6 +2339,7 @@ }, "ActionAttemptTwentyTwo": { "docs": "Turning HVAC off succeeded.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2283,6 +2367,7 @@ }, "ActionAttemptTwentyTwoResult": { "docs": undefined, + "inline": true, "properties": {}, "source": { "openapi": "../openapi.json", @@ -2290,6 +2375,7 @@ }, "ActionAttemptTwo": { "docs": "Locking door failed.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2317,6 +2403,7 @@ }, "ActionAttemptTwoError": { "docs": undefined, + "inline": true, "properties": { "message": "string", "type": "string", @@ -2327,6 +2414,7 @@ }, "ActionAttemptZero": { "docs": "Locking door.", + "inline": true, "properties": { "action_attempt_id": { "docs": " @@ -2354,6 +2442,7 @@ }, "ClientSession": { "docs": undefined, + "inline": undefined, "properties": { "client_session_id": { "type": "string", @@ -2387,6 +2476,7 @@ }, "ClimateSettingSchedule": { "docs": undefined, + "inline": undefined, "properties": { "automatic_cooling_enabled": "optional", "automatic_heating_enabled": "optional", @@ -2438,6 +2528,7 @@ }, "ConnectWebview": { "docs": undefined, + "inline": undefined, "properties": { "accepted_devices": { "docs": " @@ -2529,6 +2620,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -2559,6 +2651,7 @@ }, "ConnectedAccount": { "docs": undefined, + "inline": undefined, "properties": { "account_type": "optional", "account_type_display_name": "string", @@ -2586,6 +2679,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -2596,6 +2690,7 @@ }, "ConnectedAccountUserIdentifier": { "docs": undefined, + "inline": true, "properties": { "api_url": "optional", "email": "optional", @@ -2609,6 +2704,7 @@ }, "Device": { "docs": undefined, + "inline": undefined, "properties": { "can_program_offline_access_codes": "optional", "can_program_online_access_codes": "optional", @@ -2710,6 +2806,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -2761,6 +2858,7 @@ }, "DeviceErrorsItem": { "docs": undefined, + "inline": true, "properties": { "error_code": "string", "message": "string", @@ -2771,6 +2869,7 @@ }, "DeviceLocation": { "docs": "Location information for the device.", + "inline": true, "properties": { "location_name": { "docs": "Name of the device location.", @@ -2787,6 +2886,7 @@ }, "DeviceProperties": { "docs": "Properties of the device.", + "inline": true, "properties": { "_experimental_supported_code_from_access_codes_lengths": "optional>", "accessory_keypad": { @@ -2923,6 +3023,7 @@ }, "DevicePropertiesAccessoryKeypad": { "docs": "Represents the accessory keypad state.", + "inline": true, "properties": { "battery": { "docs": "Indicates if the keypad battery properties.", @@ -2939,6 +3040,7 @@ }, "DevicePropertiesAccessoryKeypadBattery": { "docs": "Indicates if the keypad battery properties.", + "inline": true, "properties": { "level": { "type": "double", @@ -2957,6 +3059,7 @@ }, "DevicePropertiesAppearance": { "docs": undefined, + "inline": true, "properties": { "name": { "docs": "Name of the device as seen from the provider API and application, not settable through Seam.", @@ -2969,6 +3072,7 @@ }, "DevicePropertiesAssaAbloyCredentialServiceMetadata": { "docs": undefined, + "inline": true, "properties": { "endpoints": "list", "has_active_endpoint": "boolean", @@ -2979,6 +3083,7 @@ }, "DevicePropertiesAssaAbloyCredentialServiceMetadataEndpointsItem": { "docs": undefined, + "inline": true, "properties": { "endpoint_id": "string", "is_active": "boolean", @@ -2989,6 +3094,7 @@ }, "DevicePropertiesAugustMetadata": { "docs": undefined, + "inline": true, "properties": { "has_keypad": "boolean", "house_id": "optional", @@ -3004,6 +3110,7 @@ }, "DevicePropertiesAvigilonAltaMetadata": { "docs": undefined, + "inline": true, "properties": { "entry_name": "string", "entry_relays_total_count": "double", @@ -3019,6 +3126,7 @@ }, "DevicePropertiesBattery": { "docs": "Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage.", + "inline": true, "properties": { "level": { "type": "double", @@ -3049,6 +3157,7 @@ }, "DevicePropertiesBrivoMetadata": { "docs": undefined, + "inline": true, "properties": { "device_name": "string", }, @@ -3060,6 +3169,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -3070,6 +3180,7 @@ }, "DevicePropertiesCodeConstraintsItemMaxLength": { "docs": undefined, + "inline": true, "properties": { "constraint_type": "DevicePropertiesCodeConstraintsItemMaxLengthConstraintType", "max_length": "optional", @@ -3090,6 +3201,7 @@ }, "DevicePropertiesCodeConstraintsItemZero": { "docs": undefined, + "inline": true, "properties": { "constraint_type": "DevicePropertiesCodeConstraintsItemZeroConstraintType", }, @@ -3115,6 +3227,7 @@ }, "DevicePropertiesControlbywebMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "string", "device_name": "string", @@ -3126,6 +3239,7 @@ }, "DevicePropertiesDormakabaOracodeMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "optional", "door_id": "double", @@ -3142,6 +3256,7 @@ }, "DevicePropertiesDormakabaOracodeMetadataPredefinedTimeSlotsItem": { "docs": undefined, + "inline": true, "properties": { "check_in_time": "string", "check_out_time": "string", @@ -3168,6 +3283,7 @@ }, "DevicePropertiesEcobeeMetadata": { "docs": undefined, + "inline": true, "properties": { "device_name": "string", "ecobee_device_id": "string", @@ -3178,6 +3294,7 @@ }, "DevicePropertiesFourSuitesMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "double", "device_name": "string", @@ -3189,6 +3306,7 @@ }, "DevicePropertiesGenieMetadata": { "docs": undefined, + "inline": true, "properties": { "device_name": "string", "door_name": "string", @@ -3199,6 +3317,7 @@ }, "DevicePropertiesHoneywellResideoMetadata": { "docs": undefined, + "inline": true, "properties": { "device_name": "string", "honeywell_resideo_device_id": "string", @@ -3209,6 +3328,7 @@ }, "DevicePropertiesHubitatMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "string", "device_label": "string", @@ -3220,6 +3340,7 @@ }, "DevicePropertiesIglooMetadata": { "docs": undefined, + "inline": true, "properties": { "bridge_id": "string", "device_id": "string", @@ -3231,6 +3352,7 @@ }, "DevicePropertiesIgloohomeMetadata": { "docs": undefined, + "inline": true, "properties": { "bridge_id": "optional", "bridge_name": "optional", @@ -3244,6 +3366,7 @@ }, "DevicePropertiesKeypadBattery": { "docs": undefined, + "inline": true, "properties": { "level": "double", }, @@ -3253,6 +3376,7 @@ }, "DevicePropertiesKwiksetMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "string", "device_name": "string", @@ -3264,6 +3388,7 @@ }, "DevicePropertiesLocklyMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "string", "device_name": "string", @@ -3275,6 +3400,7 @@ }, "DevicePropertiesMinutMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "string", "device_name": "string", @@ -3286,6 +3412,7 @@ }, "DevicePropertiesMinutMetadataLatestSensorValues": { "docs": undefined, + "inline": true, "properties": { "accelerometer_z": "DevicePropertiesMinutMetadataLatestSensorValuesAccelerometerZ", "humidity": "DevicePropertiesMinutMetadataLatestSensorValuesHumidity", @@ -3299,6 +3426,7 @@ }, "DevicePropertiesMinutMetadataLatestSensorValuesAccelerometerZ": { "docs": undefined, + "inline": true, "properties": { "time": "string", "value": "double", @@ -3309,6 +3437,7 @@ }, "DevicePropertiesMinutMetadataLatestSensorValuesHumidity": { "docs": undefined, + "inline": true, "properties": { "time": "string", "value": "double", @@ -3319,6 +3448,7 @@ }, "DevicePropertiesMinutMetadataLatestSensorValuesPressure": { "docs": undefined, + "inline": true, "properties": { "time": "string", "value": "double", @@ -3329,6 +3459,7 @@ }, "DevicePropertiesMinutMetadataLatestSensorValuesSound": { "docs": undefined, + "inline": true, "properties": { "time": "string", "value": "double", @@ -3339,6 +3470,7 @@ }, "DevicePropertiesMinutMetadataLatestSensorValuesTemperature": { "docs": undefined, + "inline": true, "properties": { "time": "string", "value": "double", @@ -3349,6 +3481,7 @@ }, "DevicePropertiesModel": { "docs": undefined, + "inline": true, "properties": { "accessory_keypad_supported": { "docs": " @@ -3389,6 +3522,7 @@ }, "DevicePropertiesNestMetadata": { "docs": undefined, + "inline": true, "properties": { "custom_name": "string", "device_name": "string", @@ -3400,6 +3534,7 @@ }, "DevicePropertiesNoiseawareMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "string", "device_model": "DevicePropertiesNoiseawareMetadataDeviceModel", @@ -3422,6 +3557,7 @@ }, "DevicePropertiesNukiMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "string", "device_name": "string", @@ -3435,6 +3571,7 @@ }, "DevicePropertiesSaltoMetadata": { "docs": undefined, + "inline": true, "properties": { "battery_level": "string", "customer_reference": "string", @@ -3449,6 +3586,7 @@ }, "DevicePropertiesSchlageMetadata": { "docs": undefined, + "inline": true, "properties": { "access_code_length": "optional", "device_id": "string", @@ -3461,6 +3599,7 @@ }, "DevicePropertiesSeamBridgeMetadata": { "docs": undefined, + "inline": true, "properties": { "device_num": "double", "name": "string", @@ -3481,6 +3620,7 @@ }, "DevicePropertiesSmartthingsMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "string", "device_name": "string", @@ -3493,6 +3633,7 @@ }, "DevicePropertiesTedeeMetadata": { "docs": undefined, + "inline": true, "properties": { "bridge_id": "double", "bridge_name": "string", @@ -3508,6 +3649,7 @@ }, "DevicePropertiesTtlockMetadata": { "docs": undefined, + "inline": true, "properties": { "feature_value": "string", "lock_alias": "string", @@ -3519,6 +3661,7 @@ }, "DevicePropertiesTwoNMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "double", "device_name": "string", @@ -3529,6 +3672,7 @@ }, "DevicePropertiesWyzeMetadata": { "docs": undefined, + "inline": true, "properties": { "device_id": "string", "device_info_model": "string", @@ -3545,6 +3689,7 @@ }, "DeviceProvider": { "docs": undefined, + "inline": undefined, "properties": { "device_provider_name": "DeviceProviderDeviceProviderName", "display_name": "string", @@ -3613,6 +3758,7 @@ }, "DeviceWarningsItem": { "docs": undefined, + "inline": true, "properties": { "message": "string", "warning_code": "string", @@ -3623,6 +3769,7 @@ }, "EnrollmentAutomation": { "docs": undefined, + "inline": undefined, "properties": { "created_at": "datetime", "credential_manager_acs_system_id": { @@ -3668,6 +3815,7 @@ }, "Event": { "docs": undefined, + "inline": undefined, "properties": { "acs_credential_id": { "type": "optional", @@ -3760,6 +3908,7 @@ }, "Network": { "docs": undefined, + "inline": undefined, "properties": { "created_at": "datetime", "display_name": "string", @@ -3788,6 +3937,7 @@ }, "NoiseThreshold": { "docs": undefined, + "inline": undefined, "properties": { "device_id": { "type": "string", @@ -3819,6 +3969,7 @@ }, "Phone": { "docs": undefined, + "inline": undefined, "properties": { "can_program_offline_access_codes": "optional", "can_program_online_access_codes": "optional", @@ -3904,6 +4055,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -3923,6 +4075,7 @@ }, "PhoneErrorsItem": { "docs": undefined, + "inline": true, "properties": { "error_code": "string", "message": "string", @@ -3933,6 +4086,7 @@ }, "PhoneLocation": { "docs": "Location information for the device.", + "inline": true, "properties": { "location_name": { "docs": "Name of the device location.", @@ -3949,6 +4103,7 @@ }, "PhoneProperties": { "docs": undefined, + "inline": true, "properties": { "assa_abloy_credential_service_metadata": "optional", }, @@ -3958,6 +4113,7 @@ }, "PhonePropertiesAssaAbloyCredentialServiceMetadata": { "docs": undefined, + "inline": true, "properties": { "endpoints": "list", "has_active_endpoint": "boolean", @@ -3968,6 +4124,7 @@ }, "PhonePropertiesAssaAbloyCredentialServiceMetadataEndpointsItem": { "docs": undefined, + "inline": true, "properties": { "endpoint_id": "string", "is_active": "boolean", @@ -3978,6 +4135,7 @@ }, "PhoneWarningsItem": { "docs": undefined, + "inline": true, "properties": { "message": "string", "warning_code": "string", @@ -3988,6 +4146,7 @@ }, "ServiceHealth": { "docs": undefined, + "inline": undefined, "properties": { "description": "string", "service": "string", @@ -4009,6 +4168,7 @@ }, "UnmanagedAccessCode": { "docs": undefined, + "inline": undefined, "properties": { "access_code_id": { "docs": "Unique identifier for the access code.", @@ -4075,6 +4235,7 @@ }, "UnmanagedDevice": { "docs": undefined, + "inline": undefined, "properties": { "can_program_offline_access_codes": "optional", "can_program_online_access_codes": "optional", @@ -4196,6 +4357,7 @@ }, "UnmanagedDeviceErrorsItem": { "docs": undefined, + "inline": true, "properties": { "error_code": "string", "message": "string", @@ -4206,6 +4368,7 @@ }, "UnmanagedDeviceProperties": { "docs": undefined, + "inline": true, "properties": { "accessory_keypad": { "docs": "Represents the accessory keypad state.", @@ -4273,6 +4436,7 @@ }, "UnmanagedDevicePropertiesAccessoryKeypad": { "docs": "Represents the accessory keypad state.", + "inline": true, "properties": { "battery": { "docs": "Indicates if the keypad battery properties.", @@ -4289,6 +4453,7 @@ }, "UnmanagedDevicePropertiesAccessoryKeypadBattery": { "docs": "Indicates if the keypad battery properties.", + "inline": true, "properties": { "level": { "type": "double", @@ -4307,6 +4472,7 @@ }, "UnmanagedDevicePropertiesBattery": { "docs": "Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage.", + "inline": true, "properties": { "level": { "type": "double", @@ -4337,6 +4503,7 @@ }, "UnmanagedDevicePropertiesModel": { "docs": undefined, + "inline": true, "properties": { "accessory_keypad_supported": { "docs": " @@ -4377,6 +4544,7 @@ }, "UnmanagedDeviceWarningsItem": { "docs": undefined, + "inline": true, "properties": { "message": "string", "warning_code": "string", @@ -4387,6 +4555,7 @@ }, "UserIdentity": { "docs": undefined, + "inline": undefined, "properties": { "created_at": "datetime", "display_name": { @@ -4451,6 +4620,7 @@ }, "Webhook": { "docs": undefined, + "inline": undefined, "properties": { "event_types": "optional>", "secret": "optional", @@ -4463,6 +4633,7 @@ }, "Workspace": { "docs": undefined, + "inline": undefined, "properties": { "company_name": "string", "connect_partner_name": { @@ -4689,10 +4860,12 @@ types: action_type: literal<"LOCK_DOOR"> source: openapi: ../openapi.json + inline: true ActionAttemptOneResult: properties: {} source: openapi: ../openapi.json + inline: true ActionAttemptOne: docs: Locking door succeeded. properties: @@ -4713,12 +4886,14 @@ types: result: ActionAttemptOneResult source: openapi: ../openapi.json + inline: true ActionAttemptTwoError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptTwo: docs: Locking door failed. properties: @@ -4739,6 +4914,7 @@ types: error: ActionAttemptTwoError source: openapi: ../openapi.json + inline: true ActionAttemptThree: docs: Unlocking door. properties: @@ -4759,10 +4935,12 @@ types: action_type: literal<"UNLOCK_DOOR"> source: openapi: ../openapi.json + inline: true ActionAttemptFourResult: properties: {} source: openapi: ../openapi.json + inline: true ActionAttemptFour: docs: Unlocking door succeeded. properties: @@ -4783,12 +4961,14 @@ types: result: ActionAttemptFourResult source: openapi: ../openapi.json + inline: true ActionAttemptFiveError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptFive: docs: Unlocking door failed. properties: @@ -4809,6 +4989,7 @@ types: error: ActionAttemptFiveError source: openapi: ../openapi.json + inline: true ActionAttemptSix: docs: Resetting sandbox workspace. properties: @@ -4829,10 +5010,12 @@ types: action_type: literal<"RESET_SANDBOX_WORKSPACE"> source: openapi: ../openapi.json + inline: true ActionAttemptSevenResult: properties: {} source: openapi: ../openapi.json + inline: true ActionAttemptSeven: docs: Resetting sandbox workspace succeeded. properties: @@ -4853,12 +5036,14 @@ types: result: ActionAttemptSevenResult source: openapi: ../openapi.json + inline: true ActionAttemptEightError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptEight: docs: Resetting sandbox workspace failed. properties: @@ -4879,6 +5064,7 @@ types: error: ActionAttemptEightError source: openapi: ../openapi.json + inline: true ActionAttemptNine: docs: Setting HVAC to cool. properties: @@ -4899,10 +5085,12 @@ types: action_type: literal<"SET_COOL"> source: openapi: ../openapi.json + inline: true ActionAttemptTenResult: properties: {} source: openapi: ../openapi.json + inline: true ActionAttemptTen: docs: Setting HVAC to cool succeeded. properties: @@ -4923,12 +5111,14 @@ types: result: ActionAttemptTenResult source: openapi: ../openapi.json + inline: true ActionAttemptElevenError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptEleven: docs: Setting HVAC to cool failed. properties: @@ -4949,6 +5139,7 @@ types: error: ActionAttemptElevenError source: openapi: ../openapi.json + inline: true ActionAttemptTwelve: docs: Setting HVAC to heat mode. properties: @@ -4969,10 +5160,12 @@ types: action_type: literal<"SET_HEAT"> source: openapi: ../openapi.json + inline: true ActionAttemptThirteenResult: properties: {} source: openapi: ../openapi.json + inline: true ActionAttemptThirteen: docs: Setting HVAC to heat mode succeeded. properties: @@ -4993,12 +5186,14 @@ types: result: ActionAttemptThirteenResult source: openapi: ../openapi.json + inline: true ActionAttemptFourteenError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptFourteen: docs: Setting HVAC to heat mode failed. properties: @@ -5019,6 +5214,7 @@ types: error: ActionAttemptFourteenError source: openapi: ../openapi.json + inline: true ActionAttemptFifteen: docs: Setting HVAC to heat-cool mode. properties: @@ -5039,10 +5235,12 @@ types: action_type: literal<"SET_HEAT_COOL"> source: openapi: ../openapi.json + inline: true ActionAttemptSixteenResult: properties: {} source: openapi: ../openapi.json + inline: true ActionAttemptSixteen: docs: Setting HVAC to heat-cool mode succeeded. properties: @@ -5063,12 +5261,14 @@ types: result: ActionAttemptSixteenResult source: openapi: ../openapi.json + inline: true ActionAttemptSeventeenError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptSeventeen: docs: Setting heat-cool mode failed. properties: @@ -5089,6 +5289,7 @@ types: error: ActionAttemptSeventeenError source: openapi: ../openapi.json + inline: true ActionAttemptEighteen: docs: Setting fan mode. properties: @@ -5109,10 +5310,12 @@ types: action_type: literal<"SET_FAN_MODE"> source: openapi: ../openapi.json + inline: true ActionAttemptNineteenResult: properties: {} source: openapi: ../openapi.json + inline: true ActionAttemptNineteen: docs: Setting fan mode succeeded. properties: @@ -5133,12 +5336,14 @@ types: result: ActionAttemptNineteenResult source: openapi: ../openapi.json + inline: true ActionAttemptTwentyError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptTwenty: docs: Setting fan mode failed. properties: @@ -5159,6 +5364,7 @@ types: error: ActionAttemptTwentyError source: openapi: ../openapi.json + inline: true ActionAttemptTwentyOne: docs: Turning HVAC off. properties: @@ -5179,10 +5385,12 @@ types: action_type: literal<"SET_THERMOSTAT_OFF"> source: openapi: ../openapi.json + inline: true ActionAttemptTwentyTwoResult: properties: {} source: openapi: ../openapi.json + inline: true ActionAttemptTwentyTwo: docs: Turning HVAC off succeeded. properties: @@ -5203,12 +5411,14 @@ types: result: ActionAttemptTwentyTwoResult source: openapi: ../openapi.json + inline: true ActionAttemptTwentyThreeError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptTwentyThree: docs: Turning HVAC off failed. properties: @@ -5229,6 +5439,7 @@ types: error: ActionAttemptTwentyThreeError source: openapi: ../openapi.json + inline: true ActionAttemptTwentyFour: properties: action_attempt_id: @@ -5248,6 +5459,7 @@ types: action_type: literal<"SYNC_ACCESS_CODES"> source: openapi: ../openapi.json + inline: true ActionAttemptTwentyFive: properties: action_attempt_id: @@ -5267,12 +5479,14 @@ types: result: optional source: openapi: ../openapi.json + inline: true ActionAttemptTwentySixError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptTwentySix: properties: action_attempt_id: @@ -5292,6 +5506,7 @@ types: error: ActionAttemptTwentySixError source: openapi: ../openapi.json + inline: true ActionAttemptTwentySeven: properties: action_attempt_id: @@ -5311,6 +5526,7 @@ types: action_type: literal<"CREATE_ACCESS_CODE"> source: openapi: ../openapi.json + inline: true ActionAttemptTwentyEight: properties: action_attempt_id: @@ -5330,12 +5546,14 @@ types: result: optional source: openapi: ../openapi.json + inline: true ActionAttemptTwentyNineError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptTwentyNine: properties: action_attempt_id: @@ -5355,6 +5573,7 @@ types: error: ActionAttemptTwentyNineError source: openapi: ../openapi.json + inline: true ActionAttemptThirty: properties: action_attempt_id: @@ -5374,6 +5593,7 @@ types: action_type: literal<"DELETE_ACCESS_CODE"> source: openapi: ../openapi.json + inline: true ActionAttemptThirtyOne: properties: action_attempt_id: @@ -5393,12 +5613,14 @@ types: result: optional source: openapi: ../openapi.json + inline: true ActionAttemptThirtyTwoError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptThirtyTwo: properties: action_attempt_id: @@ -5418,6 +5640,7 @@ types: error: ActionAttemptThirtyTwoError source: openapi: ../openapi.json + inline: true ActionAttemptThirtyThree: properties: action_attempt_id: @@ -5437,6 +5660,7 @@ types: action_type: literal<"UPDATE_ACCESS_CODE"> source: openapi: ../openapi.json + inline: true ActionAttemptThirtyFour: properties: action_attempt_id: @@ -5456,12 +5680,14 @@ types: result: optional source: openapi: ../openapi.json + inline: true ActionAttemptThirtyFiveError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptThirtyFive: properties: action_attempt_id: @@ -5481,6 +5707,7 @@ types: error: ActionAttemptThirtyFiveError source: openapi: ../openapi.json + inline: true ActionAttemptThirtySix: properties: action_attempt_id: @@ -5500,6 +5727,7 @@ types: action_type: literal<"CREATE_NOISE_THRESHOLD"> source: openapi: ../openapi.json + inline: true ActionAttemptThirtySeven: properties: action_attempt_id: @@ -5519,12 +5747,14 @@ types: result: optional source: openapi: ../openapi.json + inline: true ActionAttemptThirtyEightError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptThirtyEight: properties: action_attempt_id: @@ -5544,6 +5774,7 @@ types: error: ActionAttemptThirtyEightError source: openapi: ../openapi.json + inline: true ActionAttemptThirtyNine: properties: action_attempt_id: @@ -5563,6 +5794,7 @@ types: action_type: literal<"DELETE_NOISE_THRESHOLD"> source: openapi: ../openapi.json + inline: true ActionAttemptForty: properties: action_attempt_id: @@ -5582,12 +5814,14 @@ types: result: optional source: openapi: ../openapi.json + inline: true ActionAttemptFortyOneError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptFortyOne: properties: action_attempt_id: @@ -5607,6 +5841,7 @@ types: error: ActionAttemptFortyOneError source: openapi: ../openapi.json + inline: true ActionAttemptFortyTwo: properties: action_attempt_id: @@ -5626,6 +5861,7 @@ types: action_type: literal<"UPDATE_NOISE_THRESHOLD"> source: openapi: ../openapi.json + inline: true ActionAttemptFortyThree: properties: action_attempt_id: @@ -5645,12 +5881,14 @@ types: result: optional source: openapi: ../openapi.json + inline: true ActionAttemptActionAttemptIdError: properties: type: string message: string source: openapi: ../openapi.json + inline: true ActionAttemptActionAttemptId: properties: action_attempt_id: @@ -5670,6 +5908,7 @@ types: error: ActionAttemptActionAttemptIdError source: openapi: ../openapi.json + inline: true ActionAttempt: discriminated: false union: @@ -5818,6 +6057,7 @@ types: - boolean source: openapi: ../openapi.json + inline: true ConnectWebview: properties: connect_webview_id: @@ -5882,6 +6122,7 @@ types: exclusive: optional source: openapi: ../openapi.json + inline: true ConnectedAccountCustomMetadataValue: discriminated: false union: @@ -5889,6 +6130,7 @@ types: - boolean source: openapi: ../openapi.json + inline: true ConnectedAccount: properties: connected_account_id: @@ -5963,6 +6205,7 @@ types: max: 1 source: openapi: ../openapi.json + inline: true DevicePropertiesAccessoryKeypad: docs: Represents the accessory keypad state. properties: @@ -5974,6 +6217,7 @@ types: docs: Indicates if the keypad battery properties. source: openapi: ../openapi.json + inline: true DevicePropertiesAppearance: properties: name: @@ -5983,6 +6227,7 @@ types: settable through Seam. source: openapi: ../openapi.json + inline: true DevicePropertiesModel: properties: can_connect_accessory_keypad: @@ -6015,6 +6260,7 @@ types: source: openapi: ../openapi.json + inline: true DevicePropertiesBatteryStatus: enum: - critical @@ -6041,18 +6287,21 @@ types: status: DevicePropertiesBatteryStatus source: openapi: ../openapi.json + inline: true DevicePropertiesAssaAbloyCredentialServiceMetadataEndpointsItem: properties: endpoint_id: string is_active: boolean source: openapi: ../openapi.json + inline: true DevicePropertiesAssaAbloyCredentialServiceMetadata: properties: has_active_endpoint: boolean endpoints: list source: openapi: ../openapi.json + inline: true DevicePropertiesAugustMetadata: properties: lock_id: string @@ -6064,6 +6313,7 @@ types: house_id: optional source: openapi: ../openapi.json + inline: true DevicePropertiesAvigilonAltaMetadata: properties: entry_name: string @@ -6075,6 +6325,7 @@ types: entry_relays_total_count: double source: openapi: ../openapi.json + inline: true DevicePropertiesSchlageMetadata: properties: device_id: string @@ -6083,6 +6334,7 @@ types: model: optional source: openapi: ../openapi.json + inline: true DevicePropertiesSmartthingsMetadata: properties: device_id: string @@ -6091,6 +6343,7 @@ types: location_id: optional source: openapi: ../openapi.json + inline: true DevicePropertiesLocklyMetadata: properties: device_id: string @@ -6098,6 +6351,7 @@ types: model: optional source: openapi: ../openapi.json + inline: true DevicePropertiesNukiMetadata: properties: device_id: string @@ -6107,6 +6361,7 @@ types: keypad_2_paired: optional source: openapi: ../openapi.json + inline: true DevicePropertiesKwiksetMetadata: properties: device_id: string @@ -6114,6 +6369,7 @@ types: model_number: string source: openapi: ../openapi.json + inline: true DevicePropertiesSaltoMetadata: properties: lock_id: string @@ -6124,17 +6380,20 @@ types: model: optional source: openapi: ../openapi.json + inline: true DevicePropertiesGenieMetadata: properties: device_name: string door_name: string source: openapi: ../openapi.json + inline: true DevicePropertiesBrivoMetadata: properties: device_name: string source: openapi: ../openapi.json + inline: true DevicePropertiesIglooMetadata: properties: device_id: string @@ -6142,6 +6401,7 @@ types: model: optional source: openapi: ../openapi.json + inline: true DevicePropertiesNoiseawareMetadataDeviceModel: enum: - indoor @@ -6157,36 +6417,42 @@ types: device_id: string source: openapi: ../openapi.json + inline: true DevicePropertiesMinutMetadataLatestSensorValuesTemperature: properties: time: string value: double source: openapi: ../openapi.json + inline: true DevicePropertiesMinutMetadataLatestSensorValuesSound: properties: time: string value: double source: openapi: ../openapi.json + inline: true DevicePropertiesMinutMetadataLatestSensorValuesHumidity: properties: time: string value: double source: openapi: ../openapi.json + inline: true DevicePropertiesMinutMetadataLatestSensorValuesPressure: properties: time: string value: double source: openapi: ../openapi.json + inline: true DevicePropertiesMinutMetadataLatestSensorValuesAccelerometerZ: properties: time: string value: double source: openapi: ../openapi.json + inline: true DevicePropertiesMinutMetadataLatestSensorValues: properties: temperature: DevicePropertiesMinutMetadataLatestSensorValuesTemperature @@ -6196,6 +6462,7 @@ types: accelerometer_z: DevicePropertiesMinutMetadataLatestSensorValuesAccelerometerZ source: openapi: ../openapi.json + inline: true DevicePropertiesMinutMetadata: properties: device_id: string @@ -6203,6 +6470,7 @@ types: latest_sensor_values: DevicePropertiesMinutMetadataLatestSensorValues source: openapi: ../openapi.json + inline: true DevicePropertiesFourSuitesMetadata: properties: device_id: double @@ -6210,12 +6478,14 @@ types: reclose_delay_in_seconds: double source: openapi: ../openapi.json + inline: true DevicePropertiesTwoNMetadata: properties: device_id: double device_name: string source: openapi: ../openapi.json + inline: true DevicePropertiesControlbywebMetadata: properties: device_id: string @@ -6223,6 +6493,7 @@ types: relay_name: optional source: openapi: ../openapi.json + inline: true DevicePropertiesTtlockMetadata: properties: lock_id: double @@ -6230,6 +6501,7 @@ types: feature_value: string source: openapi: ../openapi.json + inline: true DevicePropertiesSeamBridgeMetadataUnlockMethod: enum: - bridge @@ -6243,6 +6515,7 @@ types: name: string source: openapi: ../openapi.json + inline: true DevicePropertiesIgloohomeMetadata: properties: device_id: string @@ -6252,6 +6525,7 @@ types: keypad_id: optional source: openapi: ../openapi.json + inline: true DevicePropertiesNestMetadata: properties: nest_device_id: string @@ -6259,18 +6533,21 @@ types: custom_name: string source: openapi: ../openapi.json + inline: true DevicePropertiesEcobeeMetadata: properties: ecobee_device_id: string device_name: string source: openapi: ../openapi.json + inline: true DevicePropertiesHoneywellResideoMetadata: properties: honeywell_resideo_device_id: string device_name: string source: openapi: ../openapi.json + inline: true DevicePropertiesHubitatMetadata: properties: device_id: string @@ -6278,6 +6555,7 @@ types: device_label: string source: openapi: ../openapi.json + inline: true DevicePropertiesDormakabaOracodeMetadataPredefinedTimeSlotsItem: properties: name: string @@ -6295,6 +6573,7 @@ types: format: uuid source: openapi: ../openapi.json + inline: true DevicePropertiesDormakabaOracodeMetadata: properties: door_id: double @@ -6308,6 +6587,7 @@ types: optional> source: openapi: ../openapi.json + inline: true DevicePropertiesWyzeMetadata: properties: device_id: string @@ -6320,6 +6600,7 @@ types: locker_status_hardlock: optional source: openapi: ../openapi.json + inline: true DevicePropertiesTedeeMetadata: properties: device_id: double @@ -6331,6 +6612,7 @@ types: keypad_id: optional source: openapi: ../openapi.json + inline: true DevicePropertiesCodeConstraintsItemZeroConstraintType: enum: - no_zeros @@ -6349,6 +6631,7 @@ types: constraint_type: DevicePropertiesCodeConstraintsItemZeroConstraintType source: openapi: ../openapi.json + inline: true DevicePropertiesCodeConstraintsItemMaxLengthConstraintType: enum: - name_length @@ -6362,6 +6645,7 @@ types: max_length: optional source: openapi: ../openapi.json + inline: true DevicePropertiesCodeConstraintsItem: discriminated: false union: @@ -6369,11 +6653,13 @@ types: - DevicePropertiesCodeConstraintsItemMaxLength source: openapi: ../openapi.json + inline: true DevicePropertiesKeypadBattery: properties: level: double source: openapi: ../openapi.json + inline: true DeviceProperties: docs: Properties of the device. properties: @@ -6502,6 +6788,7 @@ types: door_open: optional source: openapi: ../openapi.json + inline: true DeviceLocation: docs: Location information for the device. properties: @@ -6513,18 +6800,21 @@ types: docs: Time zone of the device location. source: openapi: ../openapi.json + inline: true DeviceErrorsItem: properties: error_code: string message: string source: openapi: ../openapi.json + inline: true DeviceWarningsItem: properties: warning_code: string message: string source: openapi: ../openapi.json + inline: true DeviceCustomMetadataValue: discriminated: false union: @@ -6532,6 +6822,7 @@ types: - boolean source: openapi: ../openapi.json + inline: true Device: properties: device_id: @@ -6669,12 +6960,14 @@ types: message: string source: openapi: ../openapi.json + inline: true UnmanagedDeviceWarningsItem: properties: warning_code: string message: string source: openapi: ../openapi.json + inline: true UnmanagedDevicePropertiesAccessoryKeypadBattery: docs: Indicates if the keypad battery properties. properties: @@ -6685,6 +6978,7 @@ types: max: 1 source: openapi: ../openapi.json + inline: true UnmanagedDevicePropertiesAccessoryKeypad: docs: Represents the accessory keypad state. properties: @@ -6696,6 +6990,7 @@ types: docs: Indicates if the keypad battery properties. source: openapi: ../openapi.json + inline: true UnmanagedDevicePropertiesBatteryStatus: enum: - critical @@ -6722,6 +7017,7 @@ types: status: UnmanagedDevicePropertiesBatteryStatus source: openapi: ../openapi.json + inline: true UnmanagedDevicePropertiesModel: properties: can_connect_accessory_keypad: @@ -6754,6 +7050,7 @@ types: source: openapi: ../openapi.json + inline: true UnmanagedDeviceProperties: properties: accessory_keypad: @@ -6814,6 +7111,7 @@ types: model: UnmanagedDevicePropertiesModel source: openapi: ../openapi.json + inline: true UnmanagedDevice: properties: device_id: @@ -7074,12 +7372,14 @@ types: message: string source: openapi: ../openapi.json + inline: true AcsSystemErrorsItemVisionlineInstanceUnreachable: properties: created_at: datetime message: string source: openapi: ../openapi.json + inline: true AcsSystemErrorsItem: discriminant: error_code base-properties: {} @@ -7092,6 +7392,7 @@ types: properties: {} source: openapi: ../openapi.json + inline: true AcsSystem: properties: acs_system_id: @@ -7207,6 +7508,7 @@ types: ends_at: datetime source: openapi: ../openapi.json + inline: true AcsUser: properties: acs_user_id: @@ -7259,6 +7561,7 @@ types: message: string source: openapi: ../openapi.json + inline: true AcsEntranceLatchMetadata: properties: accessibility_type: string @@ -7267,6 +7570,7 @@ types: is_connected: boolean source: openapi: ../openapi.json + inline: true AcsEntranceVisionlineMetadataDoorCategory: enum: - entrance @@ -7291,6 +7595,7 @@ types: visionline_door_profile_type: AcsEntranceVisionlineMetadataProfilesItemVisionlineDoorProfileType source: openapi: ../openapi.json + inline: true AcsEntranceVisionlineMetadata: properties: door_name: string @@ -7298,6 +7603,7 @@ types: profiles: optional> source: openapi: ../openapi.json + inline: true AcsEntrance: properties: acs_system_id: @@ -7380,12 +7686,14 @@ types: message: string source: openapi: ../openapi.json + inline: true AcsCredentialWarningsItem: properties: warning_code: string message: string source: openapi: ../openapi.json + inline: true AcsCredentialVisionlineMetadataCardFunctionType: enum: - guest @@ -7400,6 +7708,7 @@ types: common_acs_entrance_ids: optional> source: openapi: ../openapi.json + inline: true AcsCredential: properties: acs_credential_id: @@ -7488,17 +7797,20 @@ types: is_active: boolean source: openapi: ../openapi.json + inline: true PhonePropertiesAssaAbloyCredentialServiceMetadata: properties: has_active_endpoint: boolean endpoints: list source: openapi: ../openapi.json + inline: true PhoneProperties: properties: assa_abloy_credential_service_metadata: optional source: openapi: ../openapi.json + inline: true PhoneLocation: docs: Location information for the device. properties: @@ -7510,18 +7822,21 @@ types: docs: Time zone of the device location. source: openapi: ../openapi.json + inline: true PhoneErrorsItem: properties: error_code: string message: string source: openapi: ../openapi.json + inline: true PhoneWarningsItem: properties: warning_code: string message: string source: openapi: ../openapi.json + inline: true PhoneCustomMetadataValue: discriminated: false union: @@ -7529,6 +7844,7 @@ types: - boolean source: openapi: ../openapi.json + inline: true Phone: properties: device_id: @@ -8423,6 +8739,7 @@ types: }, "AccessCodesCreateMultipleResponse": { "docs": undefined, + "inline": undefined, "properties": { "access_codes": "list", "ok": "boolean", @@ -8457,6 +8774,7 @@ types: }, "AccessCodesCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "access_code": "root.AccessCode", "action_attempt": "root.ActionAttempt", @@ -8468,6 +8786,7 @@ types: }, "AccessCodesDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -8478,6 +8797,7 @@ types: }, "AccessCodesGenerateCodeResponse": { "docs": undefined, + "inline": undefined, "properties": { "generated_code": "root.AccessCode", "ok": "boolean", @@ -8488,6 +8808,7 @@ types: }, "AccessCodesGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "access_code": "root.AccessCode", "ok": "boolean", @@ -8498,6 +8819,7 @@ types: }, "AccessCodesListResponse": { "docs": undefined, + "inline": undefined, "properties": { "access_codes": "list", "ok": "boolean", @@ -8508,6 +8830,7 @@ types: }, "AccessCodesPullBackupAccessCodeResponse": { "docs": undefined, + "inline": undefined, "properties": { "backup_access_code": "root.AccessCode", "ok": "boolean", @@ -8551,6 +8874,7 @@ types: }, "AccessCodesUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -9259,6 +9583,7 @@ service: "types": { "SimulateCreateUnmanagedAccessCodeResponse": { "docs": undefined, + "inline": undefined, "properties": { "access_code": "root.UnmanagedAccessCode", "ok": "boolean", @@ -9684,6 +10009,7 @@ service: "types": { "UnmanagedConvertToManagedResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -9693,6 +10019,7 @@ service: }, "UnmanagedDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -9703,6 +10030,7 @@ service: }, "UnmanagedGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "access_code": "root.UnmanagedAccessCode", "ok": "boolean", @@ -9713,6 +10041,7 @@ service: }, "UnmanagedListResponse": { "docs": undefined, + "inline": undefined, "properties": { "access_codes": "list", "ok": "boolean", @@ -9723,6 +10052,7 @@ service: }, "UnmanagedUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -10322,6 +10652,7 @@ service: "types": { "AccessGroupsAddUserResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -10331,6 +10662,7 @@ service: }, "AccessGroupsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_access_group": "root.AcsAccessGroup", "ok": "boolean", @@ -10341,6 +10673,7 @@ service: }, "AccessGroupsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_access_groups": "list", "ok": "boolean", @@ -10351,6 +10684,7 @@ service: }, "AccessGroupsListUsersResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_users": "list", "ok": "boolean", @@ -10361,6 +10695,7 @@ service: }, "AccessGroupsRemoveUserResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -10689,6 +11024,7 @@ service: "types": { "CredentialPoolsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_credential_pools": "list", "ok": "boolean", @@ -10859,6 +11195,7 @@ service: "types": { "CredentialProvisioningAutomationsLaunchResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_credential_provisioning_automation": "root.AcsCredentialProvisioningAutomation", "ok": "boolean", @@ -11680,6 +12017,7 @@ service: "types": { "CredentialsAssignResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_credential": "root.AcsCredential", "ok": "boolean", @@ -11700,6 +12038,7 @@ service: }, "CredentialsCreateRequestVisionlineMetadata": { "docs": undefined, + "inline": true, "properties": { "assa_abloy_credential_service_mobile_endpoint_id": { "type": "optional", @@ -11751,6 +12090,7 @@ service: }, "CredentialsCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_credential": "root.AcsCredential", "ok": "boolean", @@ -11761,6 +12101,7 @@ service: }, "CredentialsDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -11770,6 +12111,7 @@ service: }, "CredentialsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_credential": "root.AcsCredential", "ok": "boolean", @@ -11780,6 +12122,7 @@ service: }, "CredentialsListAccessibleEntrancesResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_entrances": "list", "ok": "boolean", @@ -11790,6 +12133,7 @@ service: }, "CredentialsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_credentials": "list", "ok": "boolean", @@ -11800,6 +12144,7 @@ service: }, "CredentialsUnassignResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_credential": "root.AcsCredential", "ok": "boolean", @@ -11810,6 +12155,7 @@ service: }, "CredentialsUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_credential": "root.AcsCredential", "ok": "boolean", @@ -11871,6 +12217,7 @@ types: joiner_acs_credential_ids: optional> source: openapi: ../openapi.json + inline: true CredentialsCreateResponse: properties: acs_credential: root.AcsCredential @@ -12706,6 +13053,7 @@ service: "types": { "EntrancesGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_entrance": "root.AcsEntrance", "ok": "boolean", @@ -12716,6 +13064,7 @@ service: }, "EntrancesGrantAccessResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -12725,6 +13074,7 @@ service: }, "EntrancesListCredentialsWithAccessResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_credentials": "list", "ok": "boolean", @@ -12735,6 +13085,7 @@ service: }, "EntrancesListResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_entrances": "list", "ok": "boolean", @@ -13227,6 +13578,7 @@ service: "types": { "SystemsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_system": "root.AcsSystem", "ok": "boolean", @@ -13237,6 +13589,7 @@ service: }, "SystemsListCompatibleCredentialManagerAcsSystemsResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_systems": "list", "ok": "boolean", @@ -13247,6 +13600,7 @@ service: }, "SystemsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_systems": "list", "ok": "boolean", @@ -14219,6 +14573,7 @@ service: "types": { "UsersAddToAccessGroupResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -14228,6 +14583,7 @@ service: }, "UsersCreateRequestAccessSchedule": { "docs": undefined, + "inline": true, "properties": { "ends_at": "datetime", "starts_at": "datetime", @@ -14238,6 +14594,7 @@ service: }, "UsersCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_user": "root.AcsUser", "ok": "boolean", @@ -14248,6 +14605,7 @@ service: }, "UsersDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -14257,6 +14615,7 @@ service: }, "UsersGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_user": "root.AcsUser", "ok": "boolean", @@ -14267,6 +14626,7 @@ service: }, "UsersListAccessibleEntrancesResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_entrances": "list", "ok": "boolean", @@ -14277,6 +14637,7 @@ service: }, "UsersListResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_users": "list", "ok": "boolean", @@ -14287,6 +14648,7 @@ service: }, "UsersRemoveFromAccessGroupResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -14296,6 +14658,7 @@ service: }, "UsersRevokeAccessToAllEntrancesResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -14305,6 +14668,7 @@ service: }, "UsersSuspendResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -14314,6 +14678,7 @@ service: }, "UsersUnsuspendResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -14323,6 +14688,7 @@ service: }, "UsersUpdateRequestAccessSchedule": { "docs": undefined, + "inline": true, "properties": { "ends_at": "datetime", "starts_at": "datetime", @@ -14333,6 +14699,7 @@ service: }, "UsersUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -14354,6 +14721,7 @@ service: ends_at: datetime source: openapi: ../openapi.json + inline: true UsersCreateResponse: properties: acs_user: root.AcsUser @@ -14409,6 +14777,7 @@ service: ends_at: datetime source: openapi: ../openapi.json + inline: true UsersUpdateResponse: properties: ok: boolean @@ -15005,6 +15374,7 @@ service: "types": { "ActionAttemptsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -15015,6 +15385,7 @@ service: }, "ActionAttemptsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempts": "list", "ok": "boolean", @@ -15565,6 +15936,7 @@ service: "types": { "ClientSessionsCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "client_session": "root.ClientSession", "ok": "boolean", @@ -15575,6 +15947,7 @@ service: }, "ClientSessionsDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -15584,6 +15957,7 @@ service: }, "ClientSessionsGetOrCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "client_session": "root.ClientSession", "ok": "boolean", @@ -15594,6 +15968,7 @@ service: }, "ClientSessionsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "client_session": "root.ClientSession", "ok": "boolean", @@ -15604,6 +15979,7 @@ service: }, "ClientSessionsGrantAccessResponse": { "docs": undefined, + "inline": undefined, "properties": { "client_session": "root.ClientSession", "ok": "boolean", @@ -15614,6 +15990,7 @@ service: }, "ClientSessionsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "client_sessions": "list", "ok": "boolean", @@ -15624,6 +16001,7 @@ service: }, "ClientSessionsRevokeResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -16310,6 +16688,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -16352,6 +16731,7 @@ service: }, "ConnectWebviewsCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "connect_webview": "root.ConnectWebview", "ok": "boolean", @@ -16362,6 +16742,7 @@ service: }, "ConnectWebviewsDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -16371,6 +16752,7 @@ service: }, "ConnectWebviewsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "connect_webview": "root.ConnectWebview", "ok": "boolean", @@ -16383,6 +16765,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -16393,6 +16776,7 @@ service: }, "ConnectWebviewsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "connect_webviews": "list", "ok": "boolean", @@ -16475,6 +16859,7 @@ service: - optional source: openapi: ../openapi.json + inline: true ConnectWebviewsCreateResponse: properties: connect_webview: root.ConnectWebview @@ -16499,6 +16884,7 @@ service: - boolean source: openapi: ../openapi.json + inline: true ConnectWebviewsListResponse: properties: connect_webviews: list @@ -16986,6 +17372,7 @@ service: "types": { "ConnectedAccountsDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -16997,6 +17384,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -17007,6 +17395,7 @@ service: }, "ConnectedAccountsGetRequestConnectedAccountId": { "docs": undefined, + "inline": true, "properties": { "connected_account_id": { "type": "string", @@ -17024,6 +17413,7 @@ service: }, "ConnectedAccountsGetRequestEmail": { "docs": undefined, + "inline": true, "properties": { "email": { "type": "string", @@ -17041,6 +17431,7 @@ service: }, "ConnectedAccountsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "connected_account": "root.ConnectedAccount", "ok": "boolean", @@ -17053,6 +17444,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -17063,6 +17455,7 @@ service: }, "ConnectedAccountsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "connected_accounts": "list", "ok": "boolean", @@ -17075,6 +17468,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -17094,6 +17488,7 @@ service: }, "ConnectedAccountsUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "connected_account": "root.ConnectedAccount", "ok": "boolean", @@ -17118,6 +17513,7 @@ service: format: uuid source: openapi: ../openapi.json + inline: true ConnectedAccountsGetRequestEmail: properties: email: @@ -17126,6 +17522,7 @@ service: format: email source: openapi: ../openapi.json + inline: true ConnectedAccountsGetRequest: discriminated: false union: @@ -17146,6 +17543,7 @@ service: - boolean source: openapi: ../openapi.json + inline: true ConnectedAccountsListResponse: properties: connected_accounts: list @@ -17162,6 +17560,7 @@ service: - optional source: openapi: ../openapi.json + inline: true ConnectedAccountsUpdateResponse: properties: connected_account: root.ConnectedAccount @@ -17949,6 +18348,7 @@ service: "types": { "DevicesDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -17958,6 +18358,7 @@ service: }, "DevicesGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "device": "root.Device", "ok": "boolean", @@ -17980,6 +18381,7 @@ service: }, "DevicesListDeviceProvidersResponse": { "docs": undefined, + "inline": undefined, "properties": { "device_providers": "list", "ok": "boolean", @@ -17992,6 +18394,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -18151,6 +18554,7 @@ service: }, "DevicesListResponse": { "docs": undefined, + "inline": undefined, "properties": { "devices": "list", "ok": "boolean", @@ -18163,6 +18567,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -18182,6 +18587,7 @@ service: }, "DevicesUpdateRequestProperties": { "docs": undefined, + "inline": true, "properties": { "name": "optional", }, @@ -18191,6 +18597,7 @@ service: }, "DevicesUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -18331,6 +18738,7 @@ service: - boolean source: openapi: ../openapi.json + inline: true DevicesListRequestIncludeIfItem: enum: - can_remotely_unlock @@ -18379,6 +18787,7 @@ service: name: optional source: openapi: ../openapi.json + inline: true DevicesUpdateRequestCustomMetadataValue: discriminated: false union: @@ -18389,6 +18798,7 @@ service: - optional source: openapi: ../openapi.json + inline: true DevicesUpdateResponse: properties: ok: boolean @@ -18974,6 +19384,7 @@ service: "types": { "SimulateConnectResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -18983,6 +19394,7 @@ service: }, "SimulateDisconnectResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -18992,6 +19404,7 @@ service: }, "SimulateRemoveResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -19398,6 +19811,7 @@ service: "types": { "UnmanagedGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "device": "root.UnmanagedDevice", "ok": "boolean", @@ -19410,6 +19824,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -19569,6 +19984,7 @@ service: }, "UnmanagedListResponse": { "docs": undefined, + "inline": undefined, "properties": { "devices": "list", "ok": "boolean", @@ -19579,6 +19995,7 @@ service: }, "UnmanagedUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -19716,6 +20133,7 @@ types: - boolean source: openapi: ../openapi.json + inline: true UnmanagedListRequestIncludeIfItem: enum: - can_remotely_unlock @@ -20116,6 +20534,7 @@ service: "types": { "EventsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "event": "optional", "message": "optional", @@ -20129,6 +20548,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -20617,6 +21037,7 @@ service: }, "EventsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "events": "list", "ok": "boolean", @@ -20644,6 +21065,7 @@ types: - datetime source: openapi: ../openapi.json + inline: true EventsListRequestEventType: enum: - value: device.accessory_keypad_connected @@ -21874,6 +22296,7 @@ service: "types": { "LocksGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "device": "root.Device", "lock": "root.Device", @@ -21887,6 +22310,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -22046,6 +22470,7 @@ service: }, "LocksListResponse": { "docs": undefined, + "inline": undefined, "properties": { "devices": "list", "locks": "list", @@ -22057,6 +22482,7 @@ service: }, "LocksLockDoorResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -22067,6 +22493,7 @@ service: }, "LocksUnlockDoorResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -22206,6 +22633,7 @@ types: - boolean source: openapi: ../openapi.json + inline: true LocksListRequestIncludeIfItem: enum: - can_remotely_unlock @@ -22988,6 +23416,7 @@ service: "types": { "NetworksGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "network": "root.Network", "ok": "boolean", @@ -22998,6 +23427,7 @@ service: }, "NetworksListResponse": { "docs": undefined, + "inline": undefined, "properties": { "networks": "list", "ok": "boolean", @@ -23465,6 +23895,7 @@ service: "types": { "NoiseThresholdsCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "noise_threshold": "root.NoiseThreshold", @@ -23476,6 +23907,7 @@ service: }, "NoiseThresholdsDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -23486,6 +23918,7 @@ service: }, "NoiseThresholdsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "noise_threshold": "root.NoiseThreshold", "ok": "boolean", @@ -23496,6 +23929,7 @@ service: }, "NoiseThresholdsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "noise_thresholds": "list", "ok": "boolean", @@ -23506,6 +23940,7 @@ service: }, "NoiseThresholdsUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -23844,6 +24279,7 @@ service: "types": { "SimulateTriggerNoiseThresholdResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -24045,6 +24481,7 @@ service: "types": { "PhonesDeactivateResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -24054,6 +24491,7 @@ service: }, "PhonesListResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "phones": "list", @@ -24287,6 +24725,7 @@ service: "types": { "SimulateCreateSandboxPhoneRequestAssaAbloyMetadata": { "docs": undefined, + "inline": true, "properties": { "application_version": { "default": "1.0.0", @@ -24319,6 +24758,7 @@ service: }, "SimulateCreateSandboxPhoneRequestPhoneMetadata": { "docs": undefined, + "inline": true, "properties": { "device_manufacturer": { "default": "Samsung", @@ -24353,6 +24793,7 @@ service: }, "SimulateCreateSandboxPhoneResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "phone": "root.Phone", @@ -24388,6 +24829,7 @@ service: default: Samsung Galaxy S10 source: openapi: ../openapi.json + inline: true SimulateCreateSandboxPhoneRequestAssaAbloyMetadata: properties: ble_capability: @@ -24410,6 +24852,7 @@ service: default: 1 source: openapi: ../openapi.json + inline: true SimulateCreateSandboxPhoneResponse: properties: phone: root.Phone @@ -25314,6 +25757,7 @@ service: "types": { "ThermostatsCoolResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -25324,6 +25768,7 @@ service: }, "ThermostatsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "thermostat": "root.Device", @@ -25334,6 +25779,7 @@ service: }, "ThermostatsHeatCoolResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -25344,6 +25790,7 @@ service: }, "ThermostatsHeatResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -25356,6 +25803,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.json", }, @@ -25515,6 +25963,7 @@ service: }, "ThermostatsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "thermostats": "list", @@ -25525,6 +25974,7 @@ service: }, "ThermostatsOffResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -25553,6 +26003,7 @@ service: }, "ThermostatsSetFanModeResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", @@ -25563,6 +26014,7 @@ service: }, "ThermostatsUpdateRequestDefaultClimateSetting": { "docs": undefined, + "inline": true, "properties": { "automatic_cooling_enabled": "optional", "automatic_heating_enabled": "optional", @@ -25590,6 +26042,7 @@ service: }, "ThermostatsUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -25745,6 +26198,7 @@ types: - boolean source: openapi: ../openapi.json + inline: true ThermostatsListRequestIncludeIfItem: enum: - can_remotely_unlock @@ -25817,6 +26271,7 @@ types: manual_override_allowed: optional source: openapi: ../openapi.json + inline: true ThermostatsUpdateResponse: properties: ok: boolean @@ -26761,6 +27216,7 @@ service: }, "ClimateSettingSchedulesCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "climate_setting_schedule": "root.ClimateSettingSchedule", "ok": "boolean", @@ -26771,6 +27227,7 @@ service: }, "ClimateSettingSchedulesDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -26780,6 +27237,7 @@ service: }, "ClimateSettingSchedulesGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "climate_setting_schedule": "root.ClimateSettingSchedule", "ok": "boolean", @@ -26790,6 +27248,7 @@ service: }, "ClimateSettingSchedulesListResponse": { "docs": undefined, + "inline": undefined, "properties": { "climate_setting_schedules": "list", "ok": "boolean", @@ -26811,6 +27270,7 @@ service: }, "ClimateSettingSchedulesUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "climate_setting_schedule": "root.ClimateSettingSchedule", "ok": "boolean", @@ -28006,6 +28466,7 @@ service: "types": { "UserIdentitiesAddAcsUserResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -28015,6 +28476,7 @@ service: }, "UserIdentitiesCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "user_identity": "root.UserIdentity", @@ -28025,6 +28487,7 @@ service: }, "UserIdentitiesDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -28036,6 +28499,7 @@ service: "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -28046,6 +28510,7 @@ service: }, "UserIdentitiesGetRequestUserIdentityId": { "docs": undefined, + "inline": true, "properties": { "user_identity_id": { "type": "string", @@ -28063,6 +28528,7 @@ service: }, "UserIdentitiesGetRequestUserIdentityKey": { "docs": undefined, + "inline": true, "properties": { "user_identity_key": "string", }, @@ -28072,6 +28538,7 @@ service: }, "UserIdentitiesGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "user_identity": "root.UserIdentity", @@ -28082,6 +28549,7 @@ service: }, "UserIdentitiesGrantAccessToDeviceResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -28091,6 +28559,7 @@ service: }, "UserIdentitiesListAccessibleDevicesResponse": { "docs": undefined, + "inline": undefined, "properties": { "accessible_devices": { "docs": " @@ -28109,6 +28578,7 @@ service: }, "UserIdentitiesListAcsSystemsResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_systems": "list", "ok": "boolean", @@ -28119,6 +28589,7 @@ service: }, "UserIdentitiesListAcsUsersResponse": { "docs": undefined, + "inline": undefined, "properties": { "acs_users": "list", "ok": "boolean", @@ -28129,6 +28600,7 @@ service: }, "UserIdentitiesListResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "user_identities": "list", @@ -28139,6 +28611,7 @@ service: }, "UserIdentitiesRemoveAcsUserResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -28148,6 +28621,7 @@ service: }, "UserIdentitiesRevokeAccessToDeviceResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -28157,6 +28631,7 @@ service: }, "UserIdentitiesUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -28191,11 +28666,13 @@ service: format: uuid source: openapi: ../openapi.json + inline: true UserIdentitiesGetRequestUserIdentityKey: properties: user_identity_key: string source: openapi: ../openapi.json + inline: true UserIdentitiesGetRequest: discriminated: false union: @@ -29064,6 +29541,7 @@ service: "types": { "EnrollmentAutomationsDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -29073,6 +29551,7 @@ service: }, "EnrollmentAutomationsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "enrollment_automation": "root.EnrollmentAutomation", "ok": "boolean", @@ -29083,6 +29562,7 @@ service: }, "EnrollmentAutomationsLaunchResponse": { "docs": undefined, + "inline": undefined, "properties": { "enrollment_automation": "EnrollmentAutomationsLaunchResponseEnrollmentAutomation", "ok": "boolean", @@ -29093,6 +29573,7 @@ service: }, "EnrollmentAutomationsLaunchResponseEnrollmentAutomation": { "docs": undefined, + "inline": true, "properties": { "acs_credential_provisioning_automation_id": { "type": "string", @@ -29147,6 +29628,7 @@ service: }, "EnrollmentAutomationsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "enrollment_automations": "list", "ok": "boolean", @@ -29194,6 +29676,7 @@ service: format: uuid source: openapi: ../openapi.json + inline: true EnrollmentAutomationsLaunchResponse: properties: enrollment_automation: EnrollmentAutomationsLaunchResponseEnrollmentAutomation @@ -29624,6 +30107,7 @@ service: "types": { "WebhooksCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "webhook": "root.Webhook", @@ -29634,6 +30118,7 @@ service: }, "WebhooksDeleteResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -29643,6 +30128,7 @@ service: }, "WebhooksGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "webhook": "root.Webhook", @@ -29653,6 +30139,7 @@ service: }, "WebhooksListResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "webhooks": "list", @@ -29663,6 +30150,7 @@ service: }, "WebhooksUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", }, @@ -30059,6 +30547,7 @@ service: }, "WorkspacesCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "workspace": "root.Workspace", @@ -30069,6 +30558,7 @@ service: }, "WorkspacesGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "workspace": "root.Workspace", @@ -30079,6 +30569,7 @@ service: }, "WorkspacesListResponse": { "docs": undefined, + "inline": undefined, "properties": { "ok": "boolean", "workspaces": "list", @@ -30089,6 +30580,7 @@ service: }, "WorkspacesResetSandboxResponse": { "docs": undefined, + "inline": undefined, "properties": { "action_attempt": "root.ActionAttempt", "ok": "boolean", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/squidex.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/squidex.json index 6530d38ad5b..f7f8a90af90 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/squidex.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/squidex.json @@ -116,6 +116,7 @@ }, "AddFieldDto": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "The name of the field. Must be unique within the schema.", @@ -142,6 +143,7 @@ }, "AlgoliaRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "apiKey": { "docs": "The API key to grant access to Squidex.", @@ -188,6 +190,7 @@ }, "AllContentsByPostDto": { "docs": undefined, + "inline": undefined, "properties": { "ids": { "docs": "The list of ids to query.", @@ -224,6 +227,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "canAccessApi": { "availability": "deprecated", @@ -294,6 +298,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "englishName": { "docs": "The english name of the language.", @@ -325,6 +330,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The languages.", @@ -340,6 +346,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "editors": { "docs": "The configured UI editors.", @@ -368,6 +375,7 @@ }, "ArrayFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "maxItems": { "docs": "The maximum allowed items for the field value.", @@ -388,6 +396,7 @@ }, "AssetChangedRuleTriggerDto": { "docs": undefined, + "inline": undefined, "properties": { "condition": { "docs": "Javascript condition when to trigger.", @@ -403,6 +412,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "_meta": { "docs": "The metadata.", @@ -513,6 +523,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "folderName": { "docs": "The folder name.", @@ -551,6 +562,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The assets folders.", @@ -571,6 +583,7 @@ }, "AssetMeta": { "docs": undefined, + "inline": undefined, "properties": { "isDuplicate": { "docs": "Indicates whether the asset is a duplicate.", @@ -597,6 +610,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "annotate": { "docs": "The script that is executed when annotating a content.", @@ -652,6 +666,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The assets.", @@ -668,6 +683,7 @@ }, "AssetsFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "allowDuplicates": { "docs": "True, if duplicate values are allowed.", @@ -762,6 +778,7 @@ }, "AssignContributorDto": { "docs": undefined, + "inline": undefined, "properties": { "contributorId": { "docs": "The id or email of the user to add to the app.", @@ -788,6 +805,7 @@ }, "AzureQueueRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "connectionString": { "docs": "The connection string to the storage account.", @@ -823,6 +841,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "handledAssets": { "docs": "The number of handled assets.", @@ -858,6 +877,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The backups.", @@ -880,6 +900,7 @@ }, "BooleanFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "defaultValue": { "docs": "The default value for the field value.", @@ -904,6 +925,7 @@ }, "BulkResultDto": { "docs": undefined, + "inline": undefined, "properties": { "contentId": { "availability": "deprecated", @@ -940,6 +962,7 @@ }, "BulkUpdateAssetsJobDto": { "docs": undefined, + "inline": undefined, "properties": { "expectedVersion": { "docs": "The expected version.", @@ -1003,6 +1026,7 @@ }, "BulkUpdateContentsJobDto": { "docs": undefined, + "inline": undefined, "properties": { "data": { "docs": "The data of the content when type is set to 'Upsert', 'Create', 'Update' or 'Patch.", @@ -1055,6 +1079,7 @@ }, "CallsUsageDtoDto": { "docs": undefined, + "inline": undefined, "properties": { "allowedBytes": { "docs": "The included API traffic.", @@ -1099,6 +1124,7 @@ }, "CallsUsagePerDateDto": { "docs": undefined, + "inline": undefined, "properties": { "averageElapsedMs": { "docs": "The average duration in milliseconds.", @@ -1129,6 +1155,7 @@ }, "ChangePlanDto": { "docs": undefined, + "inline": undefined, "properties": { "planId": { "docs": "The new plan id.", @@ -1150,6 +1177,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "allowAnonymous": { "docs": "True to allow anonymous access without an access token for this client.", @@ -1189,6 +1217,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The clients.", @@ -1201,6 +1230,7 @@ }, "CommentDto": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the comment.", @@ -1235,6 +1265,7 @@ }, "CommentRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "client": { "docs": "An optional client name.", @@ -1257,6 +1288,7 @@ }, "CommentRuleTriggerDto": { "docs": undefined, + "inline": undefined, "properties": { "condition": { "docs": "Javascript condition when to trigger.", @@ -1269,6 +1301,7 @@ }, "CommentsDto": { "docs": undefined, + "inline": undefined, "properties": { "createdComments": { "docs": "The created comments including the updates.", @@ -1293,6 +1326,7 @@ }, "ComponentFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "schemaIds": { "docs": "The ID of the embedded schemas.", @@ -1305,6 +1339,7 @@ }, "ComponentsFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "maxItems": { "docs": "The maximum allowed items for the field value.", @@ -1330,6 +1365,7 @@ "ConfigurePreviewUrlsDto": "map", "ContentChangedRuleTriggerDto": { "docs": undefined, + "inline": undefined, "properties": { "handleAll": { "docs": "Determines whether the trigger should handle all content changes events.", @@ -1354,6 +1390,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "created": { "docs": "The date and time when the content item has been created.", @@ -1439,6 +1476,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The content items.", @@ -1462,6 +1500,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "contributorEmail": { "docs": "The email address.", @@ -1489,6 +1528,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "_meta": { "docs": "The metadata to provide information about this request.", @@ -1509,6 +1549,7 @@ }, "ContributorsMetadata": { "docs": undefined, + "inline": undefined, "properties": { "isInvited": { "docs": "Indicates whether the user has been invited.", @@ -1521,6 +1562,7 @@ }, "CreateContentRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "client": { "docs": "An optional client name.", @@ -1557,6 +1599,7 @@ }, "CreateRuleDto": { "docs": undefined, + "inline": undefined, "properties": { "action": { "docs": "The action properties.", @@ -1573,6 +1616,7 @@ }, "CurrentStorageDto": { "docs": undefined, + "inline": undefined, "properties": { "maxAllowed": { "docs": "The maximum allowed asset size.", @@ -1609,6 +1653,7 @@ }, "DateTimeFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "calculatedDefaultValue": { "docs": "The calculated default value for the field value.", @@ -1645,6 +1690,7 @@ }, "DiscourseRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "apiKey": { "docs": "The api key to authenticate to your discourse server.", @@ -1705,6 +1751,7 @@ }, "EditorDto": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "The name of the editor.", @@ -1721,6 +1768,7 @@ }, "ElasticSearchRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "delete": { "docs": "The condition when to delete the document.", @@ -1765,6 +1813,7 @@ }, "EmailRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "messageBody": { "docs": "The message body.", @@ -1847,6 +1896,7 @@ }, "ErrorDto": { "docs": undefined, + "inline": undefined, "properties": { "details": { "docs": "Detailed error messages.", @@ -1888,6 +1938,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "count": { "docs": "The number of handled events.", @@ -1929,6 +1980,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The event consumers.", @@ -1942,6 +1994,7 @@ "ExposedValues": "map", "FastlyRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "apiKey": { "docs": "The API key to grant access to Squidex.", @@ -1970,6 +2023,7 @@ }, "FeatureDto": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "The name of the feature.", @@ -1986,6 +2040,7 @@ }, "FeaturesDto": { "docs": undefined, + "inline": undefined, "properties": { "features": { "docs": "The latest features.", @@ -2005,6 +2060,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "fieldId": { "docs": "The ID of the field.", @@ -2144,6 +2200,7 @@ }, "FieldRuleDto": { "docs": undefined, + "inline": undefined, "properties": { "action": { "docs": "The action to perform when the condition is met.", @@ -2174,6 +2231,7 @@ }, "GeolocationFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "editor": { "docs": "The editor that is used to manage this field.", @@ -2186,6 +2244,7 @@ }, "HistoryEventDto": { "docs": undefined, + "inline": undefined, "properties": { "actor": { "docs": "The user who called the action.", @@ -2246,6 +2305,7 @@ }, "JsonFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "graphQLSchema": { "docs": "The GraphQL schema.", @@ -2258,6 +2318,7 @@ }, "LanguageDto": { "docs": undefined, + "inline": undefined, "properties": { "englishName": { "docs": "The english name of the language.", @@ -2283,6 +2344,7 @@ "LocalizedValueOfString": "map", "LogDownloadDto": { "docs": undefined, + "inline": undefined, "properties": { "downloadUrl": { "docs": "The url to download the log.", @@ -2295,6 +2357,7 @@ }, "ManualRuleTriggerDto": { "docs": undefined, + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.json", @@ -2302,6 +2365,7 @@ }, "MediumRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "accessToken": { "docs": "The self issued access token.", @@ -2359,6 +2423,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "fieldId": { "docs": "The ID of the field.", @@ -2397,6 +2462,7 @@ }, "NotificationRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "client": { "docs": "An optional client name.", @@ -2445,6 +2511,7 @@ }, "NumberFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "allowedValues": { "docs": "The allowed values for the field value.", @@ -2485,6 +2552,7 @@ }, "OpenSearchRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "delete": { "docs": "The condition when to delete the document.", @@ -2529,6 +2597,7 @@ }, "PatternDto": { "docs": undefined, + "inline": undefined, "properties": { "message": { "docs": "The regex message.", @@ -2549,6 +2618,7 @@ }, "PlanChangedDto": { "docs": undefined, + "inline": undefined, "properties": { "redirectUri": { "docs": "Optional redirect uri.", @@ -2561,6 +2631,7 @@ }, "PlanDto": { "docs": undefined, + "inline": undefined, "properties": { "confirmText": { "docs": "An optional confirm text for the monthly subscription.", @@ -2613,6 +2684,7 @@ }, "PlansDto": { "docs": undefined, + "inline": undefined, "properties": { "currentPlanId": { "docs": "The current plan id.", @@ -2663,6 +2735,7 @@ }, "PrerenderRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "token": { "docs": "The prerender token from your account.", @@ -2692,6 +2765,7 @@ "PropertyPath": "list", "QueryDto": { "docs": undefined, + "inline": undefined, "properties": { "ids": { "docs": "The optional list of ids to query.", @@ -2713,6 +2787,7 @@ }, "QueryJsonDto": { "docs": undefined, + "inline": undefined, "properties": { "filter": "optional", "fullText": "optional", @@ -2741,6 +2816,7 @@ }, "ReferencesFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "allowDuplicates": { "docs": "True, if duplicate values are allowed.", @@ -2785,6 +2861,7 @@ }, "ReferralInfo": { "docs": undefined, + "inline": undefined, "properties": { "code": "string", "condition": "string", @@ -2796,6 +2873,7 @@ }, "ReorderFieldsDto": { "docs": undefined, + "inline": undefined, "properties": { "fieldIds": { "docs": "The field ids in the target order.", @@ -2823,6 +2901,7 @@ }, "Resource": { "docs": undefined, + "inline": undefined, "properties": { "_links": { "docs": "The links.", @@ -2835,6 +2914,7 @@ }, "ResourceLink": { "docs": undefined, + "inline": undefined, "properties": { "href": { "docs": "The link url.", @@ -2870,6 +2950,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": {}, "source": { "openapi": "../openapi.json", @@ -2877,6 +2958,7 @@ }, "RestoreJobDto": { "docs": undefined, + "inline": undefined, "properties": { "log": { "docs": "The status log.", @@ -2914,6 +2996,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "isDefaultRole": { "docs": "Indicates if the role is an builtin default role.", @@ -2949,6 +3032,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The roles.", @@ -2994,6 +3078,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "action": { "docs": "The action properties.", @@ -3055,6 +3140,7 @@ }, "RuleElementDto": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "Describes the action or trigger type.", @@ -3091,6 +3177,7 @@ }, "RuleElementPropertyDto": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "The optional description.", @@ -3130,6 +3217,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "created": { "docs": "The time when the event has been created.", @@ -3177,6 +3265,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The rule events.", @@ -3256,6 +3345,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The rules.", @@ -3272,6 +3362,7 @@ }, "ScheduleJobDto": { "docs": undefined, + "inline": undefined, "properties": { "color": { "docs": "The color of the scheduled status.", @@ -3300,6 +3391,7 @@ }, "SchemaChangedRuleTriggerDto": { "docs": undefined, + "inline": undefined, "properties": { "condition": { "docs": "Javascript condition when to trigger.", @@ -3312,6 +3404,7 @@ }, "SchemaCondition": { "docs": undefined, + "inline": undefined, "properties": { "condition": "optional", "schemaId": "string", @@ -3325,6 +3418,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "category": { "docs": "The name of the category.", @@ -3424,6 +3518,7 @@ }, "SchemaPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "contentEditorUrl": { "docs": "The url to the editor plugin.", @@ -3472,6 +3567,7 @@ }, "SchemaScriptsDto": { "docs": undefined, + "inline": undefined, "properties": { "change": { "docs": "The script that is executed when change a content status.", @@ -3518,6 +3614,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The schemas.", @@ -3530,6 +3627,7 @@ }, "ScriptRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "script": { "docs": "The script to render.", @@ -3551,6 +3649,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "label": { "docs": "An optional label.", @@ -3585,6 +3684,7 @@ }, "SignalRRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "action": { "docs": "* Broadcast = send to all users. @@ -3631,6 +3731,7 @@ }, "SimulatedRuleEventDto": { "docs": undefined, + "inline": undefined, "properties": { "actionData": { "docs": "The name of the action.", @@ -3690,6 +3791,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The simulated rule events.", @@ -3725,6 +3827,7 @@ }, "SlackRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "text": { "docs": "The text that is sent as message to slack.", @@ -3753,6 +3856,7 @@ }, "SortNode": { "docs": undefined, + "inline": undefined, "properties": { "order": "SortOrder", "path": "PropertyPath", @@ -3773,6 +3877,7 @@ }, "StatusInfoDto": { "docs": undefined, + "inline": undefined, "properties": { "color": { "docs": "The color of the status.", @@ -3789,6 +3894,7 @@ }, "StorageUsagePerDateDto": { "docs": undefined, + "inline": undefined, "properties": { "date": { "docs": "The date when the usage was tracked.", @@ -3844,6 +3950,7 @@ }, "StringFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "allowedValues": { "docs": "The allowed values for the field value.", @@ -3939,6 +4046,7 @@ }, "TagsFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "allowedValues": { "docs": "The allowed values for the field value.", @@ -3978,6 +4086,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "created": { "docs": "The timestamp when the team has been created.", @@ -4013,6 +4122,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "details": { "docs": "The details of the template.", @@ -4028,6 +4138,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "description": { "docs": "The description of the template.", @@ -4055,6 +4166,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The event consumers.", @@ -4067,6 +4179,7 @@ }, "TranslationDto": { "docs": undefined, + "inline": undefined, "properties": { "result": { "docs": "The result of the translation.", @@ -4097,6 +4210,7 @@ }, "TweetRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "accessSecret": { "docs": " The generated access secret.", @@ -4135,6 +4249,7 @@ }, "TypesenseRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "apiKey": { "docs": "The api key.", @@ -4185,6 +4300,7 @@ }, "UiFieldPropertiesDto": { "docs": undefined, + "inline": undefined, "properties": { "editor": { "docs": "The editor that is used to manage this field.", @@ -4197,6 +4313,7 @@ }, "UiSettingsDto": { "docs": undefined, + "inline": undefined, "properties": { "canCreateApps": { "docs": "True when the user can create apps.", @@ -4213,6 +4330,7 @@ }, "UpdateFieldDto": { "docs": undefined, + "inline": undefined, "properties": { "properties": { "docs": "The field properties.", @@ -4225,6 +4343,7 @@ }, "UpdateSettingDto": { "docs": undefined, + "inline": undefined, "properties": { "value": "unknown", }, @@ -4234,6 +4353,7 @@ }, "UpsertCommentDto": { "docs": undefined, + "inline": undefined, "properties": { "text": { "docs": "The comment text.", @@ -4262,6 +4382,7 @@ }, "UpsertSchemaDto": { "docs": undefined, + "inline": undefined, "properties": { "category": { "docs": "The category.", @@ -4306,6 +4427,7 @@ }, "UpsertSchemaFieldDto": { "docs": undefined, + "inline": undefined, "properties": { "isDisabled": { "docs": "Defines if the field is disabled.", @@ -4348,6 +4470,7 @@ }, "UpsertSchemaNestedFieldDto": { "docs": undefined, + "inline": undefined, "properties": { "isDisabled": { "docs": "Defines if the field is disabled.", @@ -4382,6 +4505,7 @@ }, "UsageRuleTriggerDto": { "docs": undefined, + "inline": undefined, "properties": { "limit": { "docs": "The number of monthly api calls.", @@ -4408,6 +4532,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "displayName": { "docs": "The display name (usually first name and last name) of the user.", @@ -4436,6 +4561,7 @@ }, "UserProperty": { "docs": undefined, + "inline": undefined, "properties": { "name": { "type": "string", @@ -4465,6 +4591,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "items": { "docs": "The users.", @@ -4494,6 +4621,7 @@ }, "WebhookRuleActionDto": { "docs": undefined, + "inline": undefined, "properties": { "headers": { "docs": "The message headers in the format '[Key]=[Value]', one entry per line.", @@ -4535,6 +4663,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "id": { "docs": "The workflow id.", @@ -4563,6 +4692,7 @@ }, "WorkflowStepDto": { "docs": undefined, + "inline": undefined, "properties": { "color": { "docs": "The optional color.", @@ -4595,6 +4725,7 @@ }, "WorkflowTransitionDto": { "docs": undefined, + "inline": undefined, "properties": { "expression": { "docs": "The optional expression.", @@ -4614,6 +4745,7 @@ "extends": [ "Resource", ], + "inline": undefined, "properties": { "errors": { "docs": "The errros that should be fixed.", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/streaming.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/streaming.json index e5f60aaff72..db065712585 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/streaming.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/streaming.json @@ -285,6 +285,7 @@ "types": { "StreamUser": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", @@ -302,6 +303,7 @@ }, "StreamUser2": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", @@ -321,6 +323,7 @@ }, "User": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", @@ -338,6 +341,7 @@ }, "User2": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", @@ -357,6 +361,7 @@ }, "UserV3Response": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", @@ -375,6 +380,7 @@ }, "UserV3StreamResponse": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/suger.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/suger.json index 2a5489a8d60..fa49fbb7b64 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/suger.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/suger.json @@ -58,6 +58,7 @@ "types": { "AzureAudience": { "docs": undefined, + "inline": undefined, "properties": { "description": "optional", "id": "optional", @@ -68,6 +69,7 @@ }, "AzureGovernmentCertification": { "docs": undefined, + "inline": undefined, "properties": { "title": "optional", "uri": "optional", @@ -79,6 +81,7 @@ }, "AzureIncludedBaseQuantity": { "docs": undefined, + "inline": undefined, "properties": { "isInfinite": "optional", "quantity": "optional", @@ -99,6 +102,7 @@ }, "AzureListingContact": { "docs": undefined, + "inline": undefined, "properties": { "email": "optional", "name": "optional", @@ -122,6 +126,7 @@ }, "AzureListingUri": { "docs": undefined, + "inline": undefined, "properties": { "displayText": "optional", "subtype": "optional", @@ -134,6 +139,7 @@ }, "AzureLocalizedDateTime": { "docs": undefined, + "inline": undefined, "properties": { "dateTimeInUtc": "optional", "localizePerMarket": "optional", @@ -144,6 +150,7 @@ }, "AzureLocalizedTimeRange": { "docs": undefined, + "inline": undefined, "properties": { "endAt": "optional", "startAt": "optional", @@ -154,6 +161,7 @@ }, "AzureMarket": { "docs": undefined, + "inline": undefined, "properties": { "friendlyName": "optional", "marketCode": { @@ -167,6 +175,7 @@ }, "AzureMarketState": { "docs": undefined, + "inline": undefined, "properties": { "marketCode": { "docs": "ISO Country Code", @@ -191,6 +200,7 @@ }, "AzureMarketplacePrice": { "docs": undefined, + "inline": undefined, "properties": { "currency": { "docs": "ISO 4217 currency code", @@ -209,6 +219,7 @@ }, "AzureMarketplacePrivateOffer": { "docs": undefined, + "inline": undefined, "properties": { "$schema": "optional", "acceptBy": { @@ -262,6 +273,7 @@ }, "AzureMarketplacePrivateOfferAcceptanceLink": { "docs": undefined, + "inline": undefined, "properties": { "beneficiaryId": { "docs": "The Customer Billing Account ID.", @@ -275,6 +287,7 @@ }, "AzureMarketplacePrivateOfferBeneficiary": { "docs": undefined, + "inline": undefined, "properties": { "beneficiaryRecipients": "optional>", "description": "optional", @@ -289,6 +302,7 @@ }, "AzureMarketplacePrivateOfferBeneficiaryRecipient": { "docs": undefined, + "inline": undefined, "properties": { "id": "optional", "recipientType": "optional", @@ -308,6 +322,7 @@ }, "AzureMarketplacePrivateOfferPricing": { "docs": undefined, + "inline": undefined, "properties": { "discountPercentage": { "docs": "between 0 and 100", @@ -372,6 +387,7 @@ }, "AzureMarketplacePrivateOfferPromotionReference": { "docs": undefined, + "inline": undefined, "properties": { "id": "optional", "name": "optional", @@ -402,6 +418,7 @@ }, "AzureMarketplaceTerm": { "docs": undefined, + "inline": undefined, "properties": { "type": "optional", "value": { @@ -426,6 +443,7 @@ }, "AzureMarketplaceValidation": { "docs": undefined, + "inline": undefined, "properties": { "$schema": "optional", "code": "optional", @@ -468,6 +486,7 @@ }, "AzurePendingUpdateInfo": { "docs": undefined, + "inline": undefined, "properties": { "status": "optional", "updateType": "optional", @@ -478,6 +497,7 @@ }, "AzurePrice": { "docs": undefined, + "inline": undefined, "properties": { "currencyCode": { "docs": "ISO currency code, Three characters", @@ -492,6 +512,7 @@ }, "AzurePriceAndAvailabilityPrivateOfferCustomMeters": { "docs": undefined, + "inline": undefined, "properties": { "meters": "optional", "priceInputOption": { @@ -515,6 +536,7 @@ }, "AzurePriceAndAvailabilityPrivateOfferPlan": { "docs": undefined, + "inline": undefined, "properties": { "$schema": "optional", "id": "optional", @@ -530,6 +552,7 @@ }, "AzurePriceAndAvailabilityPrivateOfferPrice": { "docs": undefined, + "inline": undefined, "properties": { "customMeters": "optional", "recurrentPrice": "optional", @@ -540,6 +563,7 @@ }, "AzurePriceAndAvailabilityRecurrentPrice": { "docs": undefined, + "inline": undefined, "properties": { "priceInputOption": { "docs": "default "usd"", @@ -553,6 +577,7 @@ }, "AzurePriceAndAvailabilityRecurrentPriceItem": { "docs": undefined, + "inline": undefined, "properties": { "billingTerm": "optional", "paymentOption": "optional", @@ -575,6 +600,7 @@ }, "AzurePriceCadence": { "docs": undefined, + "inline": undefined, "properties": { "type": "optional", "value": "optional", @@ -594,6 +620,7 @@ }, "AzurePriceSchedule": { "docs": undefined, + "inline": undefined, "properties": { "priceCadence": "optional", "pricingModel": "optional", @@ -616,6 +643,7 @@ }, "AzurePricingUnit": { "docs": undefined, + "inline": undefined, "properties": { "isUnlimitedUnit": "optional", "lowerUnit": "optional", @@ -638,6 +666,7 @@ }, "AzureProduct": { "docs": undefined, + "inline": undefined, "properties": { "availabilities": "optional>", "branches": "optional>", @@ -662,6 +691,7 @@ }, "AzureProductAvailability": { "docs": undefined, + "inline": undefined, "properties": { "emailAudiences": "optional>", "enterpriseLicensing": "optional", @@ -676,6 +706,7 @@ }, "AzureProductBranch": { "docs": undefined, + "inline": undefined, "properties": { "currentDraftInstanceID": "optional", "friendlyName": "optional", @@ -691,6 +722,7 @@ }, "AzureProductFeatureAvailability": { "docs": undefined, + "inline": undefined, "properties": { "customMeters": "optional>", "id": "optional", @@ -723,6 +755,7 @@ }, "AzureProductListing": { "docs": undefined, + "inline": undefined, "properties": { "accessInformation": "optional", "assets": { @@ -750,6 +783,7 @@ }, "AzureProductListingAsset": { "docs": undefined, + "inline": undefined, "properties": { "description": "optional", "fileName": "optional", @@ -790,6 +824,7 @@ }, "AzureProductPackageConfiguration": { "docs": undefined, + "inline": undefined, "properties": { "azureActiveDirectoryApplicationID": "optional", "azureActiveDirectoryTenantID": "optional", @@ -804,6 +839,7 @@ }, "AzureProductProperty": { "docs": undefined, + "inline": undefined, "properties": { "additionalCategories": "optional>", "appVersion": "optional", @@ -830,6 +866,7 @@ }, "AzureProductSetup": { "docs": undefined, + "inline": undefined, "properties": { "callToAction": "optional", "channelStates": "optional>", @@ -870,6 +907,7 @@ }, "AzureProductSubmission": { "docs": undefined, + "inline": undefined, "properties": { "areResourcesReady": "optional", "friendlyName": "optional", @@ -914,6 +952,7 @@ }, "AzureProductVariant": { "docs": undefined, + "inline": undefined, "properties": { "azureGovernmentCertifications": "optional>", "cloudAvailabilities": "optional>", @@ -937,6 +976,7 @@ }, "AzureProductVariantCustomMeter": { "docs": undefined, + "inline": undefined, "properties": { "displayName": "optional", "id": "optional", @@ -952,6 +992,7 @@ }, "AzureProductVariantPriceSchedule": { "docs": undefined, + "inline": undefined, "properties": { "dateTimeRange": "optional", "friendlyName": "optional", @@ -989,6 +1030,7 @@ }, "AzureProductVariantTrial": { "docs": undefined, + "inline": undefined, "properties": { "dateTimeRange": "optional", "duration": "optional", @@ -1022,6 +1064,7 @@ }, "AzureTypeValue": { "docs": undefined, + "inline": undefined, "properties": { "type": "optional", "value": "optional", @@ -1032,6 +1075,7 @@ }, "AzureValidationResult": { "docs": undefined, + "inline": undefined, "properties": { "errorMessage": "optional", "memberNames": "optional>", @@ -1042,6 +1086,7 @@ }, "AzureVariantResource": { "docs": undefined, + "inline": undefined, "properties": { "resources": "optional>", "variantID": "optional", @@ -1052,6 +1097,7 @@ }, "GithubComAwsAwsSdkGoV2ServiceMarketplacemeteringTypesTag": { "docs": undefined, + "inline": undefined, "properties": { "key": { "docs": "One part of a key-value pair that makes up a tag. A key is a label that acts @@ -1074,6 +1120,7 @@ This member is required.", }, "GithubComSugerioMarketplaceServiceAzureSdkMarketplacemeteringv1BatchUsageEventOkResponse": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "result": "optional>", @@ -1084,6 +1131,7 @@ This member is required.", }, "GithubComSugerioMarketplaceServiceAzureSdkMarketplacemeteringv1UsageBatchEventOkMessage": { "docs": undefined, + "inline": undefined, "properties": { "dimension": { "docs": "Dimension identifier", @@ -1129,6 +1177,7 @@ This member is required.", }, "GithubComSugerioMarketplaceServiceAzureSdkMarketplacemeteringv1UsageEventConflictResponse": { "docs": undefined, + "inline": undefined, "properties": { "additionalInfo": "optional", "code": "optional", @@ -1140,6 +1189,7 @@ This member is required.", }, "GithubComSugerioMarketplaceServiceAzureSdkMarketplacemeteringv1UsageEventConflictResponseAdditionalInfo": { "docs": undefined, + "inline": undefined, "properties": { "acceptedMessage": "optional", }, @@ -1149,6 +1199,7 @@ This member is required.", }, "GithubComSugerioMarketplaceServiceAzureSdkMarketplacemeteringv1UsageEventOkResponse": { "docs": undefined, + "inline": undefined, "properties": { "dimension": { "docs": "Dimension identifier", @@ -1209,6 +1260,7 @@ This member is required.", }, "GithubComSugerioMarketplaceServiceRdsDbLibBillingAwsBillingEvent": { "docs": undefined, + "inline": undefined, "properties": { "action": "optional", "agreementID": "optional", @@ -1245,6 +1297,7 @@ This member is required.", }, "GithubComSugerioMarketplaceServiceRdsDbLibBillingAzureCmaRevenue": { "docs": undefined, + "inline": undefined, "properties": { "azureAssetID": "optional", "azureBillingAccountID": "optional", @@ -1270,6 +1323,7 @@ This member is required.", }, "GithubComSugerioMarketplaceServiceRdsDbLibBillingGcpChargeUsage": { "docs": undefined, + "inline": undefined, "properties": { "abandoned": "optional", "accountID": "optional", @@ -1305,6 +1359,7 @@ This member is required.", }, "MarketplacemeteringBatchMeterUsageOutput": { "docs": undefined, + "inline": undefined, "properties": { "resultMetadata": { "docs": "Metadata pertaining to the operation's result.", @@ -1330,6 +1385,7 @@ BatchMeterUsage call with this list as input in the BatchMeterUsageRequest.", "MiddlewareMetadata": "map", "ServicecontrolReportError": { "docs": undefined, + "inline": undefined, "properties": { "operationId": { "docs": "OperationId: The Operation.operation_id value from the request.", @@ -1346,6 +1402,7 @@ BatchMeterUsage call with this list as input in the BatchMeterUsageRequest.", }, "ServicecontrolReportResponse": { "docs": undefined, + "inline": undefined, "properties": { "reportErrors": { "docs": "ReportErrors: Partial failures, one for each `Operation` in the @@ -1378,6 +1435,7 @@ request.", }, "ServicecontrolStatus": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Code: The status code, which should be an enum value of @@ -1402,6 +1460,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAddEntitlementCreditResponse": { "docs": undefined, + "inline": undefined, "properties": { "creditAmountIncrement": { "docs": "The amount to be added to the credit amount.", @@ -1421,6 +1480,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedApiClientAccessToken": { "docs": undefined, + "inline": undefined, "properties": { "access_token": "optional", "expires_in": { @@ -1439,6 +1499,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsAccountIdentifier": { "docs": undefined, + "inline": undefined, "properties": { "awsAccountID": { "docs": "The AWS Account ID of the buyer in AWS Marketplace", @@ -1460,6 +1521,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsAceIntegration": { "docs": undefined, + "inline": undefined, "properties": { "credential": "optional", "partnerId": { @@ -1485,6 +1547,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsIntegrationCredential": { "docs": undefined, + "inline": undefined, "properties": { "accessKeyId": { "docs": "The access key ID of the IAM user for Suger service to access the client's AWS services.", @@ -1505,6 +1568,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsMarketplaceIntegration": { "docs": "The data struct to store integration info for Suger service to access the client's AWS services.", + "inline": undefined, "properties": { "externalID": { "docs": "The external ID for assuming IAM role. If empty, means no external ID set or needed. Otherwise, it should be auth_id in table identity.organization.", @@ -1561,6 +1625,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsSaasProduct": { "docs": undefined, + "inline": undefined, "properties": { "Description": "optional", "Dimensions": "optional>", @@ -1579,6 +1644,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsSaasProductAdditionalResource": { "docs": undefined, + "inline": undefined, "properties": { "Text": "optional", "Type": "optional", @@ -1590,6 +1656,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsSaasProductDeliveryOption": { "docs": undefined, + "inline": undefined, "properties": { "FulfillmentUrl": "optional", "Id": "optional", @@ -1601,6 +1668,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsSaasProductDescription": { "docs": undefined, + "inline": undefined, "properties": { "AssociatedProducts": "optional", "Categories": "optional>", @@ -1623,6 +1691,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsSaasProductDimension": { "docs": undefined, + "inline": undefined, "properties": { "Description": "optional", "Key": "optional", @@ -1636,6 +1705,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsSaasProductPromotionalResources": { "docs": undefined, + "inline": undefined, "properties": { "AdditionalResources": "optional>", "LogoUrl": "optional", @@ -1646,6 +1716,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsSaasProductSupportInformation": { "docs": undefined, + "inline": undefined, "properties": { "Description": "optional", }, @@ -1655,6 +1726,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsSaasProductVersion": { "docs": undefined, + "inline": undefined, "properties": { "DeliveryOptions": "optional>", "Id": "optional", @@ -1665,6 +1737,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAwsSnsSubscription": { "docs": undefined, + "inline": undefined, "properties": { "Endpoint": "optional", "Protocol": "optional", @@ -1688,6 +1761,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAzureAdIdentifier": { "docs": undefined, + "inline": undefined, "properties": { "buyerInfo": "optional", "companyInfo": "optional", @@ -1708,6 +1782,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAzureBuyerInfo": { "docs": undefined, + "inline": undefined, "properties": { "billingAccountId": "optional", "customerId": "optional", @@ -1720,6 +1795,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAzureIntegration": { "docs": undefined, + "inline": undefined, "properties": { "cmaFullSyncDone": { "docs": "Is Azure Commercial Marketplace Analytics (CMA) full-sync done.", @@ -1737,6 +1813,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAzureIntegrationCredential": { "docs": undefined, + "inline": undefined, "properties": { "accessToken": "optional", "clientID": "optional", @@ -1759,6 +1836,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAzureMarketplaceSubscription": { "docs": undefined, + "inline": undefined, "properties": { "allowedCustomerOperations": "optional>", "autoRenew": "optional", @@ -1828,6 +1906,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedAzureTerm": { "docs": undefined, + "inline": undefined, "properties": { "chargeDuration": "optional", "endDate": "optional", @@ -1840,6 +1919,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedBuyerInfo": { "docs": undefined, + "inline": undefined, "properties": { "awsBuyer": { "docs": "Buyer from AWS Marketplace", @@ -1872,6 +1952,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedCommitDimension": { "docs": "The commit dimension. There may be one or more commit dimensions defined in single product, offer or entitlement.", + "inline": undefined, "properties": { "category": "optional", "description": "optional", @@ -1955,6 +2036,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedCompanyInfo": { "docs": undefined, + "inline": undefined, "properties": { "addressLine1": "optional", "addressLine2": "optional", @@ -1971,6 +2053,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedContact": { "docs": undefined, + "inline": undefined, "properties": { "company": "optional", "email": "optional", @@ -1982,6 +2065,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedEntitlementInfo": { "docs": undefined, + "inline": undefined, "properties": { "autoRenew": { "docs": "Is this Entitlement Auto Renew enabled.", @@ -2050,6 +2134,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedEntitlementTermInfo": { "docs": undefined, + "inline": undefined, "properties": { "type": "optional", }, @@ -2075,6 +2160,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedEntitlementUsageRecord": { "docs": undefined, + "inline": undefined, "properties": { "amounts": "optional>", "date": "optional", @@ -2116,6 +2202,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerExternalAccountSpec": { "docs": undefined, + "inline": undefined, "properties": { "loginUri": "optional", "signupUri": "optional", @@ -2127,6 +2214,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerListingSpec": { "docs": undefined, + "inline": undefined, "properties": { "externalAccountSpec": "optional", "listingType": "optional>", @@ -2139,6 +2227,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerMarketingSpec": { "docs": undefined, + "inline": undefined, "properties": { "description": "optional", "displayNames": { @@ -2167,6 +2256,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerPrice": { "docs": undefined, + "inline": undefined, "properties": { "currencyCode": { "docs": "ISO currency code, Three UPPER_CASE characters", @@ -2187,6 +2277,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerPriceInfo": { "docs": undefined, + "inline": undefined, "properties": { "description": "optional", "priceModel": "optional", @@ -2216,6 +2307,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerPriceSubscription": { "docs": undefined, + "inline": undefined, "properties": { "period": "optional>", "price": { @@ -2230,6 +2322,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerPriceTier": { "docs": undefined, + "inline": undefined, "properties": { "endUsageAmount": { "docs": "The usage amount below which this tier is effective.", @@ -2250,6 +2343,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerPriceUsage": { "docs": undefined, + "inline": undefined, "properties": { "displayQuantity": { "docs": "Default value is 1.", @@ -2268,6 +2362,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerPurchaseMetric": { "docs": undefined, + "inline": undefined, "properties": { "description": { "docs": "Description: A detailed description of the metric, which can be used in documentation.", @@ -2295,6 +2390,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerPurchaseSpec": { "docs": undefined, + "inline": undefined, "properties": { "metrics": "optional>", "purchaseOptionSpecs": "optional>", @@ -2305,6 +2401,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerServiceBilling": { "docs": undefined, + "inline": undefined, "properties": { "metrics": { "docs": "in format of ["{product-name}.endpoints.{provider-id}.cloud.goog/{plan_key}_{usage_dimension_key}"]", @@ -2317,6 +2414,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerServiceConfig": { "docs": undefined, + "inline": undefined, "properties": { "billing": "optional", "metrics": { @@ -2339,6 +2437,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpCommerceProducerSupportSpec": { "docs": undefined, + "inline": undefined, "properties": { "description": "optional", "email": "optional", @@ -2350,6 +2449,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpIntegration": { "docs": undefined, + "inline": undefined, "properties": { "gcpProjectId": "optional", "gcpProjectNumber": "optional", @@ -2387,6 +2487,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpMarketplaceConsumer": { "docs": undefined, + "inline": undefined, "properties": { "project": { "docs": "The project name with format `projects/`.", @@ -2399,6 +2500,7 @@ in the google.rpc.Status.details field, or localized by the client.", }, "SharedGcpMarketplaceEntitlement": { "docs": undefined, + "inline": undefined, "properties": { "account": { "docs": "The resource name of the account that this entitlement is based on, if any, in format ""providers/{provider_id}/accounts/{account_id}"", @@ -2560,6 +2662,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedGcpMarketplaceUserAccount": { "docs": undefined, + "inline": undefined, "properties": { "approvals": { "docs": "The approvals for this account, that are permitted or have been completed.", @@ -2598,6 +2701,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedGcpMarketplaceUserAccountApproval": { "docs": undefined, + "inline": undefined, "properties": { "name": "optional", "reason": { @@ -2642,6 +2746,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedGcpProduct": { "docs": undefined, + "inline": undefined, "properties": { "createTime": "optional", "id": { @@ -2666,6 +2771,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedGcpPurchasePlan": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "The Plan key.", @@ -2684,6 +2790,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedGcpUserInfo": { "docs": undefined, + "inline": undefined, "properties": { "roles": { "docs": "An array of strings representing the user's roles. Right now, it can be either: ** account_admin, which indicates that the user is a Billing Account Administrator of the billing account that purchased the product, or ** project_editor, which indicates that the user is a Project Editor, but not a Billing Administrator, of the project under that billing account.", @@ -2700,6 +2807,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedHubspotCrmCredential": { "docs": undefined, + "inline": undefined, "properties": { "accessToken": "optional", "acquiredOn": { @@ -2715,6 +2823,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedHubspotCrmIntegration": { "docs": undefined, + "inline": undefined, "properties": { "credential": "optional", "portalId": { @@ -2729,6 +2838,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedIdentityBuyer": { "docs": undefined, + "inline": undefined, "properties": { "creationTime": "optional", "description": "optional", @@ -2756,6 +2866,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedIdentityIntegration": { "docs": undefined, + "inline": undefined, "properties": { "createdBy": "optional", "creationTime": "optional", @@ -2793,6 +2904,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedIntegrationInfo": { "docs": undefined, + "inline": undefined, "properties": { "awsAceIntegration": { "docs": "AWS ACE Integration", @@ -2826,6 +2938,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedListRevenueRecordDetailsResponse": { "docs": undefined, + "inline": undefined, "properties": { "nextOffset": "optional", "revenueRecordDetails": "optional>", @@ -2836,6 +2949,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedListRevenueRecordsResponse": { "docs": undefined, + "inline": undefined, "properties": { "nextOffset": "optional", "revenueRecords": "optional>", @@ -2846,6 +2960,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedListUsageRecordGroupsResponse": { "docs": undefined, + "inline": undefined, "properties": { "nextOffset": "optional", "usageRecordGroups": "optional>", @@ -2856,6 +2971,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedListUsageRecordReportsResponse": { "docs": undefined, + "inline": undefined, "properties": { "nextOffset": "optional", "usageRecordReports": "optional>", @@ -2866,6 +2982,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedMeteringDimension": { "docs": "The dimension to meter usage in entitlement.", + "inline": undefined, "properties": { "category": "optional", "description": "optional", @@ -2892,6 +3009,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedMeteringUsageRecordGroup": { "docs": undefined, + "inline": undefined, "properties": { "creationTime": "optional", "entitlementID": "optional", @@ -2910,6 +3028,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedMeteringUsageRecordGroupMetaInfo": { "docs": undefined, + "inline": undefined, "properties": { "originRecords": { "docs": "The original records reported by the customer before convertion. If no dimension mapping is applied, this field is the same as the records field.", @@ -2922,6 +3041,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedMeteringUsageRecordReport": { "docs": undefined, + "inline": undefined, "properties": { "creationTime": "optional", "entitlementID": "optional", @@ -2937,6 +3057,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedMeteringUsageRecordReportInfo": { "docs": undefined, + "inline": undefined, "properties": { "awsMeteringResponse": { "docs": "The raw response from AWS metering service.", @@ -3009,6 +3130,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedNotificationEvent": { "docs": undefined, + "inline": undefined, "properties": { "action": "optional", "entityID": "optional", @@ -3075,6 +3197,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedOfferInfo": { "docs": undefined, + "inline": undefined, "properties": { "azureOriginalPlan": { "docs": "The origin pricing of Azure plan. Only applicable for Azure Marketplace plans.", @@ -3141,6 +3264,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedOfferMetaInfo": { "docs": undefined, + "inline": undefined, "properties": { "baseAgreementId": { "docs": "Applicable for AWS Marketplace only, when the IsAgreementBasedOffer is true.", @@ -3169,6 +3293,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedOperation": { "docs": undefined, + "inline": undefined, "properties": { "endTime": "optional", "id": { @@ -3188,6 +3313,7 @@ This field is present only if the product has usage-based billing configured.", "SharedOperationType": "literal<"TemporalWorkflow">", "SharedPaymentInstallment": { "docs": undefined, + "inline": undefined, "properties": { "amount": "optional", "chargeOn": "optional", @@ -3198,6 +3324,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedProductInfo": { "docs": undefined, + "inline": undefined, "properties": { "attributes": "optional>", "awsSaasProduct": "optional", @@ -3217,6 +3344,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedRevenueRecord": { "docs": undefined, + "inline": undefined, "properties": { "amount": { "docs": "The revenue amount for the revenue report", @@ -3258,6 +3386,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedRevenueRecordDetail": { "docs": undefined, + "inline": undefined, "properties": { "awsRevenueRecordDetail": { "docs": "For AWS Marketplace", @@ -3278,6 +3407,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedRevenueRecordInfo": { "docs": undefined, + "inline": undefined, "properties": { "awsRevenueRecords": { "docs": "For raw revenue records in AWS Marketplace", @@ -3298,6 +3428,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedRevenueReport": { "docs": undefined, + "inline": undefined, "properties": { "buyerID": "optional", "entitlementID": "optional", @@ -3325,6 +3456,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedSalesforceCrmCredential": { "docs": undefined, + "inline": undefined, "properties": { "access_token": "optional", "exp": "optional", @@ -3337,6 +3469,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedSalesforceCrmIntegration": { "docs": undefined, + "inline": undefined, "properties": { "credential": { "docs": "System created", @@ -3357,6 +3490,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedSalesforceSyncFilter": { "docs": undefined, + "inline": undefined, "properties": { "fieldName": "optional", "operator": "optional", @@ -3368,6 +3502,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedSlackIntegration": { "docs": undefined, + "inline": undefined, "properties": { "accessToken": "optional", "appId": "optional", @@ -3391,6 +3526,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedUsageCount": { "docs": undefined, + "inline": undefined, "properties": { "creditCount": { "docs": "The count of this dimension usage records that are handled as credit.", @@ -3411,6 +3547,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedUsageReport": { "docs": undefined, + "inline": undefined, "properties": { "entitlementID": "optional", "organizationID": "optional", @@ -3440,6 +3577,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedWorkloadEntitlement": { "docs": undefined, + "inline": undefined, "properties": { "buyerID": "optional", "creationTime": "optional", @@ -3492,6 +3630,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedWorkloadEntitlementTerm": { "docs": undefined, + "inline": undefined, "properties": { "buyerID": "optional", "commitAmount": "optional", @@ -3530,6 +3669,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedWorkloadOffer": { "docs": undefined, + "inline": undefined, "properties": { "createdBy": "optional", "creationTime": "optional", @@ -3603,6 +3743,7 @@ This field is present only if the product has usage-based billing configured.", }, "SharedWorkloadProduct": { "docs": undefined, + "inline": undefined, "properties": { "createdBy": "optional", "creationTime": "optional", @@ -3648,6 +3789,7 @@ This field is present only if the product has usage-based billing configured.", }, "SlackOAuthResponseIncomingWebhook": { "docs": undefined, + "inline": undefined, "properties": { "channel": "optional", "channel_id": "optional", @@ -3660,6 +3802,7 @@ This field is present only if the product has usage-based billing configured.", }, "SlackOAuthV2ResponseAuthedUser": { "docs": undefined, + "inline": undefined, "properties": { "access_token": "optional", "expires_in": "optional", @@ -3674,6 +3817,7 @@ This field is present only if the product has usage-based billing configured.", }, "SlackOAuthV2ResponseEnterprise": { "docs": undefined, + "inline": undefined, "properties": { "id": "optional", "name": "optional", @@ -3684,6 +3828,7 @@ This field is present only if the product has usage-based billing configured.", }, "SlackOAuthV2ResponseTeam": { "docs": undefined, + "inline": undefined, "properties": { "id": "optional", "name": "optional", @@ -3694,6 +3839,7 @@ This field is present only if the product has usage-based billing configured.", }, "SqlNullTime": { "docs": undefined, + "inline": undefined, "properties": { "time": "optional", "valid": { @@ -3707,6 +3853,7 @@ This field is present only if the product has usage-based billing configured.", }, "TypesEntitlement": { "docs": undefined, + "inline": undefined, "properties": { "customerIdentifier": { "docs": "The customer identifier is a handle to each unique customer in an application. @@ -3741,6 +3888,7 @@ provided by AWS Marketplace when the product listing is created.", }, "TypesUsageAllocation": { "docs": undefined, + "inline": undefined, "properties": { "allocatedUsageQuantity": { "docs": "The total quantity allocated to this bucket of usage. @@ -3760,6 +3908,7 @@ tags, this parameter can be left out.", }, "TypesUsageRecord": { "docs": undefined, + "inline": undefined, "properties": { "customerIdentifier": { "docs": "The CustomerIdentifier is obtained through the ResolveCustomer operation and @@ -3800,6 +3949,7 @@ must equal the Quantity of the UsageRecord.", }, "TypesUsageRecordResult": { "docs": undefined, + "inline": undefined, "properties": { "meteringRecordId": { "docs": "The MeteringRecordId is a unique identifier for this metering event.", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/superagent.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/superagent.json index 0ab9c7cac64..324f5ef7320 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/superagent.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/superagent.json @@ -22,6 +22,7 @@ "types": { "HTTPValidationError": { "docs": undefined, + "inline": undefined, "properties": { "detail": { "type": "optional>", @@ -33,6 +34,7 @@ }, "ValidationError": { "docs": undefined, + "inline": undefined, "properties": { "loc": { "type": "list", @@ -48,6 +50,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -79,6 +82,7 @@ types: - integer source: openapi: ../openapi.yml + inline: true ValidationError: properties: loc: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/switchboard.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/switchboard.json index 2fe73005e2d..8a2e8f12e83 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/switchboard.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/switchboard.json @@ -25,6 +25,7 @@ "types": { "ClientProvidedResponseMetadata": { "docs": undefined, + "inline": undefined, "properties": { "clientRequestId": "optional", "timeThresholdMs": "optional", @@ -35,6 +36,7 @@ }, "DefaultMetaWrapper": { "docs": undefined, + "inline": undefined, "properties": { "requestId": "optional", }, @@ -44,6 +46,7 @@ }, "ErrorEnvelope": { "docs": undefined, + "inline": undefined, "properties": { "HttpStatus": "long", "Message": "string", @@ -58,6 +61,7 @@ }, "ErrorMessage": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Error code", @@ -78,6 +82,7 @@ }, "ExtensionV1": { "docs": undefined, + "inline": undefined, "properties": { "date_created": { "docs": "Date the extension was created", @@ -108,6 +113,7 @@ }, "ExtensionV1EnvelopeDefaultMetaWrapper": { "docs": undefined, + "inline": undefined, "properties": { "data": "ExtensionV1", "errors": "optional>", @@ -120,6 +126,7 @@ }, "ExternalSessionAiResponseMetadata": { "docs": undefined, + "inline": undefined, "properties": { "clientProvided": "optional", "requestId": "optional", @@ -142,6 +149,7 @@ }, "ExternalSessionAiResponseMetadataUsage": { "docs": undefined, + "inline": undefined, "properties": { "credits": { "docs": "The credit usage for this request", @@ -158,6 +166,7 @@ }, "Issue": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Issue code", @@ -178,6 +187,7 @@ }, "ListExtensionV1EnvelopeDefaultMetaWrapper": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional>", "errors": "optional>", @@ -190,6 +200,7 @@ }, "ListProfileV1EnvelopeDefaultMetaWrapper": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional>", "errors": "optional>", @@ -202,6 +213,7 @@ }, "LiveViewConnectionInfo": { "docs": undefined, + "inline": undefined, "properties": { "airtop_browser_url": { "docs": "Websocket url to connect to the airtop browser", @@ -218,6 +230,7 @@ }, "ModelResponse": { "docs": undefined, + "inline": undefined, "properties": { "modelResponse": "string", }, @@ -227,6 +240,7 @@ }, "ModelResponseExternalSessionAiResponseMetadataWrapper": { "docs": undefined, + "inline": undefined, "properties": { "data": "ModelResponse", "errors": "optional>", @@ -239,6 +253,7 @@ }, "Pagination": { "docs": undefined, + "inline": undefined, "properties": { "currentLimit": "long", "currentPage": "long", @@ -255,6 +270,7 @@ }, "ProfileV1": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "Name of the profile", @@ -291,6 +307,7 @@ }, "ProfileV1EnvelopeDefaultMetaWrapper": { "docs": undefined, + "inline": undefined, "properties": { "data": "ProfileV1", "errors": "optional>", @@ -303,6 +320,7 @@ }, "ScrapeModelResponse": { "docs": undefined, + "inline": undefined, "properties": { "modelResponse": "ScrapeResponseOutput", }, @@ -312,6 +330,7 @@ }, "ScrapeModelResponseExternalSessionAiResponseMetadataWrapper": { "docs": undefined, + "inline": undefined, "properties": { "data": "ScrapeModelResponse", "errors": "optional>", @@ -324,6 +343,7 @@ }, "ScrapeResponseContent": { "docs": undefined, + "inline": undefined, "properties": { "contentType": { "docs": "The mime type of content extracted from the browser window", @@ -340,6 +360,7 @@ }, "ScrapeResponseOutput": { "docs": undefined, + "inline": undefined, "properties": { "scrapedContent": { "docs": "The scraped content of the browser window", @@ -360,6 +381,7 @@ }, "SessionConfig": { "docs": undefined, + "inline": undefined, "properties": { "persist_profile": { "docs": "Persist the profile", @@ -396,6 +418,7 @@ }, "SessionConfigV1": { "docs": undefined, + "inline": undefined, "properties": { "persist_profile": { "docs": "Persist the profile", @@ -432,6 +455,7 @@ }, "SessionWithConnectionInfo": { "docs": undefined, + "inline": undefined, "properties": { "cdp_url": { "docs": "Url to connect to chrome devtools protocol port on the airtop browser. Include the header 'Authorization: Bearer .'", @@ -490,6 +514,7 @@ }, "SessionWithConnectionInfoEnvelopeDefaultMetaWrapper": { "docs": undefined, + "inline": undefined, "properties": { "data": "SessionWithConnectionInfo", "errors": "optional>", @@ -502,6 +527,7 @@ }, "SessionsWithPagination": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Pagination info", @@ -518,6 +544,7 @@ }, "SessionsWithPaginationEnvelopeDefaultMetaWrapper": { "docs": undefined, + "inline": undefined, "properties": { "data": "SessionsWithPagination", "errors": "optional>", @@ -530,6 +557,7 @@ }, "StatusMessage": { "docs": undefined, + "inline": undefined, "properties": { "event": { "docs": "Event name", @@ -566,6 +594,7 @@ }, "Window": { "docs": undefined, + "inline": undefined, "properties": { "liveViewUrl": { "docs": "Url for live view session", @@ -586,6 +615,7 @@ }, "WindowEnvelopeDefaultMetaWrapper": { "docs": undefined, + "inline": undefined, "properties": { "data": "Window", "errors": "optional>", @@ -2304,6 +2334,7 @@ service: }, "SessionsEventsResponseError": { "docs": undefined, + "inline": true, "properties": { "data": "root.ErrorMessage", "id": { @@ -2321,6 +2352,7 @@ service: }, "SessionsEventsResponseStatus": { "docs": undefined, + "inline": true, "properties": { "data": "root.StatusMessage", "id": { @@ -2371,6 +2403,7 @@ service: docs: The retry time in milliseconds. source: openapi: ../openapi.yml + inline: true SessionsEventsResponseError: properties: data: root.ErrorMessage @@ -2382,6 +2415,7 @@ service: docs: The retry time in milliseconds. source: openapi: ../openapi.yml + inline: true SessionsEventsResponse: discriminant: event base-properties: {} diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/uint.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/uint.json index 9b212e39608..4f6a0945092 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/uint.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/uint.json @@ -56,6 +56,7 @@ "Response": { "docs": "A generic response type used throughout the API. ", + "inline": undefined, "properties": { "id": "optional", "value": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/union-extension.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/union-extension.json index 899a6b98447..2cd36da9bf4 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/union-extension.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/union-extension.json @@ -8,6 +8,7 @@ "types": { "CounterPartyAccount": { "docs": undefined, + "inline": undefined, "properties": { "currency": "optional", "iban": "optional", @@ -19,6 +20,7 @@ }, "IbanField": { "docs": undefined, + "inline": undefined, "properties": { "iban": "optional", }, @@ -28,6 +30,7 @@ }, "Other": { "docs": undefined, + "inline": undefined, "properties": { "identification": "optional", "schemeNameCone": "optional", @@ -38,6 +41,7 @@ }, "OtherField": { "docs": undefined, + "inline": undefined, "properties": { "other": "optional", }, @@ -49,6 +53,7 @@ "discriminated": false, "docs": "PartyAccount with excluded currency in response", "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/unions-v1.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/unions-v1.json index fe864f4bcbb..76bed63af51 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/unions-v1.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/unions-v1.json @@ -8,6 +8,7 @@ "types": { "EnticingTitle": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/uploadcare.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/uploadcare.json index 898bfc05483..ef64f8ac9e5 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/uploadcare.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/uploadcare.json @@ -374,6 +374,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -384,6 +385,7 @@ }, "ContentInfo": { "docs": "Information about file content.", + "inline": undefined, "properties": { "image": "optional", "mime": { @@ -398,6 +400,7 @@ }, "ContentInfoMime": { "docs": "MIME type.", + "inline": true, "properties": { "mime": { "docs": "Full MIME type.", @@ -467,6 +470,7 @@ See [signed uploads](https://uploadcare.com/docs/security/secure-uploads/) for d }, "FileUploadInfo": { "docs": "Information about an uploaded file.", + "inline": undefined, "properties": { "content_info": "optional", "done": { @@ -539,6 +543,7 @@ See [signed uploads](https://uploadcare.com/docs/security/secure-uploads/) for d }, "FileUploadInfoErrorStatus": { "docs": undefined, + "inline": undefined, "properties": { "error": { "docs": "Human readable description of the issue with the fetch/upload task. @@ -568,6 +573,7 @@ page for a full list of all possible error codes. "extends": [ "FileUploadInfo", ], + "inline": undefined, "properties": { "type": "optional>", }, @@ -577,6 +583,7 @@ page for a full list of all possible error codes. }, "FileUploadInfoProgressStatus": { "docs": undefined, + "inline": undefined, "properties": { "done": { "docs": "How many bytes of the file have been fetched so far. @@ -607,6 +614,7 @@ example, [compressed form](https://developer.mozilla.org/en-US/docs/Web/HTTP/Hea "extends": [ "FileUploadInfo", ], + "inline": undefined, "properties": { "status": { "docs": "The file has been fetched/uploaded successfully.", @@ -619,6 +627,7 @@ example, [compressed form](https://developer.mozilla.org/en-US/docs/Web/HTTP/Hea }, "FileUploadInfoUnknownStatus": { "docs": undefined, + "inline": undefined, "properties": { "status": { "docs": "The system does not have information about the task. @@ -636,6 +645,7 @@ that are tool old (or that have not been created at all). }, "FileUploadInfoWaitingStatus": { "docs": undefined, + "inline": undefined, "properties": { "status": { "docs": "The system is preparing to handle the request. @@ -654,6 +664,7 @@ that are tool old (or that have not been created at all). "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -664,6 +675,7 @@ that are tool old (or that have not been created at all). }, "FromUrlUploadResponseSchema": { "docs": "`/from_url/` upload response.", + "inline": undefined, "properties": { "token": { "docs": "Token to identify a `/from_url/` request.", @@ -695,6 +707,7 @@ that are tool old (or that have not been created at all). }, "GroupInfo": { "docs": "File group information object.", + "inline": undefined, "properties": { "cdn_url": { "docs": "Group's CDN URL.", @@ -751,6 +764,7 @@ that are tool old (or that have not been created at all). }, "ImageInfo": { "docs": "Image metadata.", + "inline": undefined, "properties": { "color_mode": { "docs": "Image color mode.", @@ -821,6 +835,7 @@ that are tool old (or that have not been created at all). }, "ImageInfoGeoLocation": { "docs": "Geo-location of image from EXIF.", + "inline": true, "properties": { "latitude": { "docs": "Location latitude.", @@ -837,6 +852,7 @@ that are tool old (or that have not been created at all). }, "LegacyVideoInfo": { "docs": "Video metadata.", + "inline": undefined, "properties": { "audio": { "docs": "Audio stream's metadata.", @@ -865,6 +881,7 @@ that are tool old (or that have not been created at all). }, "LegacyVideoInfoAudio": { "docs": "Audio stream's metadata.", + "inline": true, "properties": { "bitrate": { "docs": "Audio stream's bitrate.", @@ -889,6 +906,7 @@ that are tool old (or that have not been created at all). }, "LegacyVideoInfoVideo": { "docs": "Video stream's metadata.", + "inline": true, "properties": { "bitrate": { "docs": "Video stream's bitrate.", @@ -991,6 +1009,7 @@ See [docs](https://uploadcare.com/docs/file-metadata/) and [REST API v0.7](/api- }, "SchemasImageInfo": { "docs": "Image metadata.", + "inline": undefined, "properties": { "color_mode": { "docs": "Image color mode.", @@ -1061,6 +1080,7 @@ See [docs](https://uploadcare.com/docs/file-metadata/) and [REST API v0.7](/api- }, "SchemasImageInfoGeoLocation": { "docs": "Geo-location of image from EXIF.", + "inline": true, "properties": { "latitude": { "docs": "Location latitude.", @@ -1174,6 +1194,7 @@ change the value to `auto`. }, "VideoInfo": { "docs": "Video metadata.", + "inline": undefined, "properties": { "audio": "list", "bitrate": { @@ -1196,6 +1217,7 @@ change the value to `auto`. }, "VideoInfoAudioItem": { "docs": "Audio stream's metadata.", + "inline": true, "properties": { "bitrate": { "docs": "Audio stream's bitrate.", @@ -1220,6 +1242,7 @@ change the value to `auto`. }, "VideoInfoVideoItem": { "docs": "Video stream's metadata.", + "inline": true, "properties": { "bitrate": { "docs": "Video stream's bitrate.", @@ -1679,6 +1702,7 @@ change the value to `auto`. docs: Location longitude. source: openapi: ../openapi.json + inline: true ImageInfo: docs: Image metadata. properties: @@ -1733,6 +1757,7 @@ change the value to `auto`. docs: Audio stream's number of channels. source: openapi: ../openapi.json + inline: true LegacyVideoInfoVideo: docs: Video stream's metadata. properties: @@ -1753,6 +1778,7 @@ change the value to `auto`. docs: Video stream codec. source: openapi: ../openapi.json + inline: true LegacyVideoInfo: docs: Video metadata. properties: @@ -1800,6 +1826,7 @@ change the value to `auto`. docs: Location longitude. source: openapi: ../openapi.json + inline: true SchemasImageInfo: docs: Image metadata. properties: @@ -1854,6 +1881,7 @@ change the value to `auto`. docs: Audio stream's number of channels. source: openapi: ../openapi.json + inline: true VideoInfoVideoItem: docs: Video stream's metadata. properties: @@ -1874,6 +1902,7 @@ change the value to `auto`. docs: Video stream's codec. source: openapi: ../openapi.json + inline: true VideoInfo: docs: Video metadata. properties: @@ -1904,6 +1933,7 @@ change the value to `auto`. docs: Subtype of MIME type. source: openapi: ../openapi.json + inline: true ContentInfo: docs: Information about file content. properties: @@ -4918,6 +4948,7 @@ to us as a value of the `part_size` parameter (in bytes). "docs": "JSON object where the key is the file name of the uploaded file and the value is the unique ID of the file on our systems. ", + "inline": undefined, "properties": { "filename": { "type": "optional", @@ -4976,6 +5007,7 @@ to the value of the `check_URL_duplicates` parameter. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -4988,6 +5020,7 @@ to the value of the `check_URL_duplicates` parameter. "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.json", }, @@ -5001,6 +5034,7 @@ to the value of the `check_URL_duplicates` parameter. }, "MultipartFileUploadStartResponse": { "docs": undefined, + "inline": undefined, "properties": { "parts": "list", "uuid": { diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/valtown.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/valtown.json index f8c4b2f5c66..ca9f13d247f 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/valtown.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/valtown.json @@ -61,6 +61,7 @@ "types": { "BadRequestErrorBody": { "docs": "The function throw an error or had invalid syntax", + "inline": undefined, "properties": { "error": "string", "type": "literal<"error">", @@ -71,6 +72,7 @@ }, "BasicVal": { "docs": "A Val", + "inline": undefined, "properties": { "author": { "docs": "The user who created this val", @@ -136,6 +138,7 @@ }, "BasicValAuthor": { "docs": "The user who created this val", + "inline": true, "properties": { "id": { "type": "string", @@ -154,6 +157,7 @@ }, "BasicValLinks": { "docs": undefined, + "inline": true, "properties": { "module": { "docs": "The URL of this Val’s source code as a module", @@ -218,6 +222,7 @@ }, "ExtendedVal": { "docs": "A Val", + "inline": undefined, "properties": { "author": { "docs": "The user who created this val", @@ -308,6 +313,7 @@ }, "ExtendedValAuthor": { "docs": "The user who created this val", + "inline": true, "properties": { "id": { "type": "string", @@ -326,6 +332,7 @@ }, "ExtendedValLinks": { "docs": undefined, + "inline": true, "properties": { "module": { "docs": "The URL of this Val’s source code as a module", @@ -390,6 +397,7 @@ }, "InternalServerErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "error": "string", }, @@ -399,6 +407,7 @@ }, "PaginationLinks": { "docs": "Links to use for pagination", + "inline": undefined, "properties": { "next": { "docs": "URL of the next page, if any", @@ -437,6 +446,7 @@ }, "ResultSet": { "docs": "Result of executing an SQL statement.", + "inline": undefined, "properties": { "columnTypes": { "docs": "Types of columns. @@ -481,6 +491,7 @@ This value is not specified for other SQL statements.", This value is not specified if the SQL statement was not an INSERT or if the table was not a ROWID table.", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -491,6 +502,7 @@ This value is not specified if the SQL statement was not an INSERT or if the tab }, "User": { "docs": "User object", + "inline": undefined, "properties": { "bio": { "docs": "The user’s biography, if they have provided one", @@ -538,6 +550,7 @@ This value is not specified if the SQL statement was not an INSERT or if the tab }, "UserLinks": { "docs": undefined, + "inline": true, "properties": { "self": { "docs": "URL of this user on this API", @@ -578,6 +591,7 @@ This value is not specified if the SQL statement was not an INSERT or if the tab format: uri source: openapi: ../openapi.yml + inline: true User: docs: User object properties: @@ -620,6 +634,7 @@ This value is not specified if the SQL statement was not an INSERT or if the tab - double source: openapi: ../openapi.yml + inline: true ResultSet: docs: Result of executing an SQL statement. properties: @@ -707,6 +722,7 @@ This value is not specified if the SQL statement was not an INSERT or if the tab format: uri source: openapi: ../openapi.yml + inline: true ExtendedValAuthor: docs: The user who created this val properties: @@ -717,6 +733,7 @@ This value is not specified if the SQL statement was not an INSERT or if the tab username: optional source: openapi: ../openapi.yml + inline: true ExtendedVal: docs: A Val properties: @@ -818,6 +835,7 @@ This value is not specified if the SQL statement was not an INSERT or if the tab format: uri source: openapi: ../openapi.yml + inline: true BasicValAuthor: docs: The user who created this val properties: @@ -828,6 +846,7 @@ This value is not specified if the SQL statement was not an INSERT or if the tab username: optional source: openapi: ../openapi.yml + inline: true BasicVal: docs: A Val properties: @@ -1046,6 +1065,7 @@ API endpoints", "types": { "AliasValResponse": { "docs": "A Val", + "inline": undefined, "properties": { "author": { "docs": "The user who created this val", @@ -1136,6 +1156,7 @@ API endpoints", }, "AliasValResponseAuthor": { "docs": "The user who created this val", + "inline": true, "properties": { "id": { "type": "string", @@ -1154,6 +1175,7 @@ API endpoints", }, "AliasValResponseLinks": { "docs": undefined, + "inline": true, "properties": { "module": { "docs": "The URL of this Val’s source code as a module", @@ -1346,6 +1368,7 @@ types: format: uri source: openapi: ../openapi.yml + inline: true AliasValResponseAuthor: docs: The user who created this val properties: @@ -1356,6 +1379,7 @@ types: username: optional source: openapi: ../openapi.yml + inline: true AliasValResponse: docs: A Val properties: @@ -1548,6 +1572,7 @@ types: "types": { "BlobListingItem": { "docs": undefined, + "inline": undefined, "properties": { "key": "string", "lastModified": { @@ -1754,6 +1779,7 @@ docs: Blobs "types": { "AttachmentObject": { "docs": undefined, + "inline": true, "properties": { "content": "string", "contentId": { @@ -1775,6 +1801,7 @@ docs: Blobs "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1790,6 +1817,7 @@ docs: Blobs "discriminated": false, "docs": "A single email or list of emails for one of the address fields", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1805,6 +1833,7 @@ docs: Blobs }, "EmailNameAndAddress": { "docs": "An email address and name", + "inline": true, "properties": { "email": "string", "name": { @@ -1817,6 +1846,7 @@ docs: Blobs }, "EmailsSendResponse": { "docs": "Successfully sent email", + "inline": undefined, "properties": { "message": "string", }, @@ -1828,6 +1858,7 @@ docs: Blobs "discriminated": false, "docs": "A reply-to list of email addresses", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -1852,6 +1883,7 @@ docs: Blobs email: string source: openapi: ../openapi.yml + inline: true EmailData: discriminated: false union: @@ -1860,6 +1892,7 @@ docs: Blobs docs: An email address and name source: openapi: ../openapi.yml + inline: true EmailDataInput: discriminated: false docs: A single email or list of emails for one of the address fields @@ -1869,6 +1902,7 @@ docs: Blobs - type: list source: openapi: ../openapi.yml + inline: true AttachmentObject: properties: content: string @@ -1881,6 +1915,7 @@ docs: Blobs type: optional source: openapi: ../openapi.yml + inline: true ReplyToList: discriminated: false docs: A reply-to list of email addresses @@ -1890,6 +1925,7 @@ docs: Blobs - type: list source: openapi: ../openapi.yml + inline: true EmailsSendResponse: docs: Successfully sent email properties: @@ -2270,6 +2306,7 @@ give access to details and data from the requesting user.", }, "MeCommentsResponse": { "docs": "A paginated result set", + "inline": undefined, "properties": { "data": "list", "links": "root.PaginationLinks", @@ -2280,6 +2317,7 @@ give access to details and data from the requesting user.", }, "MeCommentsResponseDataItem": { "docs": undefined, + "inline": true, "properties": { "author": "MeCommentsResponseDataItemAuthor", "comment": { @@ -2305,6 +2343,7 @@ give access to details and data from the requesting user.", }, "MeCommentsResponseDataItemAuthor": { "docs": undefined, + "inline": true, "properties": { "id": { "type": "string", @@ -2323,6 +2362,7 @@ give access to details and data from the requesting user.", }, "MeCommentsResponseDataItemVal": { "docs": undefined, + "inline": true, "properties": { "author": { "docs": "The user who created this val", @@ -2362,6 +2402,7 @@ give access to details and data from the requesting user.", }, "MeCommentsResponseDataItemValAuthor": { "docs": "The user who created this val", + "inline": true, "properties": { "id": { "type": "string", @@ -2391,6 +2432,7 @@ give access to details and data from the requesting user.", }, "MeGetResponse": { "docs": "Your user information, with tier and email included", + "inline": undefined, "properties": { "bio": { "docs": "The user’s biography, if they have provided one", @@ -2446,6 +2488,7 @@ give access to details and data from the requesting user.", }, "MeGetResponseLinks": { "docs": undefined, + "inline": true, "properties": { "self": { "docs": "URL of this user on this API", @@ -2474,6 +2517,7 @@ give access to details and data from the requesting user.", }, "MeLikesResponse": { "docs": "A paginated result set", + "inline": undefined, "properties": { "data": "list", "links": "root.PaginationLinks", @@ -2484,6 +2528,7 @@ give access to details and data from the requesting user.", }, "MeReferencesResponse": { "docs": "A paginated result set", + "inline": undefined, "properties": { "data": "list", "links": "root.PaginationLinks", @@ -2494,6 +2539,7 @@ give access to details and data from the requesting user.", }, "MeReferencesResponseDataItem": { "docs": "A description of a dependency from one val (reference) to another (dependsOn) that was introduced at a particular time.", + "inline": true, "properties": { "dependsOn": { "docs": "A val in a dependency relationship", @@ -2511,6 +2557,7 @@ give access to details and data from the requesting user.", }, "MeReferencesResponseDataItemDependsOn": { "docs": "A val in a dependency relationship", + "inline": true, "properties": { "author_id": { "docs": "The ID of the person who authored this val", @@ -2547,6 +2594,7 @@ give access to details and data from the requesting user.", }, "MeReferencesResponseDataItemReference": { "docs": "A val in a dependency relationship", + "inline": true, "properties": { "author_id": { "docs": "The ID of the person who authored this val", @@ -2593,6 +2641,7 @@ give access to details and data from the requesting user.", format: uri source: openapi: ../openapi.yml + inline: true MeGetResponseTier: enum: - free @@ -2659,6 +2708,7 @@ give access to details and data from the requesting user.", username: optional source: openapi: ../openapi.yml + inline: true MeCommentsResponseDataItemValPrivacy: enum: - public @@ -2679,6 +2729,7 @@ give access to details and data from the requesting user.", username: optional source: openapi: ../openapi.yml + inline: true MeCommentsResponseDataItemVal: properties: name: @@ -2702,6 +2753,7 @@ give access to details and data from the requesting user.", docs: The user who created this val source: openapi: ../openapi.yml + inline: true MeCommentsResponseDataItem: properties: comment: @@ -2717,6 +2769,7 @@ give access to details and data from the requesting user.", val: MeCommentsResponseDataItemVal source: openapi: ../openapi.yml + inline: true MeCommentsResponse: docs: A paginated result set properties: @@ -2745,6 +2798,7 @@ give access to details and data from the requesting user.", docs: The name of this val source: openapi: ../openapi.yml + inline: true MeReferencesResponseDataItemDependsOn: docs: A val in a dependency relationship properties: @@ -2766,6 +2820,7 @@ give access to details and data from the requesting user.", docs: The name of this val source: openapi: ../openapi.yml + inline: true MeReferencesResponseDataItem: docs: >- A description of a dependency from one val (reference) to another @@ -2780,6 +2835,7 @@ give access to details and data from the requesting user.", referencedAt: datetime source: openapi: ../openapi.yml + inline: true MeReferencesResponse: docs: A paginated result set properties: @@ -3088,6 +3144,7 @@ imports: "types": { "SearchValsResponse": { "docs": "A paginated result set", + "inline": undefined, "properties": { "data": "list", "links": "root.PaginationLinks", @@ -3335,6 +3392,7 @@ docs: Search "types": { "ParameterizedQuery": { "docs": "A parameterized SQL query. See https://docs.turso.tech/sdk/ts/reference#batch-transactions for reference", + "inline": true, "properties": { "args": { "display-name": "StatementArg", @@ -3364,6 +3422,7 @@ docs: Search "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3382,6 +3441,7 @@ docs: Search "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3400,6 +3460,7 @@ docs: Search "discriminated": false, "docs": "List of arguments to be used in the given statement", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3412,6 +3473,7 @@ docs: Search "discriminated": false, "docs": "A value to be used as a parameter", "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -3433,6 +3495,7 @@ docs: Search - boolean source: openapi: ../openapi.yml + inline: true StatementArg: discriminated: false docs: List of arguments to be used in the given statement @@ -3441,6 +3504,7 @@ docs: Search - map> source: openapi: ../openapi.yml + inline: true ParameterizedQuery: docs: >- A parameterized SQL query. See @@ -3455,6 +3519,7 @@ docs: Search docs: List of arguments to be used in the given statement source: openapi: ../openapi.yml + inline: true SqliteExecuteRequestStatement: discriminated: false union: @@ -3467,6 +3532,7 @@ docs: Search reference source: openapi: ../openapi.yml + inline: true SqliteBatchRequestStatementsItem: discriminated: false union: @@ -3479,6 +3545,7 @@ docs: Search reference source: openapi: ../openapi.yml + inline: true SqliteBatchRequestMode: enum: - write @@ -3724,6 +3791,7 @@ docs: SQLite "types": { "UsersValsResponse": { "docs": "A paginated result set", + "inline": undefined, "properties": { "data": "list", "links": "root.PaginationLinks", @@ -4683,6 +4751,7 @@ let you get, create, and run vals.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -4698,6 +4767,7 @@ let you get, create, and run vals.", "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, @@ -4711,6 +4781,7 @@ let you get, create, and run vals.", }, "ValsCancelResponse": { "docs": "The evaluation_id was successfully searched for and the evaluation was either already done or now has been cancelled", + "inline": undefined, "properties": { "found": { "docs": "True if the evaluation was found and cancelled", @@ -4769,6 +4840,7 @@ let you get, create, and run vals.", }, "ValsListResponse": { "docs": "A paginated result set", + "inline": undefined, "properties": { "data": "list", "links": "root.PaginationLinks", @@ -4779,6 +4851,7 @@ let you get, create, and run vals.", }, "ValsListResponseDataItem": { "docs": undefined, + "inline": true, "properties": { "createdAt": "datetime", "val_id": { @@ -4908,6 +4981,7 @@ let you get, create, and run vals.", createdAt: datetime source: openapi: ../openapi.yml + inline: true ValsListResponse: docs: A paginated result set properties: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/vellum.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/vellum.json index cb3643c0f57..cd87a10eac3 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/vellum.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/vellum.json @@ -579,6 +579,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ChatMessage": { "docs": undefined, + "inline": undefined, "properties": { "role": "ChatMessageRole", "text": "string", @@ -589,6 +590,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ChatMessageRequest": { "docs": undefined, + "inline": undefined, "properties": { "role": "ChatMessageRole", "text": "string", @@ -614,6 +616,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ConditionalNodeResult": { "docs": undefined, + "inline": undefined, "properties": { "data": "ConditionalNodeResultData", }, @@ -623,6 +626,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ConditionalNodeResultData": { "docs": undefined, + "inline": undefined, "properties": { "source_handle_id": "optional", }, @@ -643,6 +647,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "DeploymentNodeResult": { "docs": undefined, + "inline": undefined, "properties": { "data": "DeploymentNodeResultData", }, @@ -652,6 +657,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "DeploymentNodeResultData": { "docs": undefined, + "inline": undefined, "properties": { "delta": "optional", "output_id": "string", @@ -663,6 +669,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "DeploymentRead": { "docs": undefined, + "inline": undefined, "properties": { "active_model_version_ids": "list", "created": "datetime", @@ -739,6 +746,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "Document": { "docs": undefined, + "inline": undefined, "properties": { "external_id": { "docs": "The unique ID of the document as represented in an external system and specified when it was originally uploaded.", @@ -777,6 +785,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "DocumentDocumentToDocumentIndex": { "docs": undefined, + "inline": undefined, "properties": { "document_index_id": { "docs": "Vellum-generated ID that uniquely identifies the index this document is included in.", @@ -815,6 +824,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "DocumentIndexRead": { "docs": undefined, + "inline": undefined, "properties": { "created": "datetime", "environment": { @@ -883,6 +893,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "EnrichedNormalizedCompletion": { "docs": undefined, + "inline": undefined, "properties": { "external_id": { "docs": "The external ID that was originally provided along with the generation request, which uniquely identifies this generation in an external system.", @@ -939,6 +950,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "EvaluationParams": { "docs": undefined, + "inline": undefined, "properties": { "target": { "docs": "The target value to compare the LLM output against. Typically what you expect or desire the LLM output to be.", @@ -951,6 +963,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "EvaluationParamsRequest": { "docs": undefined, + "inline": undefined, "properties": { "target": { "docs": "The target value to compare the LLM output against. Typically what you expect or desire the LLM output to be.", @@ -976,6 +989,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "GenerateErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "detail": { "docs": "Details about why the request failed.", @@ -988,6 +1002,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "GenerateOptionsRequest": { "docs": undefined, + "inline": undefined, "properties": { "logprobs": { "docs": "Which logprobs to include, if any. Defaults to NONE. @@ -1003,6 +1018,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "GenerateRequest": { "docs": undefined, + "inline": undefined, "properties": { "chat_history": { "docs": "Optionally provide a list of chat messages that'll be used in place of the special {$chat_history} variable, if included in the prompt.", @@ -1023,6 +1039,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "GenerateResponse": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "The results of each generation request.", @@ -1035,6 +1052,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "GenerateResult": { "docs": undefined, + "inline": undefined, "properties": { "data": { "docs": "An object containing the resulting generation. This key will be absent if the LLM provider experienced an error.", @@ -1051,6 +1069,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "GenerateResultData": { "docs": undefined, + "inline": undefined, "properties": { "completions": { "docs": "The generated completions. This will generally be a list of length one.", @@ -1063,6 +1082,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "GenerateResultError": { "docs": undefined, + "inline": undefined, "properties": { "message": { "docs": "The error message returned by the LLM provider.", @@ -1075,6 +1095,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "GenerateStreamResponse": { "docs": undefined, + "inline": undefined, "properties": { "delta": "GenerateStreamResult", }, @@ -1084,6 +1105,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "GenerateStreamResult": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional", "error": "optional", @@ -1095,6 +1117,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "GenerateStreamResultData": { "docs": undefined, + "inline": undefined, "properties": { "completion": "EnrichedNormalizedCompletion", "completion_index": "integer", @@ -1144,6 +1167,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ModelVersionBuildConfig": { "docs": undefined, + "inline": undefined, "properties": { "base_model": { "docs": "The name of the base model used to create this model version, as identified by the LLM provider.", @@ -1160,6 +1184,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ModelVersionCompilePromptResponse": { "docs": undefined, + "inline": undefined, "properties": { "prompt": { "docs": "Information about the compiled prompt.", @@ -1172,6 +1197,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ModelVersionCompiledPrompt": { "docs": undefined, + "inline": undefined, "properties": { "num_tokens": { "docs": "The approximate number of tokens used by the compiled prompt.", @@ -1195,6 +1221,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ModelVersionExecConfig": { "docs": undefined, + "inline": undefined, "properties": { "input_variables": { "docs": "Names of the input variables specified in the prompt template.", @@ -1217,6 +1244,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ModelVersionExecConfigParameters": { "docs": undefined, + "inline": undefined, "properties": { "frequency_penalty": "double", "logit_bias": "optional>>", @@ -1233,6 +1261,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ModelVersionRead": { "docs": undefined, + "inline": undefined, "properties": { "build_config": { "docs": "Configuration used to build this model version.", @@ -1319,6 +1348,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ModelVersionSandboxSnapshot": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the sandbox snapshot.", @@ -1347,6 +1377,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "NormalizedLogProbs": { "docs": undefined, + "inline": undefined, "properties": { "likelihood": "optional", "tokens": "list", @@ -1357,6 +1388,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "NormalizedTokenLogProbs": { "docs": undefined, + "inline": undefined, "properties": { "logprob": "optional", "text_offset": "integer", @@ -1369,6 +1401,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "PaginatedSlimDocumentList": { "docs": undefined, + "inline": undefined, "properties": { "count": "optional", "next": { @@ -1416,6 +1449,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "PromptNodeResult": { "docs": undefined, + "inline": undefined, "properties": { "data": "PromptNodeResultData", }, @@ -1425,6 +1459,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "PromptNodeResultData": { "docs": undefined, + "inline": undefined, "properties": { "delta": "optional", "output_id": "string", @@ -1436,6 +1471,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "PromptTemplateBlock": { "docs": undefined, + "inline": undefined, "properties": { "block_type": "BlockTypeEnum", "id": "string", @@ -1447,6 +1483,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "PromptTemplateBlockData": { "docs": undefined, + "inline": undefined, "properties": { "blocks": "list", "version": "integer", @@ -1457,6 +1494,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "PromptTemplateBlockDataRequest": { "docs": undefined, + "inline": undefined, "properties": { "blocks": "list", "version": "integer", @@ -1467,6 +1505,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "PromptTemplateBlockProperties": { "docs": undefined, + "inline": undefined, "properties": { "blocks": "optional>", "chat_message_unterminated": { @@ -1486,6 +1525,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "PromptTemplateBlockPropertiesRequest": { "docs": undefined, + "inline": undefined, "properties": { "blocks": "optional>", "chat_message_unterminated": { @@ -1521,6 +1561,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "PromptTemplateBlockRequest": { "docs": undefined, + "inline": undefined, "properties": { "block_type": "BlockTypeEnum", "id": { @@ -1540,6 +1581,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "PromptTemplateInputVariable": { "docs": undefined, + "inline": undefined, "properties": { "key": { "docs": "The name of the input variable.", @@ -1552,6 +1594,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "PromptTemplateInputVariableRequest": { "docs": undefined, + "inline": undefined, "properties": { "key": { "docs": "The name of the input variable.", @@ -1593,6 +1636,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "RegisterPromptErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "detail": { "docs": "Details about why the request failed.", @@ -1605,6 +1649,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "RegisterPromptModelParametersRequest": { "docs": undefined, + "inline": undefined, "properties": { "frequency_penalty": "double", "logit_bias": "optional>>", @@ -1621,6 +1666,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "RegisterPromptPrompt": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the generated prompt.", @@ -1637,6 +1683,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "RegisterPromptPromptInfoRequest": { "docs": undefined, + "inline": undefined, "properties": { "input_variables": { "docs": "Names of the input variables specified in the prompt template.", @@ -1654,6 +1701,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "RegisterPromptResponse": { "docs": undefined, + "inline": undefined, "properties": { "deployment": { "docs": "Information about the generated deployment", @@ -1682,6 +1730,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "RegisteredPromptDeployment": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the generated deployment.", @@ -1702,6 +1751,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "RegisteredPromptModelVersion": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the generated model version.", @@ -1718,6 +1768,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "RegisteredPromptSandbox": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the generated sandbox.", @@ -1734,6 +1785,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "RegisteredPromptSandboxSnapshot": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The ID of the generated sandbox snapshot.", @@ -1746,6 +1798,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SandboxMetricInputParams": { "docs": undefined, + "inline": undefined, "properties": { "params": "optional", }, @@ -1755,6 +1808,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SandboxMetricInputParamsRequest": { "docs": undefined, + "inline": undefined, "properties": { "params": "optional", }, @@ -1764,6 +1818,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SandboxNodeResult": { "docs": undefined, + "inline": undefined, "properties": { "data": "SandboxNodeResultData", }, @@ -1773,6 +1828,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SandboxNodeResultData": { "docs": undefined, + "inline": undefined, "properties": { "delta": "optional", "output_id": "string", @@ -1784,6 +1840,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SandboxScenario": { "docs": undefined, + "inline": undefined, "properties": { "id": { "docs": "The id of the scenario", @@ -1805,6 +1862,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ScenarioInput": { "docs": undefined, + "inline": undefined, "properties": { "chat_history": "optional>", "key": "string", @@ -1817,6 +1875,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "ScenarioInputRequest": { "docs": undefined, + "inline": undefined, "properties": { "chat_history": "optional>", "key": { @@ -1848,6 +1907,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SearchErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "detail": { "docs": "Details about why the request failed.", @@ -1860,6 +1920,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SearchFiltersRequest": { "docs": undefined, + "inline": undefined, "properties": { "external_ids": { "docs": "The document external IDs to filter by", @@ -1872,6 +1933,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SearchNodeResult": { "docs": undefined, + "inline": undefined, "properties": { "data": "SearchNodeResultData", }, @@ -1881,6 +1943,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SearchNodeResultData": { "docs": undefined, + "inline": undefined, "properties": { "results": "list>", "results_output_id": "string", @@ -1893,6 +1956,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SearchRequestOptionsRequest": { "docs": undefined, + "inline": undefined, "properties": { "filters": { "docs": "The filters to apply to the search.", @@ -1917,6 +1981,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SearchResponse": { "docs": undefined, + "inline": undefined, "properties": { "results": { "docs": "The results of the search. Each result represents a chunk that matches the search query.", @@ -1929,6 +1994,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SearchResult": { "docs": undefined, + "inline": undefined, "properties": { "document": { "docs": "The document that contains the chunk that matched the search query.", @@ -1950,6 +2016,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SearchResultMergingRequest": { "docs": undefined, + "inline": undefined, "properties": { "enabled": { "docs": "Whether to enable merging results", @@ -1962,6 +2029,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SearchWeightsRequest": { "docs": undefined, + "inline": undefined, "properties": { "keywords": { "docs": "The relative weight to give to keyword matches", @@ -1978,6 +2046,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SlimDocument": { "docs": undefined, + "inline": undefined, "properties": { "document_to_document_indexes": "list", "external_id": { @@ -2050,6 +2119,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SubmitCompletionActualRequest": { "docs": undefined, + "inline": undefined, "properties": { "external_id": { "docs": "The external ID that was originally provided when generating the completion that you'd now like to submit actuals for. Must provide either this or id.", @@ -2097,6 +2167,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "SubmitCompletionActualsErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "detail": "string", }, @@ -2106,6 +2177,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "TerminalNodeChatHistoryResult": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "The unique name given to the terminal node that produced this output.", @@ -2119,6 +2191,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "TerminalNodeJsonResult": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "The unique name given to the terminal node that produced this output.", @@ -2132,6 +2205,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "TerminalNodeResult": { "docs": undefined, + "inline": undefined, "properties": { "data": "TerminalNodeResultData", }, @@ -2141,6 +2215,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "TerminalNodeResultData": { "docs": undefined, + "inline": undefined, "properties": { "output": "TerminalNodeResultOutput", }, @@ -2165,6 +2240,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "TerminalNodeStringResult": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "The unique name given to the terminal node that produced this output.", @@ -2178,6 +2254,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "TestSuiteTestCase": { "docs": undefined, + "inline": undefined, "properties": { "evaluation_params": { "docs": "Parameters to use when evaluating the test case, specific to the test suite's evaluation metric.", @@ -2202,6 +2279,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "UploadDocumentErrorResponse": { "docs": undefined, + "inline": undefined, "properties": { "detail": "string", }, @@ -2211,6 +2289,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "UploadDocumentResponse": { "docs": undefined, + "inline": undefined, "properties": { "document_id": { "docs": "The ID of the newly created document.", @@ -2229,6 +2308,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "WorkflowEventError": { "docs": undefined, + "inline": undefined, "properties": { "code": "WorkflowExecutionEventErrorCode", "message": "string", @@ -2250,6 +2330,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "WorkflowExecutionNodeResultEvent": { "docs": undefined, + "inline": undefined, "properties": { "data": "WorkflowNodeResultEvent", "external_id": "optional", @@ -2261,6 +2342,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "WorkflowExecutionWorkflowResultEvent": { "docs": undefined, + "inline": undefined, "properties": { "data": "WorkflowResultEvent", "external_id": "optional", @@ -2290,6 +2372,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "WorkflowNodeResultEvent": { "docs": undefined, + "inline": undefined, "properties": { "data": "optional", "error": "optional", @@ -2320,6 +2403,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "WorkflowRequestChatHistoryInputRequest": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "The variable's name, as defined in the Workflow.", @@ -2354,6 +2438,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "WorkflowRequestJsonInputRequest": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "The variable's name, as defined in the Workflow.", @@ -2373,6 +2458,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "WorkflowRequestStringInputRequest": { "docs": undefined, + "inline": undefined, "properties": { "name": { "docs": "The variable's name, as defined in the Workflow.", @@ -2392,6 +2478,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "WorkflowResultEvent": { "docs": undefined, + "inline": undefined, "properties": { "error": "optional", "id": "string", @@ -2420,6 +2507,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "WorkflowResultEventOutputDataChatHistory": { "docs": undefined, + "inline": undefined, "properties": { "delta": { "docs": "The newly output string value. Only relevant for string outputs with a state of STREAMING.", @@ -2436,6 +2524,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "WorkflowResultEventOutputDataJson": { "docs": undefined, + "inline": undefined, "properties": { "delta": { "docs": "The newly output string value. Only relevant for string outputs with a state of STREAMING.", @@ -2452,6 +2541,7 @@ Used to submit feedback regarding the quality of previously generated completion }, "WorkflowResultEventOutputDataString": { "docs": undefined, + "inline": undefined, "properties": { "delta": { "docs": "The newly output string value, meant to be concatenated with all previous. Will be non-null for events of state STREAMING.", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/webflow.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/webflow.json index b31ac9e1559..c36b8b86be8 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/webflow.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/webflow.json @@ -89,6 +89,7 @@ "types": { "ConflictErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": { "docs": "Error code", @@ -115,6 +116,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -125,6 +127,7 @@ }, "ConflictErrorBodyOne": { "docs": undefined, + "inline": true, "properties": { "code": { "docs": "Error code", @@ -151,6 +154,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -161,6 +165,7 @@ }, "ConflictErrorBodyZero": { "docs": undefined, + "inline": true, "properties": { "code": { "docs": "Error code", @@ -187,6 +192,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -197,6 +203,7 @@ }, "ForbiddenErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "details": "optional>", "externalReference": "optional", @@ -210,6 +217,7 @@ }, "ForbiddenErrorBodyOne": { "docs": undefined, + "inline": true, "properties": { "code": { "docs": "Error code", @@ -236,6 +244,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -246,6 +255,7 @@ }, "ForbiddenErrorBodyZero": { "docs": undefined, + "inline": true, "properties": { "code": { "docs": "Error code", @@ -272,6 +282,7 @@ "discriminated": false, "docs": undefined, "encoding": undefined, + "inline": true, "source": { "openapi": "../openapi.yml", }, @@ -404,6 +415,7 @@ }, "TooManyRequestsErrorBody": { "docs": undefined, + "inline": undefined, "properties": { "code": "optional", "details": "optional>", @@ -514,6 +526,7 @@ - map source: openapi: ../openapi.yml + inline: true ForbiddenErrorBodyZero: properties: code: @@ -530,6 +543,7 @@ docs: Array of errors source: openapi: ../openapi.yml + inline: true ForbiddenErrorBodyOneDetailsItem: discriminated: false union: @@ -537,6 +551,7 @@ - map source: openapi: ../openapi.yml + inline: true ForbiddenErrorBodyOne: properties: code: @@ -553,6 +568,7 @@ docs: Array of errors source: openapi: ../openapi.yml + inline: true ConflictErrorBodyZeroDetailsItem: discriminated: false union: @@ -560,6 +576,7 @@ - map source: openapi: ../openapi.yml + inline: true ConflictErrorBodyZero: properties: code: @@ -576,6 +593,7 @@ docs: Array of errors source: openapi: ../openapi.yml + inline: true ConflictErrorBodyOneDetailsItem: discriminated: false union: @@ -583,6 +601,7 @@ - map source: openapi: ../openapi.yml + inline: true ConflictErrorBodyOne: properties: code: @@ -599,6 +618,7 @@ docs: Array of errors source: openapi: ../openapi.yml + inline: true ConflictErrorBody: properties: code: @@ -622,6 +642,7 @@ - map source: openapi: ../openapi.yml + inline: true errors: UnauthorizedError: status-code: 401 @@ -787,6 +808,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "AccessGroupsListResponse": { "docs": "The list access groups results", + "inline": undefined, "properties": { "accessGroups": { "docs": "List of Site Access Groups", @@ -817,6 +839,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "AccessGroupsListResponseAccessGroupsItem": { "docs": undefined, + "inline": true, "properties": { "createdOn": { "docs": "The date the Access Group was created", @@ -879,6 +902,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: The date the Access Group was created source: openapi: ../openapi.yml + inline: true AccessGroupsListResponse: docs: The list access groups results properties: @@ -1492,6 +1516,7 @@ service: "types": { "AssetsCreateFolderResponse": { "docs": "Asset Folder details", + "inline": undefined, "properties": { "assets": { "docs": "Array of Asset instances in the folder", @@ -1528,6 +1553,7 @@ service: }, "AssetsCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "assetUrl": { "docs": "S3 link to the asset", @@ -1587,6 +1613,7 @@ service: }, "AssetsCreateResponseUploadDetails": { "docs": "Metadata for uploading the asset binary", + "inline": true, "properties": { "Cache-Control": "optional", "Policy": "optional", @@ -1606,6 +1633,7 @@ service: }, "AssetsGetFolderResponse": { "docs": "Asset Folder details", + "inline": undefined, "properties": { "assets": { "docs": "Array of Asset instances in the folder", @@ -1642,6 +1670,7 @@ service: }, "AssetsGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "altText": { "docs": "The visual description of the asset", @@ -1697,6 +1726,7 @@ service: }, "AssetsGetResponseVariantsItem": { "docs": undefined, + "inline": true, "properties": { "displayName": { "docs": "Display name of the variant", @@ -1743,6 +1773,7 @@ service: }, "AssetsListFoldersResponse": { "docs": "The Asset Folders object", + "inline": undefined, "properties": { "assetFolders": { "docs": "A list of Asset folders", @@ -1759,6 +1790,7 @@ service: }, "AssetsListFoldersResponseAssetFoldersItem": { "docs": "Asset Folder details", + "inline": true, "properties": { "assets": { "docs": "Array of Asset instances in the folder", @@ -1795,6 +1827,7 @@ service: }, "AssetsListFoldersResponsePagination": { "docs": "Pagination object", + "inline": true, "properties": { "limit": { "docs": "The limit used for pagination", @@ -1815,6 +1848,7 @@ service: }, "AssetsListResponse": { "docs": "A list of assets", + "inline": undefined, "properties": { "assets": "optional>", }, @@ -1824,6 +1858,7 @@ service: }, "AssetsListResponseAssetsItem": { "docs": undefined, + "inline": true, "properties": { "altText": { "docs": "The visual description of the asset", @@ -1879,6 +1914,7 @@ service: }, "AssetsListResponseAssetsItemVariantsItem": { "docs": undefined, + "inline": true, "properties": { "displayName": { "docs": "Display name of the variant", @@ -1925,6 +1961,7 @@ service: }, "AssetsUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "altText": { "docs": "The visual description of the asset", @@ -1980,6 +2017,7 @@ service: }, "AssetsUpdateResponseVariantsItem": { "docs": undefined, + "inline": true, "properties": { "displayName": { "docs": "Display name of the variant", @@ -2057,6 +2095,7 @@ service: docs: Any associated validation errors source: openapi: ../openapi.yml + inline: true AssetsListResponseAssetsItem: properties: id: @@ -2094,6 +2133,7 @@ service: docs: The visual description of the asset source: openapi: ../openapi.yml + inline: true AssetsListResponse: docs: A list of assets properties: @@ -2116,6 +2156,7 @@ service: Cache-Control: optional source: openapi: ../openapi.yml + inline: true AssetsCreateResponse: properties: uploadDetails: @@ -2183,6 +2224,7 @@ service: docs: Any associated validation errors source: openapi: ../openapi.yml + inline: true AssetsGetResponse: properties: id: @@ -2250,6 +2292,7 @@ service: docs: Any associated validation errors source: openapi: ../openapi.yml + inline: true AssetsUpdateResponse: properties: id: @@ -2313,6 +2356,7 @@ service: docs: Date that the Asset Folder was last updated on source: openapi: ../openapi.yml + inline: true AssetsListFoldersResponsePagination: docs: Pagination object properties: @@ -2327,6 +2371,7 @@ service: docs: The total number of records source: openapi: ../openapi.yml + inline: true AssetsListFoldersResponse: docs: The Asset Folders object properties: @@ -3068,6 +3113,7 @@ service: "types": { "CollectionsCreateResponse": { "docs": "A collection object", + "inline": undefined, "properties": { "createdOn": { "docs": "The date the collection was created", @@ -3104,6 +3150,7 @@ service: }, "CollectionsCreateResponseFieldsItem": { "docs": "The details of a field in a collection", + "inline": true, "properties": { "displayName": { "docs": "The name of a field", @@ -3161,6 +3208,7 @@ service: }, "CollectionsGetResponse": { "docs": "A collection object", + "inline": undefined, "properties": { "createdOn": { "docs": "The date the collection was created", @@ -3197,6 +3245,7 @@ service: }, "CollectionsGetResponseFieldsItem": { "docs": "The details of a field in a collection", + "inline": true, "properties": { "displayName": { "docs": "The name of a field", @@ -3254,6 +3303,7 @@ service: }, "CollectionsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "collections": { "docs": "An array of Collections", @@ -3266,6 +3316,7 @@ service: }, "CollectionsListResponseCollectionsItem": { "docs": "A collection object", + "inline": true, "properties": { "createdOn": { "docs": "The date the collection was created", @@ -3324,6 +3375,7 @@ service: docs: The date the collection was last updated source: openapi: ../openapi.yml + inline: true CollectionsListResponse: properties: collections: @@ -3377,6 +3429,7 @@ service: docs: Additional text to help anyone filling out this field source: openapi: ../openapi.yml + inline: true CollectionsCreateResponse: docs: A collection object properties: @@ -3451,6 +3504,7 @@ service: docs: Additional text to help anyone filling out this field source: openapi: ../openapi.yml + inline: true CollectionsGetResponse: docs: A collection object properties: @@ -3885,6 +3939,7 @@ service: }, "FieldsCreateResponse": { "docs": "The details of a field in a collection", + "inline": undefined, "properties": { "displayName": { "docs": "The name of a field", @@ -3942,6 +3997,7 @@ service: }, "FieldsUpdateResponse": { "docs": "The details of a field in a collection", + "inline": undefined, "properties": { "displayName": { "docs": "The name of a field", @@ -5220,6 +5276,7 @@ service: "ItemsCreateItemForMultipleLocalesRequestFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -5237,6 +5294,7 @@ service: "ItemsCreateItemForMultipleLocalesResponse": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "cmsLocaleIds": { "docs": "Array of identifiers for the locales where the item will be created", @@ -5277,6 +5335,7 @@ service: "ItemsCreateItemForMultipleLocalesResponseFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -5294,6 +5353,7 @@ service: "ItemsCreateItemLiveRequestFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -5311,6 +5371,7 @@ service: "ItemsCreateItemLiveResponse": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -5351,6 +5412,7 @@ service: "ItemsCreateItemLiveResponseFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -5368,6 +5430,7 @@ service: "ItemsCreateItemRequestFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -5385,6 +5448,7 @@ service: "ItemsCreateItemResponse": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -5425,6 +5489,7 @@ service: "ItemsCreateItemResponseFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -5442,6 +5507,7 @@ service: "ItemsGetItemLiveResponse": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -5482,6 +5548,7 @@ service: "ItemsGetItemLiveResponseFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -5499,6 +5566,7 @@ service: "ItemsGetItemResponse": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -5539,6 +5607,7 @@ service: "ItemsGetItemResponseFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -5574,6 +5643,7 @@ service: }, "ItemsListItemsLiveResponse": { "docs": "Results from collection items list", + "inline": undefined, "properties": { "items": { "docs": "List of Items within the collection", @@ -5588,6 +5658,7 @@ service: "ItemsListItemsLiveResponseItemsItem": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -5628,6 +5699,7 @@ service: "ItemsListItemsLiveResponseItemsItemFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -5644,6 +5716,7 @@ service: }, "ItemsListItemsLiveResponsePagination": { "docs": undefined, + "inline": true, "properties": { "limit": { "default": 100, @@ -5685,6 +5758,7 @@ service: }, "ItemsListItemsResponse": { "docs": "Results from collection items list", + "inline": undefined, "properties": { "items": { "docs": "List of Items within the collection", @@ -5699,6 +5773,7 @@ service: "ItemsListItemsResponseItemsItem": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -5739,6 +5814,7 @@ service: "ItemsListItemsResponseItemsItemFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -5755,6 +5831,7 @@ service: }, "ItemsListItemsResponsePagination": { "docs": undefined, + "inline": true, "properties": { "limit": { "default": 100, @@ -5777,6 +5854,7 @@ service: }, "ItemsPublishItemResponse": { "docs": undefined, + "inline": undefined, "properties": { "errors": "optional>", "publishedItemIds": "optional>", @@ -5788,6 +5866,7 @@ service: "ItemsUpdateItemLiveRequestFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -5805,6 +5884,7 @@ service: "ItemsUpdateItemLiveResponse": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -5845,6 +5925,7 @@ service: "ItemsUpdateItemLiveResponseFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -5862,6 +5943,7 @@ service: "ItemsUpdateItemRequestFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -5879,6 +5961,7 @@ service: "ItemsUpdateItemResponse": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -5919,6 +6002,7 @@ service: "ItemsUpdateItemResponseFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -5962,6 +6046,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsListItemsResponseItemsItem: docs: > The fields that define the schema for a given Item are based on the @@ -5995,6 +6080,7 @@ service: fieldData: optional source: openapi: ../openapi.yml + inline: true ItemsListItemsResponsePagination: properties: limit: @@ -6010,6 +6096,7 @@ service: docs: Total number of items in the collection source: openapi: ../openapi.yml + inline: true ItemsListItemsResponse: docs: Results from collection items list properties: @@ -6032,6 +6119,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsCreateItemResponseFieldData: properties: name: @@ -6045,6 +6133,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsCreateItemResponse: docs: > The fields that define the schema for a given Item are based on the @@ -6104,6 +6193,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsListItemsLiveResponseItemsItem: docs: > The fields that define the schema for a given Item are based on the @@ -6137,6 +6227,7 @@ service: fieldData: optional source: openapi: ../openapi.yml + inline: true ItemsListItemsLiveResponsePagination: properties: limit: @@ -6152,6 +6243,7 @@ service: docs: Total number of items in the collection source: openapi: ../openapi.yml + inline: true ItemsListItemsLiveResponse: docs: Results from collection items list properties: @@ -6174,6 +6266,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsCreateItemLiveResponseFieldData: properties: name: @@ -6187,6 +6280,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsCreateItemLiveResponse: docs: > The fields that define the schema for a given Item are based on the @@ -6233,6 +6327,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsCreateItemForMultipleLocalesResponseFieldData: properties: name: @@ -6246,6 +6341,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsCreateItemForMultipleLocalesResponse: docs: > The fields that define the schema for a given Item are based on the @@ -6292,6 +6388,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsGetItemResponse: docs: > The fields that define the schema for a given Item are based on the @@ -6338,6 +6435,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsUpdateItemResponseFieldData: properties: name: @@ -6351,6 +6449,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsUpdateItemResponse: docs: > The fields that define the schema for a given Item are based on the @@ -6397,6 +6496,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsGetItemLiveResponse: docs: > The fields that define the schema for a given Item are based on the @@ -6443,6 +6543,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsUpdateItemLiveResponseFieldData: properties: name: @@ -6456,6 +6557,7 @@ service: extra-properties: true source: openapi: ../openapi.yml + inline: true ItemsUpdateItemLiveResponse: docs: > The fields that define the schema for a given Item are based on the @@ -7314,6 +7416,7 @@ Required scope | `ecommerce:read` "types": { "EcommerceGetSettingsResponse": { "docs": "Ecommerce settings for a Webflow Site", + "inline": undefined, "properties": { "createdOn": { "docs": "Date that the Site was created on", @@ -7790,6 +7893,7 @@ service: "types": { "FormSubmissionPayload": { "docs": "The Webhook payload for when a form is submitted", + "inline": undefined, "properties": { "payload": { "docs": "The payload of data sent from Webflow", @@ -7806,6 +7910,7 @@ service: }, "FormSubmissionPayloadPayload": { "docs": "The payload of data sent from Webflow", + "inline": true, "properties": { "data": { "docs": "The data submitted in the form", @@ -7846,6 +7951,7 @@ service: }, "FormsGetResponse": { "docs": "A form and its corresponding metadata", + "inline": undefined, "properties": { "createdOn": { "docs": "Date that the Form was created on", @@ -7902,6 +8008,7 @@ service: }, "FormsGetResponseFieldsValue": { "docs": "An object containing field info for a specific fieldID.", + "inline": true, "properties": { "displayName": { "docs": "The field name displayed on the site", @@ -7939,6 +8046,7 @@ service: }, "FormsGetResponseResponseSettings": { "docs": "Settings for form responses", + "inline": true, "properties": { "redirectAction": { "docs": "The action to take after form submission", @@ -7963,6 +8071,7 @@ service: }, "FormsGetSubmissionResponse": { "docs": "A form submission", + "inline": undefined, "properties": { "dateSubmitted": { "docs": "Date that the Form was submitted on", @@ -7995,6 +8104,7 @@ service: }, "FormsListResponse": { "docs": "A list of forms", + "inline": undefined, "properties": { "forms": "optional>", "pagination": { @@ -8008,6 +8118,7 @@ service: }, "FormsListResponseFormsItem": { "docs": "A Webflow form", + "inline": true, "properties": { "createdOn": { "docs": "Date that the Form was created on", @@ -8064,6 +8175,7 @@ service: }, "FormsListResponseFormsItemFieldsValue": { "docs": "An object containing field info for a specific fieldID.", + "inline": true, "properties": { "displayName": { "docs": "The field name displayed on the site", @@ -8101,6 +8213,7 @@ service: }, "FormsListResponseFormsItemResponseSettings": { "docs": "Settings for form responses", + "inline": true, "properties": { "redirectAction": { "docs": "The action to take after form submission", @@ -8125,6 +8238,7 @@ service: }, "FormsListResponsePagination": { "docs": "Pagination object", + "inline": true, "properties": { "limit": { "docs": "The limit used for pagination", @@ -8145,6 +8259,7 @@ service: }, "FormsListSubmissionsResponse": { "docs": "A list of form submissions", + "inline": undefined, "properties": { "formSubmissions": "optional>", "pagination": { @@ -8158,6 +8273,7 @@ service: }, "FormsListSubmissionsResponseFormSubmissionsItem": { "docs": undefined, + "inline": true, "properties": { "dateSubmitted": { "docs": "Date that the Form was submitted on", @@ -8190,6 +8306,7 @@ service: }, "FormsListSubmissionsResponsePagination": { "docs": "Pagination object", + "inline": true, "properties": { "limit": { "docs": "The limit used for pagination", @@ -8210,6 +8327,7 @@ service: }, "FormsUpdateSubmissionResponse": { "docs": "A form submission", + "inline": undefined, "properties": { "dateSubmitted": { "docs": "Date that the Form was submitted on", @@ -8327,6 +8445,7 @@ service: docs: Whether the field is visible to the user source: openapi: ../openapi.yml + inline: true FormsListResponseFormsItemResponseSettings: docs: Settings for form responses properties: @@ -8344,6 +8463,7 @@ service: docs: Whether to send an email confirmation to the user source: openapi: ../openapi.yml + inline: true FormsListResponseFormsItem: docs: A Webflow form properties: @@ -8385,6 +8505,7 @@ service: docs: The unique id of the Workspace the Site belongs to source: openapi: ../openapi.yml + inline: true FormsListResponsePagination: docs: Pagination object properties: @@ -8399,6 +8520,7 @@ service: docs: The total number of records source: openapi: ../openapi.yml + inline: true FormsListResponse: docs: A list of forms properties: @@ -8435,6 +8557,7 @@ service: docs: Whether the field is visible to the user source: openapi: ../openapi.yml + inline: true FormsGetResponseResponseSettings: docs: Settings for form responses properties: @@ -8452,6 +8575,7 @@ service: docs: Whether to send an email confirmation to the user source: openapi: ../openapi.yml + inline: true FormsGetResponse: docs: A form and its corresponding metadata properties: @@ -8515,6 +8639,7 @@ service: docs: The data submitted in the Form source: openapi: ../openapi.yml + inline: true FormsListSubmissionsResponsePagination: docs: Pagination object properties: @@ -8529,6 +8654,7 @@ service: docs: The total number of records source: openapi: ../openapi.yml + inline: true FormsListSubmissionsResponse: docs: A list of form submissions properties: @@ -8613,6 +8739,7 @@ service: docs: The unique id of the Form element source: openapi: ../openapi.yml + inline: true FormSubmissionPayload: docs: The Webhook payload for when a form is submitted properties: @@ -9106,6 +9233,7 @@ Required scope | `ecommerce:write` "types": { "EcommInventoryChangedPayload": { "docs": "The availabile inventory for an item", + "inline": undefined, "properties": { "id": { "docs": "Unique identifier for a SKU item", @@ -9136,6 +9264,7 @@ Required scope | `ecommerce:write` }, "InventoryListResponse": { "docs": "The availabile inventory for an item", + "inline": undefined, "properties": { "id": { "docs": "Unique identifier for a SKU item", @@ -9176,6 +9305,7 @@ Required scope | `ecommerce:write` }, "InventoryUpdateResponse": { "docs": "The availabile inventory for an item", + "inline": undefined, "properties": { "id": { "docs": "Unique identifier for a SKU item", @@ -9431,6 +9561,7 @@ webhooks: "CollectionItemChangedPayload": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -9471,6 +9602,7 @@ webhooks: "CollectionItemChangedPayloadFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -9488,6 +9620,7 @@ webhooks: "CollectionItemCreatedPayload": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -9528,6 +9661,7 @@ webhooks: "CollectionItemCreatedPayloadFieldData": { "docs": undefined, "extra-properties": true, + "inline": true, "properties": { "name": { "docs": "Name of the Item", @@ -9544,6 +9678,7 @@ webhooks: }, "CollectionItemDeletedPayload": { "docs": undefined, + "inline": undefined, "properties": { "payload": { "docs": "The payload of data sent from Webflow", @@ -9560,6 +9695,7 @@ webhooks: }, "CollectionItemDeletedPayloadPayload": { "docs": "The payload of data sent from Webflow", + "inline": true, "properties": { "collectionId": { "docs": "The ID of the collection", @@ -9584,6 +9720,7 @@ webhooks: }, "CollectionItemUnpublishedPayload": { "docs": undefined, + "inline": undefined, "properties": { "payload": { "docs": "The payload of data sent from Webflow", @@ -9600,6 +9737,7 @@ webhooks: }, "CollectionItemUnpublishedPayloadPayload": { "docs": "The payload of data sent from Webflow", + "inline": true, "properties": { "collectionId": { "docs": "The ID of the collection", @@ -9740,6 +9878,7 @@ webhooks: extra-properties: true source: openapi: ../openapi.yml + inline: true CollectionItemCreatedPayload: docs: > The fields that define the schema for a given Item are based on the @@ -9786,6 +9925,7 @@ webhooks: extra-properties: true source: openapi: ../openapi.yml + inline: true CollectionItemChangedPayload: docs: > The fields that define the schema for a given Item are based on the @@ -9836,6 +9976,7 @@ webhooks: docs: The ID of the collection source: openapi: ../openapi.yml + inline: true CollectionItemDeletedPayload: properties: triggerType: @@ -9863,6 +10004,7 @@ webhooks: docs: The ID of the collection source: openapi: ../openapi.yml + inline: true CollectionItemUnpublishedPayload: properties: triggerType: @@ -11878,6 +12020,7 @@ Required scope | `ecommerce:write` "types": { "EcommNewOrderPayload": { "docs": undefined, + "inline": undefined, "properties": { "acceptedOn": { "docs": "The ISO8601 timestamp that an Order was placed.", @@ -12031,6 +12174,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadAllAddressesItem": { "docs": "A customer address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -12095,6 +12239,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadApplicationFee": { "docs": "The application fee assessed by the platform", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -12115,6 +12260,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadBillingAddress": { "docs": "The billing address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -12179,6 +12325,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadCustomerInfo": { "docs": "An object with the keys `fullName` and `email`.", + "inline": true, "properties": { "email": { "docs": "The Customer's email address", @@ -12201,6 +12348,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadCustomerPaid": { "docs": "The total paid by the customer", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -12238,6 +12386,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadDownloadFilesItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier for the downloadable file", @@ -12264,6 +12413,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadMetadata": { "docs": undefined, + "inline": true, "properties": { "isBuyNow": "optional", }, @@ -12273,6 +12423,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadNetAmount": { "docs": "The net amount after application fees", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -12293,6 +12444,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadPaypalDetails": { "docs": undefined, + "inline": true, "properties": { "captureId": { "docs": "PayPal capture identifier", @@ -12325,6 +12477,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadPurchasedItemsItem": { "docs": "An Item that was purchased", + "inline": true, "properties": { "count": { "docs": "Number of Item purchased.", @@ -12390,6 +12543,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadPurchasedItemsItemRowTotal": { "docs": "The total for the row", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -12410,6 +12564,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadPurchasedItemsItemVariantImage": { "docs": undefined, + "inline": true, "properties": { "file": "optional", "url": { @@ -12429,6 +12584,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadPurchasedItemsItemVariantImageFile": { "docs": undefined, + "inline": true, "properties": { "contentType": { "docs": "The MIME type of the image", @@ -12465,6 +12621,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadPurchasedItemsItemVariantImageFileVariantsItem": { "docs": undefined, + "inline": true, "properties": { "height": { "docs": "The image height in pixels", @@ -12496,6 +12653,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadPurchasedItemsItemVariantPrice": { "docs": "The price corresponding to the variant", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -12516,6 +12674,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadShippingAddress": { "docs": "The shipping address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -12599,6 +12758,7 @@ Required scope | `ecommerce:write` "EcommNewOrderPayloadStripeCard": { "docs": "Details on the card used to fulfill this order, if this order was finalized with Stripe. ", + "inline": true, "properties": { "brand": { "docs": "The card's brand (ie. credit card network)", @@ -12644,6 +12804,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadStripeCardExpires": { "docs": "The card's expiration date.", + "inline": true, "properties": { "month": { "docs": "Month that the card expires", @@ -12660,6 +12821,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadStripeDetails": { "docs": "An object with various Stripe IDs, useful for linking into the stripe dashboard.", + "inline": true, "properties": { "chargeId": { "docs": "Stripe-generated charge identifier, or null", @@ -12700,6 +12862,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadTotals": { "docs": "An object describing various pricing totals", + "inline": true, "properties": { "extras": { "docs": "An array of extra items, includes discounts, shipping, and taxes.", @@ -12720,6 +12883,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadTotalsExtrasItem": { "docs": "Extra order items, includes discounts, shipping, and taxes.", + "inline": true, "properties": { "description": { "docs": "A human-readable (but English) description of this extra charge.", @@ -12744,6 +12908,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadTotalsExtrasItemPrice": { "docs": "The price for the item", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -12779,6 +12944,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadTotalsSubtotal": { "docs": "The subtotal price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -12799,6 +12965,7 @@ Required scope | `ecommerce:write` }, "EcommNewOrderPayloadTotalsTotal": { "docs": "The total price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -12819,6 +12986,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayload": { "docs": undefined, + "inline": undefined, "properties": { "acceptedOn": { "docs": "The ISO8601 timestamp that an Order was placed.", @@ -12972,6 +13140,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadAllAddressesItem": { "docs": "A customer address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -13036,6 +13205,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadApplicationFee": { "docs": "The application fee assessed by the platform", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -13056,6 +13226,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadBillingAddress": { "docs": "The billing address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -13120,6 +13291,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadCustomerInfo": { "docs": "An object with the keys `fullName` and `email`.", + "inline": true, "properties": { "email": { "docs": "The Customer's email address", @@ -13142,6 +13314,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadCustomerPaid": { "docs": "The total paid by the customer", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -13179,6 +13352,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadDownloadFilesItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier for the downloadable file", @@ -13205,6 +13379,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadMetadata": { "docs": undefined, + "inline": true, "properties": { "isBuyNow": "optional", }, @@ -13214,6 +13389,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadNetAmount": { "docs": "The net amount after application fees", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -13234,6 +13410,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadPaypalDetails": { "docs": undefined, + "inline": true, "properties": { "captureId": { "docs": "PayPal capture identifier", @@ -13266,6 +13443,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadPurchasedItemsItem": { "docs": "An Item that was purchased", + "inline": true, "properties": { "count": { "docs": "Number of Item purchased.", @@ -13331,6 +13509,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadPurchasedItemsItemRowTotal": { "docs": "The total for the row", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -13351,6 +13530,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadPurchasedItemsItemVariantImage": { "docs": undefined, + "inline": true, "properties": { "file": "optional", "url": { @@ -13370,6 +13550,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadPurchasedItemsItemVariantImageFile": { "docs": undefined, + "inline": true, "properties": { "contentType": { "docs": "The MIME type of the image", @@ -13406,6 +13587,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadPurchasedItemsItemVariantImageFileVariantsItem": { "docs": undefined, + "inline": true, "properties": { "height": { "docs": "The image height in pixels", @@ -13437,6 +13619,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadPurchasedItemsItemVariantPrice": { "docs": "The price corresponding to the variant", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -13457,6 +13640,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadShippingAddress": { "docs": "The shipping address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -13540,6 +13724,7 @@ Required scope | `ecommerce:write` "EcommOrderChangedPayloadStripeCard": { "docs": "Details on the card used to fulfill this order, if this order was finalized with Stripe. ", + "inline": true, "properties": { "brand": { "docs": "The card's brand (ie. credit card network)", @@ -13585,6 +13770,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadStripeCardExpires": { "docs": "The card's expiration date.", + "inline": true, "properties": { "month": { "docs": "Month that the card expires", @@ -13601,6 +13787,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadStripeDetails": { "docs": "An object with various Stripe IDs, useful for linking into the stripe dashboard.", + "inline": true, "properties": { "chargeId": { "docs": "Stripe-generated charge identifier, or null", @@ -13641,6 +13828,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadTotals": { "docs": "An object describing various pricing totals", + "inline": true, "properties": { "extras": { "docs": "An array of extra items, includes discounts, shipping, and taxes.", @@ -13661,6 +13849,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadTotalsExtrasItem": { "docs": "Extra order items, includes discounts, shipping, and taxes.", + "inline": true, "properties": { "description": { "docs": "A human-readable (but English) description of this extra charge.", @@ -13685,6 +13874,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadTotalsExtrasItemPrice": { "docs": "The price for the item", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -13720,6 +13910,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadTotalsSubtotal": { "docs": "The subtotal price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -13740,6 +13931,7 @@ Required scope | `ecommerce:write` }, "EcommOrderChangedPayloadTotalsTotal": { "docs": "The total price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -13760,6 +13952,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "acceptedOn": { "docs": "The ISO8601 timestamp that an Order was placed.", @@ -13913,6 +14106,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseAllAddressesItem": { "docs": "A customer address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -13977,6 +14171,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseApplicationFee": { "docs": "The application fee assessed by the platform", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -13997,6 +14192,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseBillingAddress": { "docs": "The billing address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -14061,6 +14257,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseCustomerInfo": { "docs": "An object with the keys `fullName` and `email`.", + "inline": true, "properties": { "email": { "docs": "The Customer's email address", @@ -14083,6 +14280,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseCustomerPaid": { "docs": "The total paid by the customer", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -14120,6 +14318,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseDownloadFilesItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier for the downloadable file", @@ -14146,6 +14345,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseMetadata": { "docs": undefined, + "inline": true, "properties": { "isBuyNow": "optional", }, @@ -14155,6 +14355,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseNetAmount": { "docs": "The net amount after application fees", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -14175,6 +14376,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponsePaypalDetails": { "docs": undefined, + "inline": true, "properties": { "captureId": { "docs": "PayPal capture identifier", @@ -14207,6 +14409,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponsePurchasedItemsItem": { "docs": "An Item that was purchased", + "inline": true, "properties": { "count": { "docs": "Number of Item purchased.", @@ -14272,6 +14475,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponsePurchasedItemsItemRowTotal": { "docs": "The total for the row", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -14292,6 +14496,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponsePurchasedItemsItemVariantImage": { "docs": undefined, + "inline": true, "properties": { "file": "optional", "url": { @@ -14311,6 +14516,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponsePurchasedItemsItemVariantImageFile": { "docs": undefined, + "inline": true, "properties": { "contentType": { "docs": "The MIME type of the image", @@ -14347,6 +14553,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponsePurchasedItemsItemVariantImageFileVariantsItem": { "docs": undefined, + "inline": true, "properties": { "height": { "docs": "The image height in pixels", @@ -14378,6 +14585,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponsePurchasedItemsItemVariantPrice": { "docs": "The price corresponding to the variant", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -14398,6 +14606,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseShippingAddress": { "docs": "The shipping address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -14481,6 +14690,7 @@ Required scope | `ecommerce:write` "OrdersGetResponseStripeCard": { "docs": "Details on the card used to fulfill this order, if this order was finalized with Stripe. ", + "inline": true, "properties": { "brand": { "docs": "The card's brand (ie. credit card network)", @@ -14526,6 +14736,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseStripeCardExpires": { "docs": "The card's expiration date.", + "inline": true, "properties": { "month": { "docs": "Month that the card expires", @@ -14542,6 +14753,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseStripeDetails": { "docs": "An object with various Stripe IDs, useful for linking into the stripe dashboard.", + "inline": true, "properties": { "chargeId": { "docs": "Stripe-generated charge identifier, or null", @@ -14582,6 +14794,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseTotals": { "docs": "An object describing various pricing totals", + "inline": true, "properties": { "extras": { "docs": "An array of extra items, includes discounts, shipping, and taxes.", @@ -14602,6 +14815,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseTotalsExtrasItem": { "docs": "Extra order items, includes discounts, shipping, and taxes.", + "inline": true, "properties": { "description": { "docs": "A human-readable (but English) description of this extra charge.", @@ -14626,6 +14840,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseTotalsExtrasItemPrice": { "docs": "The price for the item", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -14661,6 +14876,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseTotalsSubtotal": { "docs": "The subtotal price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -14681,6 +14897,7 @@ Required scope | `ecommerce:write` }, "OrdersGetResponseTotalsTotal": { "docs": "The total price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -14717,6 +14934,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponse": { "docs": "Results from order list", + "inline": undefined, "properties": { "orders": { "docs": "List of orders", @@ -14733,6 +14951,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItem": { "docs": undefined, + "inline": true, "properties": { "acceptedOn": { "docs": "The ISO8601 timestamp that an Order was placed.", @@ -14886,6 +15105,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemAllAddressesItem": { "docs": "A customer address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -14950,6 +15170,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemApplicationFee": { "docs": "The application fee assessed by the platform", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -14970,6 +15191,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemBillingAddress": { "docs": "The billing address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -15034,6 +15256,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemCustomerInfo": { "docs": "An object with the keys `fullName` and `email`.", + "inline": true, "properties": { "email": { "docs": "The Customer's email address", @@ -15056,6 +15279,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemCustomerPaid": { "docs": "The total paid by the customer", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -15093,6 +15317,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemDownloadFilesItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier for the downloadable file", @@ -15119,6 +15344,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemMetadata": { "docs": undefined, + "inline": true, "properties": { "isBuyNow": "optional", }, @@ -15128,6 +15354,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemNetAmount": { "docs": "The net amount after application fees", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -15148,6 +15375,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemPaypalDetails": { "docs": undefined, + "inline": true, "properties": { "captureId": { "docs": "PayPal capture identifier", @@ -15180,6 +15408,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemPurchasedItemsItem": { "docs": "An Item that was purchased", + "inline": true, "properties": { "count": { "docs": "Number of Item purchased.", @@ -15245,6 +15474,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemPurchasedItemsItemRowTotal": { "docs": "The total for the row", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -15265,6 +15495,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemPurchasedItemsItemVariantImage": { "docs": undefined, + "inline": true, "properties": { "file": "optional", "url": { @@ -15284,6 +15515,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemPurchasedItemsItemVariantImageFile": { "docs": undefined, + "inline": true, "properties": { "contentType": { "docs": "The MIME type of the image", @@ -15320,6 +15552,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemPurchasedItemsItemVariantImageFileVariantsItem": { "docs": undefined, + "inline": true, "properties": { "height": { "docs": "The image height in pixels", @@ -15351,6 +15584,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemPurchasedItemsItemVariantPrice": { "docs": "The price corresponding to the variant", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -15371,6 +15605,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemShippingAddress": { "docs": "The shipping address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -15454,6 +15689,7 @@ Required scope | `ecommerce:write` "OrdersListResponseOrdersItemStripeCard": { "docs": "Details on the card used to fulfill this order, if this order was finalized with Stripe. ", + "inline": true, "properties": { "brand": { "docs": "The card's brand (ie. credit card network)", @@ -15499,6 +15735,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemStripeCardExpires": { "docs": "The card's expiration date.", + "inline": true, "properties": { "month": { "docs": "Month that the card expires", @@ -15515,6 +15752,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemStripeDetails": { "docs": "An object with various Stripe IDs, useful for linking into the stripe dashboard.", + "inline": true, "properties": { "chargeId": { "docs": "Stripe-generated charge identifier, or null", @@ -15555,6 +15793,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemTotals": { "docs": "An object describing various pricing totals", + "inline": true, "properties": { "extras": { "docs": "An array of extra items, includes discounts, shipping, and taxes.", @@ -15575,6 +15814,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemTotalsExtrasItem": { "docs": "Extra order items, includes discounts, shipping, and taxes.", + "inline": true, "properties": { "description": { "docs": "A human-readable (but English) description of this extra charge.", @@ -15599,6 +15839,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemTotalsExtrasItemPrice": { "docs": "The price for the item", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -15634,6 +15875,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemTotalsSubtotal": { "docs": "The subtotal price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -15654,6 +15896,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponseOrdersItemTotalsTotal": { "docs": "The total price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -15674,6 +15917,7 @@ Required scope | `ecommerce:write` }, "OrdersListResponsePagination": { "docs": "Pagination object", + "inline": true, "properties": { "limit": { "docs": "The limit used for pagination", @@ -15705,6 +15949,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponse": { "docs": undefined, + "inline": undefined, "properties": { "acceptedOn": { "docs": "The ISO8601 timestamp that an Order was placed.", @@ -15858,6 +16103,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseAllAddressesItem": { "docs": "A customer address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -15922,6 +16168,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseApplicationFee": { "docs": "The application fee assessed by the platform", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -15942,6 +16189,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseBillingAddress": { "docs": "The billing address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -16006,6 +16254,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseCustomerInfo": { "docs": "An object with the keys `fullName` and `email`.", + "inline": true, "properties": { "email": { "docs": "The Customer's email address", @@ -16028,6 +16277,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseCustomerPaid": { "docs": "The total paid by the customer", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -16065,6 +16315,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseDownloadFilesItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier for the downloadable file", @@ -16091,6 +16342,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseMetadata": { "docs": undefined, + "inline": true, "properties": { "isBuyNow": "optional", }, @@ -16100,6 +16352,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseNetAmount": { "docs": "The net amount after application fees", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -16120,6 +16373,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponsePaypalDetails": { "docs": undefined, + "inline": true, "properties": { "captureId": { "docs": "PayPal capture identifier", @@ -16152,6 +16406,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponsePurchasedItemsItem": { "docs": "An Item that was purchased", + "inline": true, "properties": { "count": { "docs": "Number of Item purchased.", @@ -16217,6 +16472,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponsePurchasedItemsItemRowTotal": { "docs": "The total for the row", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -16237,6 +16493,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponsePurchasedItemsItemVariantImage": { "docs": undefined, + "inline": true, "properties": { "file": "optional", "url": { @@ -16256,6 +16513,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponsePurchasedItemsItemVariantImageFile": { "docs": undefined, + "inline": true, "properties": { "contentType": { "docs": "The MIME type of the image", @@ -16292,6 +16550,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponsePurchasedItemsItemVariantImageFileVariantsItem": { "docs": undefined, + "inline": true, "properties": { "height": { "docs": "The image height in pixels", @@ -16323,6 +16582,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponsePurchasedItemsItemVariantPrice": { "docs": "The price corresponding to the variant", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -16343,6 +16603,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseShippingAddress": { "docs": "The shipping address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -16426,6 +16687,7 @@ Required scope | `ecommerce:write` "OrdersRefundResponseStripeCard": { "docs": "Details on the card used to fulfill this order, if this order was finalized with Stripe. ", + "inline": true, "properties": { "brand": { "docs": "The card's brand (ie. credit card network)", @@ -16471,6 +16733,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseStripeCardExpires": { "docs": "The card's expiration date.", + "inline": true, "properties": { "month": { "docs": "Month that the card expires", @@ -16487,6 +16750,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseStripeDetails": { "docs": "An object with various Stripe IDs, useful for linking into the stripe dashboard.", + "inline": true, "properties": { "chargeId": { "docs": "Stripe-generated charge identifier, or null", @@ -16527,6 +16791,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseTotals": { "docs": "An object describing various pricing totals", + "inline": true, "properties": { "extras": { "docs": "An array of extra items, includes discounts, shipping, and taxes.", @@ -16547,6 +16812,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseTotalsExtrasItem": { "docs": "Extra order items, includes discounts, shipping, and taxes.", + "inline": true, "properties": { "description": { "docs": "A human-readable (but English) description of this extra charge.", @@ -16571,6 +16837,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseTotalsExtrasItemPrice": { "docs": "The price for the item", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -16606,6 +16873,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseTotalsSubtotal": { "docs": "The subtotal price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -16626,6 +16894,7 @@ Required scope | `ecommerce:write` }, "OrdersRefundResponseTotalsTotal": { "docs": "The total price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -16646,6 +16915,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponse": { "docs": undefined, + "inline": undefined, "properties": { "acceptedOn": { "docs": "The ISO8601 timestamp that an Order was placed.", @@ -16799,6 +17069,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseAllAddressesItem": { "docs": "A customer address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -16863,6 +17134,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseApplicationFee": { "docs": "The application fee assessed by the platform", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -16883,6 +17155,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseBillingAddress": { "docs": "The billing address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -16947,6 +17220,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseCustomerInfo": { "docs": "An object with the keys `fullName` and `email`.", + "inline": true, "properties": { "email": { "docs": "The Customer's email address", @@ -16969,6 +17243,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseCustomerPaid": { "docs": "The total paid by the customer", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -17006,6 +17281,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseDownloadFilesItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier for the downloadable file", @@ -17032,6 +17308,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseMetadata": { "docs": undefined, + "inline": true, "properties": { "isBuyNow": "optional", }, @@ -17041,6 +17318,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseNetAmount": { "docs": "The net amount after application fees", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -17061,6 +17339,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponsePaypalDetails": { "docs": undefined, + "inline": true, "properties": { "captureId": { "docs": "PayPal capture identifier", @@ -17093,6 +17372,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponsePurchasedItemsItem": { "docs": "An Item that was purchased", + "inline": true, "properties": { "count": { "docs": "Number of Item purchased.", @@ -17158,6 +17438,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponsePurchasedItemsItemRowTotal": { "docs": "The total for the row", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -17178,6 +17459,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponsePurchasedItemsItemVariantImage": { "docs": undefined, + "inline": true, "properties": { "file": "optional", "url": { @@ -17197,6 +17479,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponsePurchasedItemsItemVariantImageFile": { "docs": undefined, + "inline": true, "properties": { "contentType": { "docs": "The MIME type of the image", @@ -17233,6 +17516,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponsePurchasedItemsItemVariantImageFileVariantsItem": { "docs": undefined, + "inline": true, "properties": { "height": { "docs": "The image height in pixels", @@ -17264,6 +17548,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponsePurchasedItemsItemVariantPrice": { "docs": "The price corresponding to the variant", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -17284,6 +17569,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseShippingAddress": { "docs": "The shipping address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -17367,6 +17653,7 @@ Required scope | `ecommerce:write` "OrdersUpdateFulfillResponseStripeCard": { "docs": "Details on the card used to fulfill this order, if this order was finalized with Stripe. ", + "inline": true, "properties": { "brand": { "docs": "The card's brand (ie. credit card network)", @@ -17412,6 +17699,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseStripeCardExpires": { "docs": "The card's expiration date.", + "inline": true, "properties": { "month": { "docs": "Month that the card expires", @@ -17428,6 +17716,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseStripeDetails": { "docs": "An object with various Stripe IDs, useful for linking into the stripe dashboard.", + "inline": true, "properties": { "chargeId": { "docs": "Stripe-generated charge identifier, or null", @@ -17468,6 +17757,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseTotals": { "docs": "An object describing various pricing totals", + "inline": true, "properties": { "extras": { "docs": "An array of extra items, includes discounts, shipping, and taxes.", @@ -17488,6 +17778,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseTotalsExtrasItem": { "docs": "Extra order items, includes discounts, shipping, and taxes.", + "inline": true, "properties": { "description": { "docs": "A human-readable (but English) description of this extra charge.", @@ -17512,6 +17803,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseTotalsExtrasItemPrice": { "docs": "The price for the item", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -17547,6 +17839,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseTotalsSubtotal": { "docs": "The subtotal price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -17567,6 +17860,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateFulfillResponseTotalsTotal": { "docs": "The total price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -17587,6 +17881,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponse": { "docs": undefined, + "inline": undefined, "properties": { "acceptedOn": { "docs": "The ISO8601 timestamp that an Order was placed.", @@ -17740,6 +18035,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseAllAddressesItem": { "docs": "A customer address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -17804,6 +18100,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseApplicationFee": { "docs": "The application fee assessed by the platform", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -17824,6 +18121,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseBillingAddress": { "docs": "The billing address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -17888,6 +18186,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseCustomerInfo": { "docs": "An object with the keys `fullName` and `email`.", + "inline": true, "properties": { "email": { "docs": "The Customer's email address", @@ -17910,6 +18209,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseCustomerPaid": { "docs": "The total paid by the customer", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -17947,6 +18247,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseDownloadFilesItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier for the downloadable file", @@ -17973,6 +18274,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseMetadata": { "docs": undefined, + "inline": true, "properties": { "isBuyNow": "optional", }, @@ -17982,6 +18284,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseNetAmount": { "docs": "The net amount after application fees", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -18002,6 +18305,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponsePaypalDetails": { "docs": undefined, + "inline": true, "properties": { "captureId": { "docs": "PayPal capture identifier", @@ -18034,6 +18338,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponsePurchasedItemsItem": { "docs": "An Item that was purchased", + "inline": true, "properties": { "count": { "docs": "Number of Item purchased.", @@ -18099,6 +18404,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponsePurchasedItemsItemRowTotal": { "docs": "The total for the row", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -18119,6 +18425,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponsePurchasedItemsItemVariantImage": { "docs": undefined, + "inline": true, "properties": { "file": "optional", "url": { @@ -18138,6 +18445,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponsePurchasedItemsItemVariantImageFile": { "docs": undefined, + "inline": true, "properties": { "contentType": { "docs": "The MIME type of the image", @@ -18174,6 +18482,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponsePurchasedItemsItemVariantImageFileVariantsItem": { "docs": undefined, + "inline": true, "properties": { "height": { "docs": "The image height in pixels", @@ -18205,6 +18514,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponsePurchasedItemsItemVariantPrice": { "docs": "The price corresponding to the variant", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -18225,6 +18535,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseShippingAddress": { "docs": "The shipping address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -18308,6 +18619,7 @@ Required scope | `ecommerce:write` "OrdersUpdateResponseStripeCard": { "docs": "Details on the card used to fulfill this order, if this order was finalized with Stripe. ", + "inline": true, "properties": { "brand": { "docs": "The card's brand (ie. credit card network)", @@ -18353,6 +18665,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseStripeCardExpires": { "docs": "The card's expiration date.", + "inline": true, "properties": { "month": { "docs": "Month that the card expires", @@ -18369,6 +18682,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseStripeDetails": { "docs": "An object with various Stripe IDs, useful for linking into the stripe dashboard.", + "inline": true, "properties": { "chargeId": { "docs": "Stripe-generated charge identifier, or null", @@ -18409,6 +18723,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseTotals": { "docs": "An object describing various pricing totals", + "inline": true, "properties": { "extras": { "docs": "An array of extra items, includes discounts, shipping, and taxes.", @@ -18429,6 +18744,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseTotalsExtrasItem": { "docs": "Extra order items, includes discounts, shipping, and taxes.", + "inline": true, "properties": { "description": { "docs": "A human-readable (but English) description of this extra charge.", @@ -18453,6 +18769,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseTotalsExtrasItemPrice": { "docs": "The price for the item", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -18488,6 +18805,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseTotalsSubtotal": { "docs": "The subtotal price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -18508,6 +18826,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateResponseTotalsTotal": { "docs": "The total price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -18528,6 +18847,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponse": { "docs": undefined, + "inline": undefined, "properties": { "acceptedOn": { "docs": "The ISO8601 timestamp that an Order was placed.", @@ -18681,6 +19001,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseAllAddressesItem": { "docs": "A customer address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -18745,6 +19066,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseApplicationFee": { "docs": "The application fee assessed by the platform", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -18765,6 +19087,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseBillingAddress": { "docs": "The billing address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -18829,6 +19152,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseCustomerInfo": { "docs": "An object with the keys `fullName` and `email`.", + "inline": true, "properties": { "email": { "docs": "The Customer's email address", @@ -18851,6 +19175,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseCustomerPaid": { "docs": "The total paid by the customer", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -18888,6 +19213,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseDownloadFilesItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier for the downloadable file", @@ -18914,6 +19240,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseMetadata": { "docs": undefined, + "inline": true, "properties": { "isBuyNow": "optional", }, @@ -18923,6 +19250,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseNetAmount": { "docs": "The net amount after application fees", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -18943,6 +19271,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponsePaypalDetails": { "docs": undefined, + "inline": true, "properties": { "captureId": { "docs": "PayPal capture identifier", @@ -18975,6 +19304,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponsePurchasedItemsItem": { "docs": "An Item that was purchased", + "inline": true, "properties": { "count": { "docs": "Number of Item purchased.", @@ -19040,6 +19370,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponsePurchasedItemsItemRowTotal": { "docs": "The total for the row", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -19060,6 +19391,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponsePurchasedItemsItemVariantImage": { "docs": undefined, + "inline": true, "properties": { "file": "optional", "url": { @@ -19079,6 +19411,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponsePurchasedItemsItemVariantImageFile": { "docs": undefined, + "inline": true, "properties": { "contentType": { "docs": "The MIME type of the image", @@ -19115,6 +19448,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponsePurchasedItemsItemVariantImageFileVariantsItem": { "docs": undefined, + "inline": true, "properties": { "height": { "docs": "The image height in pixels", @@ -19146,6 +19480,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponsePurchasedItemsItemVariantPrice": { "docs": "The price corresponding to the variant", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -19166,6 +19501,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseShippingAddress": { "docs": "The shipping address", + "inline": true, "properties": { "addressee": { "docs": "Display name on the address", @@ -19249,6 +19585,7 @@ Required scope | `ecommerce:write` "OrdersUpdateUnfulfillResponseStripeCard": { "docs": "Details on the card used to fulfill this order, if this order was finalized with Stripe. ", + "inline": true, "properties": { "brand": { "docs": "The card's brand (ie. credit card network)", @@ -19294,6 +19631,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseStripeCardExpires": { "docs": "The card's expiration date.", + "inline": true, "properties": { "month": { "docs": "Month that the card expires", @@ -19310,6 +19648,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseStripeDetails": { "docs": "An object with various Stripe IDs, useful for linking into the stripe dashboard.", + "inline": true, "properties": { "chargeId": { "docs": "Stripe-generated charge identifier, or null", @@ -19350,6 +19689,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseTotals": { "docs": "An object describing various pricing totals", + "inline": true, "properties": { "extras": { "docs": "An array of extra items, includes discounts, shipping, and taxes.", @@ -19370,6 +19710,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseTotalsExtrasItem": { "docs": "Extra order items, includes discounts, shipping, and taxes.", + "inline": true, "properties": { "description": { "docs": "A human-readable (but English) description of this extra charge.", @@ -19394,6 +19735,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseTotalsExtrasItemPrice": { "docs": "The price for the item", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -19429,6 +19771,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseTotalsSubtotal": { "docs": "The subtotal price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -19449,6 +19792,7 @@ Required scope | `ecommerce:write` }, "OrdersUpdateUnfulfillResponseTotalsTotal": { "docs": "The total price", + "inline": true, "properties": { "string": { "docs": "The user-facing string representation of the amount", @@ -19977,6 +20321,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemNetAmount: docs: The net amount after application fees properties: @@ -19991,6 +20336,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemApplicationFee: docs: The application fee assessed by the platform properties: @@ -20005,6 +20351,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemAllAddressesItemType: enum: - shipping @@ -20055,6 +20402,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemShippingAddressType: enum: - shipping @@ -20105,6 +20453,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemBillingAddressType: enum: - shipping @@ -20155,6 +20504,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemCustomerInfo: docs: An object with the keys `fullName` and `email`. properties: @@ -20168,6 +20518,7 @@ Required scope | `ecommerce:write` format: email source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemPurchasedItemsItemRowTotal: docs: The total for the row properties: @@ -20182,6 +20533,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemPurchasedItemsItemVariantImageFileVariantsItem: properties: url: @@ -20201,6 +20553,7 @@ Required scope | `ecommerce:write` docs: The image height in pixels source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemPurchasedItemsItemVariantImageFile: properties: size: @@ -20227,6 +20580,7 @@ Required scope | `ecommerce:write` docs: Variants of the supplied image source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemPurchasedItemsItemVariantImage: properties: url: @@ -20237,6 +20591,7 @@ Required scope | `ecommerce:write` file: optional source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemPurchasedItemsItemVariantPrice: docs: The price corresponding to the variant properties: @@ -20251,6 +20606,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemPurchasedItemsItem: docs: An Item that was purchased properties: @@ -20299,6 +20655,7 @@ Required scope | `ecommerce:write` docs: The physical length of the variant if provided, or null source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemStripeDetails: docs: >- An object with various Stripe IDs, useful for linking into the stripe @@ -20330,6 +20687,7 @@ Required scope | `ecommerce:write` docs: Stripe-generated refund reason, or null source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemStripeCardBrand: enum: - Visa @@ -20355,6 +20713,7 @@ Required scope | `ecommerce:write` docs: Month that the card expires source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemStripeCard: docs: > Details on the card used to fulfill this order, if this order was @@ -20374,6 +20733,7 @@ Required scope | `ecommerce:write` docs: The card's expiration date. source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemPaypalDetails: properties: orderId: @@ -20396,11 +20756,13 @@ Required scope | `ecommerce:write` docs: PayPal dispute identifier source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemMetadata: properties: isBuyNow: optional source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemTotalsSubtotal: docs: The subtotal price properties: @@ -20415,6 +20777,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemTotalsExtrasItemType: enum: - discount @@ -20439,6 +20802,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemTotalsExtrasItem: docs: Extra order items, includes discounts, shipping, and taxes. properties: @@ -20456,6 +20820,7 @@ Required scope | `ecommerce:write` docs: The price for the item source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemTotalsTotal: docs: The total price properties: @@ -20470,6 +20835,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemTotals: docs: An object describing various pricing totals properties: @@ -20484,6 +20850,7 @@ Required scope | `ecommerce:write` docs: The total price source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItemDownloadFilesItem: properties: id: @@ -20499,6 +20866,7 @@ Required scope | `ecommerce:write` format: uri source: openapi: ../openapi.yml + inline: true OrdersListResponseOrdersItem: properties: orderId: @@ -20635,6 +21003,7 @@ Required scope | `ecommerce:write` docs: An array of downloadable file objects. source: openapi: ../openapi.yml + inline: true OrdersListResponsePagination: docs: Pagination object properties: @@ -20649,6 +21018,7 @@ Required scope | `ecommerce:write` docs: The total number of records source: openapi: ../openapi.yml + inline: true OrdersListResponse: docs: Results from order list properties: @@ -20702,6 +21072,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersGetResponseNetAmount: docs: The net amount after application fees properties: @@ -20716,6 +21087,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersGetResponseApplicationFee: docs: The application fee assessed by the platform properties: @@ -20730,6 +21102,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersGetResponseAllAddressesItemType: enum: - shipping @@ -20780,6 +21153,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersGetResponseShippingAddressType: enum: - shipping @@ -20830,6 +21204,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersGetResponseBillingAddressType: enum: - shipping @@ -20880,6 +21255,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersGetResponseCustomerInfo: docs: An object with the keys `fullName` and `email`. properties: @@ -20893,6 +21269,7 @@ Required scope | `ecommerce:write` format: email source: openapi: ../openapi.yml + inline: true OrdersGetResponsePurchasedItemsItemRowTotal: docs: The total for the row properties: @@ -20907,6 +21284,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersGetResponsePurchasedItemsItemVariantImageFileVariantsItem: properties: url: @@ -20926,6 +21304,7 @@ Required scope | `ecommerce:write` docs: The image height in pixels source: openapi: ../openapi.yml + inline: true OrdersGetResponsePurchasedItemsItemVariantImageFile: properties: size: @@ -20952,6 +21331,7 @@ Required scope | `ecommerce:write` docs: Variants of the supplied image source: openapi: ../openapi.yml + inline: true OrdersGetResponsePurchasedItemsItemVariantImage: properties: url: @@ -20962,6 +21342,7 @@ Required scope | `ecommerce:write` file: optional source: openapi: ../openapi.yml + inline: true OrdersGetResponsePurchasedItemsItemVariantPrice: docs: The price corresponding to the variant properties: @@ -20976,6 +21357,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersGetResponsePurchasedItemsItem: docs: An Item that was purchased properties: @@ -21024,6 +21406,7 @@ Required scope | `ecommerce:write` docs: The physical length of the variant if provided, or null source: openapi: ../openapi.yml + inline: true OrdersGetResponseStripeDetails: docs: >- An object with various Stripe IDs, useful for linking into the stripe @@ -21055,6 +21438,7 @@ Required scope | `ecommerce:write` docs: Stripe-generated refund reason, or null source: openapi: ../openapi.yml + inline: true OrdersGetResponseStripeCardBrand: enum: - Visa @@ -21080,6 +21464,7 @@ Required scope | `ecommerce:write` docs: Month that the card expires source: openapi: ../openapi.yml + inline: true OrdersGetResponseStripeCard: docs: > Details on the card used to fulfill this order, if this order was @@ -21099,6 +21484,7 @@ Required scope | `ecommerce:write` docs: The card's expiration date. source: openapi: ../openapi.yml + inline: true OrdersGetResponsePaypalDetails: properties: orderId: @@ -21121,11 +21507,13 @@ Required scope | `ecommerce:write` docs: PayPal dispute identifier source: openapi: ../openapi.yml + inline: true OrdersGetResponseMetadata: properties: isBuyNow: optional source: openapi: ../openapi.yml + inline: true OrdersGetResponseTotalsSubtotal: docs: The subtotal price properties: @@ -21140,6 +21528,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersGetResponseTotalsExtrasItemType: enum: - discount @@ -21164,6 +21553,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersGetResponseTotalsExtrasItem: docs: Extra order items, includes discounts, shipping, and taxes. properties: @@ -21181,6 +21571,7 @@ Required scope | `ecommerce:write` docs: The price for the item source: openapi: ../openapi.yml + inline: true OrdersGetResponseTotalsTotal: docs: The total price properties: @@ -21195,6 +21586,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersGetResponseTotals: docs: An object describing various pricing totals properties: @@ -21209,6 +21601,7 @@ Required scope | `ecommerce:write` docs: The total price source: openapi: ../openapi.yml + inline: true OrdersGetResponseDownloadFilesItem: properties: id: @@ -21224,6 +21617,7 @@ Required scope | `ecommerce:write` format: uri source: openapi: ../openapi.yml + inline: true OrdersGetResponse: properties: orderId: @@ -21402,6 +21796,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseNetAmount: docs: The net amount after application fees properties: @@ -21416,6 +21811,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseApplicationFee: docs: The application fee assessed by the platform properties: @@ -21430,6 +21826,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseAllAddressesItemType: enum: - shipping @@ -21480,6 +21877,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseShippingAddressType: enum: - shipping @@ -21530,6 +21928,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseBillingAddressType: enum: - shipping @@ -21580,6 +21979,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseCustomerInfo: docs: An object with the keys `fullName` and `email`. properties: @@ -21593,6 +21993,7 @@ Required scope | `ecommerce:write` format: email source: openapi: ../openapi.yml + inline: true OrdersUpdateResponsePurchasedItemsItemRowTotal: docs: The total for the row properties: @@ -21607,6 +22008,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateResponsePurchasedItemsItemVariantImageFileVariantsItem: properties: url: @@ -21626,6 +22028,7 @@ Required scope | `ecommerce:write` docs: The image height in pixels source: openapi: ../openapi.yml + inline: true OrdersUpdateResponsePurchasedItemsItemVariantImageFile: properties: size: @@ -21652,6 +22055,7 @@ Required scope | `ecommerce:write` docs: Variants of the supplied image source: openapi: ../openapi.yml + inline: true OrdersUpdateResponsePurchasedItemsItemVariantImage: properties: url: @@ -21662,6 +22066,7 @@ Required scope | `ecommerce:write` file: optional source: openapi: ../openapi.yml + inline: true OrdersUpdateResponsePurchasedItemsItemVariantPrice: docs: The price corresponding to the variant properties: @@ -21676,6 +22081,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateResponsePurchasedItemsItem: docs: An Item that was purchased properties: @@ -21724,6 +22130,7 @@ Required scope | `ecommerce:write` docs: The physical length of the variant if provided, or null source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseStripeDetails: docs: >- An object with various Stripe IDs, useful for linking into the stripe @@ -21755,6 +22162,7 @@ Required scope | `ecommerce:write` docs: Stripe-generated refund reason, or null source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseStripeCardBrand: enum: - Visa @@ -21780,6 +22188,7 @@ Required scope | `ecommerce:write` docs: Month that the card expires source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseStripeCard: docs: > Details on the card used to fulfill this order, if this order was @@ -21799,6 +22208,7 @@ Required scope | `ecommerce:write` docs: The card's expiration date. source: openapi: ../openapi.yml + inline: true OrdersUpdateResponsePaypalDetails: properties: orderId: @@ -21821,11 +22231,13 @@ Required scope | `ecommerce:write` docs: PayPal dispute identifier source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseMetadata: properties: isBuyNow: optional source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseTotalsSubtotal: docs: The subtotal price properties: @@ -21840,6 +22252,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseTotalsExtrasItemType: enum: - discount @@ -21864,6 +22277,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseTotalsExtrasItem: docs: Extra order items, includes discounts, shipping, and taxes. properties: @@ -21881,6 +22295,7 @@ Required scope | `ecommerce:write` docs: The price for the item source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseTotalsTotal: docs: The total price properties: @@ -21895,6 +22310,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseTotals: docs: An object describing various pricing totals properties: @@ -21909,6 +22325,7 @@ Required scope | `ecommerce:write` docs: The total price source: openapi: ../openapi.yml + inline: true OrdersUpdateResponseDownloadFilesItem: properties: id: @@ -21924,6 +22341,7 @@ Required scope | `ecommerce:write` format: uri source: openapi: ../openapi.yml + inline: true OrdersUpdateResponse: properties: orderId: @@ -22102,6 +22520,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseNetAmount: docs: The net amount after application fees properties: @@ -22116,6 +22535,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseApplicationFee: docs: The application fee assessed by the platform properties: @@ -22130,6 +22550,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseAllAddressesItemType: enum: - shipping @@ -22180,6 +22601,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseShippingAddressType: enum: - shipping @@ -22230,6 +22652,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseBillingAddressType: enum: - shipping @@ -22280,6 +22703,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseCustomerInfo: docs: An object with the keys `fullName` and `email`. properties: @@ -22293,6 +22717,7 @@ Required scope | `ecommerce:write` format: email source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponsePurchasedItemsItemRowTotal: docs: The total for the row properties: @@ -22307,6 +22732,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponsePurchasedItemsItemVariantImageFileVariantsItem: properties: url: @@ -22326,6 +22752,7 @@ Required scope | `ecommerce:write` docs: The image height in pixels source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponsePurchasedItemsItemVariantImageFile: properties: size: @@ -22352,6 +22779,7 @@ Required scope | `ecommerce:write` docs: Variants of the supplied image source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponsePurchasedItemsItemVariantImage: properties: url: @@ -22362,6 +22790,7 @@ Required scope | `ecommerce:write` file: optional source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponsePurchasedItemsItemVariantPrice: docs: The price corresponding to the variant properties: @@ -22376,6 +22805,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponsePurchasedItemsItem: docs: An Item that was purchased properties: @@ -22424,6 +22854,7 @@ Required scope | `ecommerce:write` docs: The physical length of the variant if provided, or null source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseStripeDetails: docs: >- An object with various Stripe IDs, useful for linking into the stripe @@ -22455,6 +22886,7 @@ Required scope | `ecommerce:write` docs: Stripe-generated refund reason, or null source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseStripeCardBrand: enum: - Visa @@ -22480,6 +22912,7 @@ Required scope | `ecommerce:write` docs: Month that the card expires source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseStripeCard: docs: > Details on the card used to fulfill this order, if this order was @@ -22499,6 +22932,7 @@ Required scope | `ecommerce:write` docs: The card's expiration date. source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponsePaypalDetails: properties: orderId: @@ -22521,11 +22955,13 @@ Required scope | `ecommerce:write` docs: PayPal dispute identifier source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseMetadata: properties: isBuyNow: optional source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseTotalsSubtotal: docs: The subtotal price properties: @@ -22540,6 +22976,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseTotalsExtrasItemType: enum: - discount @@ -22564,6 +23001,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseTotalsExtrasItem: docs: Extra order items, includes discounts, shipping, and taxes. properties: @@ -22581,6 +23019,7 @@ Required scope | `ecommerce:write` docs: The price for the item source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseTotalsTotal: docs: The total price properties: @@ -22595,6 +23034,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseTotals: docs: An object describing various pricing totals properties: @@ -22609,6 +23049,7 @@ Required scope | `ecommerce:write` docs: The total price source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponseDownloadFilesItem: properties: id: @@ -22624,6 +23065,7 @@ Required scope | `ecommerce:write` format: uri source: openapi: ../openapi.yml + inline: true OrdersUpdateFulfillResponse: properties: orderId: @@ -22802,6 +23244,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseNetAmount: docs: The net amount after application fees properties: @@ -22816,6 +23259,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseApplicationFee: docs: The application fee assessed by the platform properties: @@ -22830,6 +23274,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseAllAddressesItemType: enum: - shipping @@ -22880,6 +23325,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseShippingAddressType: enum: - shipping @@ -22930,6 +23376,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseBillingAddressType: enum: - shipping @@ -22980,6 +23427,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseCustomerInfo: docs: An object with the keys `fullName` and `email`. properties: @@ -22993,6 +23441,7 @@ Required scope | `ecommerce:write` format: email source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponsePurchasedItemsItemRowTotal: docs: The total for the row properties: @@ -23007,6 +23456,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponsePurchasedItemsItemVariantImageFileVariantsItem: properties: url: @@ -23026,6 +23476,7 @@ Required scope | `ecommerce:write` docs: The image height in pixels source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponsePurchasedItemsItemVariantImageFile: properties: size: @@ -23052,6 +23503,7 @@ Required scope | `ecommerce:write` docs: Variants of the supplied image source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponsePurchasedItemsItemVariantImage: properties: url: @@ -23063,6 +23515,7 @@ Required scope | `ecommerce:write` optional source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponsePurchasedItemsItemVariantPrice: docs: The price corresponding to the variant properties: @@ -23077,6 +23530,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponsePurchasedItemsItem: docs: An Item that was purchased properties: @@ -23125,6 +23579,7 @@ Required scope | `ecommerce:write` docs: The physical length of the variant if provided, or null source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseStripeDetails: docs: >- An object with various Stripe IDs, useful for linking into the stripe @@ -23156,6 +23611,7 @@ Required scope | `ecommerce:write` docs: Stripe-generated refund reason, or null source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseStripeCardBrand: enum: - Visa @@ -23181,6 +23637,7 @@ Required scope | `ecommerce:write` docs: Month that the card expires source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseStripeCard: docs: > Details on the card used to fulfill this order, if this order was @@ -23200,6 +23657,7 @@ Required scope | `ecommerce:write` docs: The card's expiration date. source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponsePaypalDetails: properties: orderId: @@ -23222,11 +23680,13 @@ Required scope | `ecommerce:write` docs: PayPal dispute identifier source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseMetadata: properties: isBuyNow: optional source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseTotalsSubtotal: docs: The subtotal price properties: @@ -23241,6 +23701,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseTotalsExtrasItemType: enum: - discount @@ -23265,6 +23726,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseTotalsExtrasItem: docs: Extra order items, includes discounts, shipping, and taxes. properties: @@ -23282,6 +23744,7 @@ Required scope | `ecommerce:write` docs: The price for the item source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseTotalsTotal: docs: The total price properties: @@ -23296,6 +23759,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseTotals: docs: An object describing various pricing totals properties: @@ -23310,6 +23774,7 @@ Required scope | `ecommerce:write` docs: The total price source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponseDownloadFilesItem: properties: id: @@ -23325,6 +23790,7 @@ Required scope | `ecommerce:write` format: uri source: openapi: ../openapi.yml + inline: true OrdersUpdateUnfulfillResponse: properties: orderId: @@ -23511,6 +23977,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersRefundResponseNetAmount: docs: The net amount after application fees properties: @@ -23525,6 +23992,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersRefundResponseApplicationFee: docs: The application fee assessed by the platform properties: @@ -23539,6 +24007,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersRefundResponseAllAddressesItemType: enum: - shipping @@ -23589,6 +24058,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersRefundResponseShippingAddressType: enum: - shipping @@ -23639,6 +24109,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersRefundResponseBillingAddressType: enum: - shipping @@ -23689,6 +24160,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true OrdersRefundResponseCustomerInfo: docs: An object with the keys `fullName` and `email`. properties: @@ -23702,6 +24174,7 @@ Required scope | `ecommerce:write` format: email source: openapi: ../openapi.yml + inline: true OrdersRefundResponsePurchasedItemsItemRowTotal: docs: The total for the row properties: @@ -23716,6 +24189,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersRefundResponsePurchasedItemsItemVariantImageFileVariantsItem: properties: url: @@ -23735,6 +24209,7 @@ Required scope | `ecommerce:write` docs: The image height in pixels source: openapi: ../openapi.yml + inline: true OrdersRefundResponsePurchasedItemsItemVariantImageFile: properties: size: @@ -23761,6 +24236,7 @@ Required scope | `ecommerce:write` docs: Variants of the supplied image source: openapi: ../openapi.yml + inline: true OrdersRefundResponsePurchasedItemsItemVariantImage: properties: url: @@ -23771,6 +24247,7 @@ Required scope | `ecommerce:write` file: optional source: openapi: ../openapi.yml + inline: true OrdersRefundResponsePurchasedItemsItemVariantPrice: docs: The price corresponding to the variant properties: @@ -23785,6 +24262,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersRefundResponsePurchasedItemsItem: docs: An Item that was purchased properties: @@ -23833,6 +24311,7 @@ Required scope | `ecommerce:write` docs: The physical length of the variant if provided, or null source: openapi: ../openapi.yml + inline: true OrdersRefundResponseStripeDetails: docs: >- An object with various Stripe IDs, useful for linking into the stripe @@ -23864,6 +24343,7 @@ Required scope | `ecommerce:write` docs: Stripe-generated refund reason, or null source: openapi: ../openapi.yml + inline: true OrdersRefundResponseStripeCardBrand: enum: - Visa @@ -23889,6 +24369,7 @@ Required scope | `ecommerce:write` docs: Month that the card expires source: openapi: ../openapi.yml + inline: true OrdersRefundResponseStripeCard: docs: > Details on the card used to fulfill this order, if this order was @@ -23908,6 +24389,7 @@ Required scope | `ecommerce:write` docs: The card's expiration date. source: openapi: ../openapi.yml + inline: true OrdersRefundResponsePaypalDetails: properties: orderId: @@ -23930,11 +24412,13 @@ Required scope | `ecommerce:write` docs: PayPal dispute identifier source: openapi: ../openapi.yml + inline: true OrdersRefundResponseMetadata: properties: isBuyNow: optional source: openapi: ../openapi.yml + inline: true OrdersRefundResponseTotalsSubtotal: docs: The subtotal price properties: @@ -23949,6 +24433,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersRefundResponseTotalsExtrasItemType: enum: - discount @@ -23973,6 +24458,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersRefundResponseTotalsExtrasItem: docs: Extra order items, includes discounts, shipping, and taxes. properties: @@ -23990,6 +24476,7 @@ Required scope | `ecommerce:write` docs: The price for the item source: openapi: ../openapi.yml + inline: true OrdersRefundResponseTotalsTotal: docs: The total price properties: @@ -24004,6 +24491,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true OrdersRefundResponseTotals: docs: An object describing various pricing totals properties: @@ -24018,6 +24506,7 @@ Required scope | `ecommerce:write` docs: The total price source: openapi: ../openapi.yml + inline: true OrdersRefundResponseDownloadFilesItem: properties: id: @@ -24033,6 +24522,7 @@ Required scope | `ecommerce:write` format: uri source: openapi: ../openapi.yml + inline: true OrdersRefundResponse: properties: orderId: @@ -24211,6 +24701,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadNetAmount: docs: The net amount after application fees properties: @@ -24225,6 +24716,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadApplicationFee: docs: The application fee assessed by the platform properties: @@ -24239,6 +24731,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadAllAddressesItemType: enum: - shipping @@ -24289,6 +24782,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadShippingAddressType: enum: - shipping @@ -24339,6 +24833,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadBillingAddressType: enum: - shipping @@ -24389,6 +24884,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadCustomerInfo: docs: An object with the keys `fullName` and `email`. properties: @@ -24402,6 +24898,7 @@ Required scope | `ecommerce:write` format: email source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadPurchasedItemsItemRowTotal: docs: The total for the row properties: @@ -24416,6 +24913,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadPurchasedItemsItemVariantImageFileVariantsItem: properties: url: @@ -24435,6 +24933,7 @@ Required scope | `ecommerce:write` docs: The image height in pixels source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadPurchasedItemsItemVariantImageFile: properties: size: @@ -24461,6 +24960,7 @@ Required scope | `ecommerce:write` docs: Variants of the supplied image source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadPurchasedItemsItemVariantImage: properties: url: @@ -24471,6 +24971,7 @@ Required scope | `ecommerce:write` file: optional source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadPurchasedItemsItemVariantPrice: docs: The price corresponding to the variant properties: @@ -24485,6 +24986,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadPurchasedItemsItem: docs: An Item that was purchased properties: @@ -24533,6 +25035,7 @@ Required scope | `ecommerce:write` docs: The physical length of the variant if provided, or null source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadStripeDetails: docs: >- An object with various Stripe IDs, useful for linking into the stripe @@ -24564,6 +25067,7 @@ Required scope | `ecommerce:write` docs: Stripe-generated refund reason, or null source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadStripeCardBrand: enum: - Visa @@ -24589,6 +25093,7 @@ Required scope | `ecommerce:write` docs: Month that the card expires source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadStripeCard: docs: > Details on the card used to fulfill this order, if this order was @@ -24608,6 +25113,7 @@ Required scope | `ecommerce:write` docs: The card's expiration date. source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadPaypalDetails: properties: orderId: @@ -24630,11 +25136,13 @@ Required scope | `ecommerce:write` docs: PayPal dispute identifier source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadMetadata: properties: isBuyNow: optional source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadTotalsSubtotal: docs: The subtotal price properties: @@ -24649,6 +25157,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadTotalsExtrasItemType: enum: - discount @@ -24673,6 +25182,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadTotalsExtrasItem: docs: Extra order items, includes discounts, shipping, and taxes. properties: @@ -24690,6 +25200,7 @@ Required scope | `ecommerce:write` docs: The price for the item source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadTotalsTotal: docs: The total price properties: @@ -24704,6 +25215,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadTotals: docs: An object describing various pricing totals properties: @@ -24718,6 +25230,7 @@ Required scope | `ecommerce:write` docs: The total price source: openapi: ../openapi.yml + inline: true EcommNewOrderPayloadDownloadFilesItem: properties: id: @@ -24733,6 +25246,7 @@ Required scope | `ecommerce:write` format: uri source: openapi: ../openapi.yml + inline: true EcommNewOrderPayload: properties: orderId: @@ -24911,6 +25425,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadNetAmount: docs: The net amount after application fees properties: @@ -24925,6 +25440,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadApplicationFee: docs: The application fee assessed by the platform properties: @@ -24939,6 +25455,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadAllAddressesItemType: enum: - shipping @@ -24989,6 +25506,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadShippingAddressType: enum: - shipping @@ -25039,6 +25557,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadBillingAddressType: enum: - shipping @@ -25089,6 +25608,7 @@ Required scope | `ecommerce:write` docs: The postal code of the address source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadCustomerInfo: docs: An object with the keys `fullName` and `email`. properties: @@ -25102,6 +25622,7 @@ Required scope | `ecommerce:write` format: email source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadPurchasedItemsItemRowTotal: docs: The total for the row properties: @@ -25116,6 +25637,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadPurchasedItemsItemVariantImageFileVariantsItem: properties: url: @@ -25135,6 +25657,7 @@ Required scope | `ecommerce:write` docs: The image height in pixels source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadPurchasedItemsItemVariantImageFile: properties: size: @@ -25161,6 +25684,7 @@ Required scope | `ecommerce:write` docs: Variants of the supplied image source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadPurchasedItemsItemVariantImage: properties: url: @@ -25171,6 +25695,7 @@ Required scope | `ecommerce:write` file: optional source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadPurchasedItemsItemVariantPrice: docs: The price corresponding to the variant properties: @@ -25185,6 +25710,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadPurchasedItemsItem: docs: An Item that was purchased properties: @@ -25233,6 +25759,7 @@ Required scope | `ecommerce:write` docs: The physical length of the variant if provided, or null source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadStripeDetails: docs: >- An object with various Stripe IDs, useful for linking into the stripe @@ -25264,6 +25791,7 @@ Required scope | `ecommerce:write` docs: Stripe-generated refund reason, or null source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadStripeCardBrand: enum: - Visa @@ -25289,6 +25817,7 @@ Required scope | `ecommerce:write` docs: Month that the card expires source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadStripeCard: docs: > Details on the card used to fulfill this order, if this order was @@ -25308,6 +25837,7 @@ Required scope | `ecommerce:write` docs: The card's expiration date. source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadPaypalDetails: properties: orderId: @@ -25330,11 +25860,13 @@ Required scope | `ecommerce:write` docs: PayPal dispute identifier source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadMetadata: properties: isBuyNow: optional source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadTotalsSubtotal: docs: The subtotal price properties: @@ -25349,6 +25881,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadTotalsExtrasItemType: enum: - discount @@ -25373,6 +25906,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadTotalsExtrasItem: docs: Extra order items, includes discounts, shipping, and taxes. properties: @@ -25390,6 +25924,7 @@ Required scope | `ecommerce:write` docs: The price for the item source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadTotalsTotal: docs: The total price properties: @@ -25404,6 +25939,7 @@ Required scope | `ecommerce:write` docs: The user-facing string representation of the amount source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadTotals: docs: An object describing various pricing totals properties: @@ -25418,6 +25954,7 @@ Required scope | `ecommerce:write` docs: The total price source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayloadDownloadFilesItem: properties: id: @@ -25433,6 +25970,7 @@ Required scope | `ecommerce:write` format: uri source: openapi: ../openapi.yml + inline: true EcommOrderChangedPayload: properties: orderId: @@ -27995,6 +28533,7 @@ Required scope | `pages:write` "types": { "PageCreatedPayload": { "docs": "The Webhook payload for when a Page is created", + "inline": undefined, "properties": { "payload": { "docs": "The payload of data sent from Webflow", @@ -28011,6 +28550,7 @@ Required scope | `pages:write` }, "PageCreatedPayloadPayload": { "docs": "The payload of data sent from Webflow", + "inline": true, "properties": { "createdOn": "optional", "pageId": "optional", @@ -28023,6 +28563,7 @@ Required scope | `pages:write` }, "PageDeletedPayload": { "docs": "The Webhook payload for when a Page is deleted", + "inline": undefined, "properties": { "payload": { "docs": "The payload of data sent from Webflow", @@ -28039,6 +28580,7 @@ Required scope | `pages:write` }, "PageDeletedPayloadPayload": { "docs": "The payload of data sent from Webflow", + "inline": true, "properties": { "deletedOn": "optional", "pageId": "optional", @@ -28051,6 +28593,7 @@ Required scope | `pages:write` }, "PageMetadataUpdatedPayload": { "docs": "The Webhook payload for when a Page's metadata is updated", + "inline": undefined, "properties": { "payload": { "docs": "The payload of data sent from Webflow", @@ -28067,6 +28610,7 @@ Required scope | `pages:write` }, "PageMetadataUpdatedPayloadPayload": { "docs": "The payload of data sent from Webflow", + "inline": true, "properties": { "lastUpdated": "optional", "pageId": "optional", @@ -28080,6 +28624,7 @@ Required scope | `pages:write` "PagesGetContentResponse": { "docs": "The DOM (Document Object Model) schema represents the content structure of a web page. It captures various content nodes, such as text and images, along with their associated attributes. Each node has a unique identifier and can be of different types like text or image. The schema also provides pagination details for scenarios where the content nodes are too many to be fetched in a single request. ", + "inline": undefined, "properties": { "nodes": "optional>", "pageId": { @@ -28098,6 +28643,7 @@ Required scope | `pages:write` "PagesGetContentResponseNodesItem": { "docs": "A generic representation of a content element within the Document Object Model (DOM). Each node has a unique identifier and a specific type that determines its content structure and attributes. ", + "inline": true, "properties": { "attributes": { "docs": "The custom attributes of the node", @@ -28126,6 +28672,7 @@ Required scope | `pages:write` "PagesGetContentResponseNodesItemImage": { "docs": "Represents an image within the DOM. It contains details about the image, such as its alternative text (alt) for accessibility and an asset identifier for fetching the actual image resource. Additional attributes can be associated with the image for styling or other purposes. ", + "inline": true, "properties": { "alt": "optional", "assetId": "optional", @@ -28137,6 +28684,7 @@ Required scope | `pages:write` "PagesGetContentResponseNodesItemText": { "docs": "Represents textual content within the DOM. It contains both the raw text and its HTML representation, allowing for flexibility in rendering and processing. Additional attributes can be associated with the text for styling or other purposes. ", + "inline": true, "properties": { "html": "optional", "text": "optional", @@ -28156,6 +28704,7 @@ Required scope | `pages:write` }, "PagesGetContentResponsePagination": { "docs": "Pagination object", + "inline": true, "properties": { "limit": { "docs": "The limit used for pagination", @@ -28176,6 +28725,7 @@ Required scope | `pages:write` }, "PagesGetMetadataResponse": { "docs": "The Page object", + "inline": undefined, "properties": { "archived": { "default": false, @@ -28252,6 +28802,7 @@ Required scope | `pages:write` }, "PagesGetMetadataResponseOpenGraph": { "docs": "Open Graph fields for the Page", + "inline": true, "properties": { "description": { "docs": "The description supplied to Open Graph annotations", @@ -28278,6 +28829,7 @@ Required scope | `pages:write` }, "PagesGetMetadataResponseSeo": { "docs": "SEO-related fields for the Page", + "inline": true, "properties": { "description": { "docs": "The Page description shown in search engine results", @@ -28294,6 +28846,7 @@ Required scope | `pages:write` }, "PagesListResponse": { "docs": "The Page object", + "inline": undefined, "properties": { "pages": "optional>", "pagination": { @@ -28307,6 +28860,7 @@ Required scope | `pages:write` }, "PagesListResponsePagesItem": { "docs": "The Page object", + "inline": true, "properties": { "archived": { "default": false, @@ -28383,6 +28937,7 @@ Required scope | `pages:write` }, "PagesListResponsePagesItemOpenGraph": { "docs": "Open Graph fields for the Page", + "inline": true, "properties": { "description": { "docs": "The description supplied to Open Graph annotations", @@ -28409,6 +28964,7 @@ Required scope | `pages:write` }, "PagesListResponsePagesItemSeo": { "docs": "SEO-related fields for the Page", + "inline": true, "properties": { "description": { "docs": "The Page description shown in search engine results", @@ -28425,6 +28981,7 @@ Required scope | `pages:write` }, "PagesListResponsePagination": { "docs": "Pagination object", + "inline": true, "properties": { "limit": { "docs": "The limit used for pagination", @@ -28445,6 +29002,7 @@ Required scope | `pages:write` }, "UpdatePageSettingsRequestOpenGraph": { "docs": "Open Graph fields for the Page", + "inline": true, "properties": { "description": { "docs": "The description supplied to Open Graph annotations", @@ -28471,6 +29029,7 @@ Required scope | `pages:write` }, "UpdatePageSettingsRequestSeo": { "docs": "SEO-related fields for the Page", + "inline": true, "properties": { "description": { "docs": "The Page description shown in search engine results", @@ -28487,6 +29046,7 @@ Required scope | `pages:write` }, "UpdatePageSettingsResponse": { "docs": "The Page object", + "inline": undefined, "properties": { "archived": { "default": false, @@ -28563,6 +29123,7 @@ Required scope | `pages:write` }, "UpdatePageSettingsResponseOpenGraph": { "docs": "Open Graph fields for the Page", + "inline": true, "properties": { "description": { "docs": "The description supplied to Open Graph annotations", @@ -28589,6 +29150,7 @@ Required scope | `pages:write` }, "UpdatePageSettingsResponseSeo": { "docs": "SEO-related fields for the Page", + "inline": true, "properties": { "description": { "docs": "The Page description shown in search engine results", @@ -28605,6 +29167,7 @@ Required scope | `pages:write` }, "UpdateStaticContentRequestNodesItem": { "docs": undefined, + "inline": true, "properties": { "nodeId": { "docs": "Node UUID", @@ -28621,6 +29184,7 @@ Required scope | `pages:write` }, "UpdateStaticContentResponse": { "docs": undefined, + "inline": undefined, "properties": { "errors": { "docs": "A list of error messages, if any.", @@ -28719,6 +29283,7 @@ Required scope | `pages:write` docs: The Page description shown in search engine results source: openapi: ../openapi.yml + inline: true PagesListResponsePagesItemOpenGraph: docs: Open Graph fields for the Page properties: @@ -28740,6 +29305,7 @@ Required scope | `pages:write` default: true source: openapi: ../openapi.yml + inline: true PagesListResponsePagesItem: docs: The Page object properties: @@ -28803,6 +29369,7 @@ Required scope | `pages:write` docs: Relative path of the published page URL source: openapi: ../openapi.yml + inline: true PagesListResponsePagination: docs: Pagination object properties: @@ -28817,6 +29384,7 @@ Required scope | `pages:write` docs: The total number of records source: openapi: ../openapi.yml + inline: true PagesListResponse: docs: The Page object properties: @@ -28837,6 +29405,7 @@ Required scope | `pages:write` docs: The Page description shown in search engine results source: openapi: ../openapi.yml + inline: true PagesGetMetadataResponseOpenGraph: docs: Open Graph fields for the Page properties: @@ -28858,6 +29427,7 @@ Required scope | `pages:write` default: true source: openapi: ../openapi.yml + inline: true PagesGetMetadataResponse: docs: The Page object properties: @@ -28932,6 +29502,7 @@ Required scope | `pages:write` docs: The Page description shown in search engine results source: openapi: ../openapi.yml + inline: true UpdatePageSettingsRequestOpenGraph: docs: Open Graph fields for the Page properties: @@ -28953,6 +29524,7 @@ Required scope | `pages:write` default: true source: openapi: ../openapi.yml + inline: true UpdatePageSettingsResponseSeo: docs: SEO-related fields for the Page properties: @@ -28964,6 +29536,7 @@ Required scope | `pages:write` docs: The Page description shown in search engine results source: openapi: ../openapi.yml + inline: true UpdatePageSettingsResponseOpenGraph: docs: Open Graph fields for the Page properties: @@ -28985,6 +29558,7 @@ Required scope | `pages:write` default: true source: openapi: ../openapi.yml + inline: true UpdatePageSettingsResponse: docs: The Page object properties: @@ -29065,6 +29639,7 @@ Required scope | `pages:write` text: optional source: openapi: ../openapi.yml + inline: true PagesGetContentResponseNodesItemImage: docs: > Represents an image within the DOM. It contains details about the image, @@ -29076,6 +29651,7 @@ Required scope | `pages:write` assetId: optional source: openapi: ../openapi.yml + inline: true PagesGetContentResponseNodesItem: docs: > A generic representation of a content element within the Document Object @@ -29106,6 +29682,7 @@ Required scope | `pages:write` docs: The custom attributes of the node source: openapi: ../openapi.yml + inline: true PagesGetContentResponsePagination: docs: Pagination object properties: @@ -29120,6 +29697,7 @@ Required scope | `pages:write` docs: The total number of records source: openapi: ../openapi.yml + inline: true PagesGetContentResponse: docs: > The DOM (Document Object Model) schema represents the content structure of @@ -29150,6 +29728,7 @@ Required scope | `pages:write` be the same as what's returned from the Get Content endpoint. source: openapi: ../openapi.yml + inline: true UpdateStaticContentResponse: properties: errors: @@ -29166,6 +29745,7 @@ Required scope | `pages:write` createdOn: optional source: openapi: ../openapi.yml + inline: true PageCreatedPayload: docs: The Webhook payload for when a Page is created properties: @@ -29186,6 +29766,7 @@ Required scope | `pages:write` lastUpdated: optional source: openapi: ../openapi.yml + inline: true PageMetadataUpdatedPayload: docs: The Webhook payload for when a Page's metadata is updated properties: @@ -29206,6 +29787,7 @@ Required scope | `pages:write` deletedOn: optional source: openapi: ../openapi.yml + inline: true PageDeletedPayload: docs: The Webhook payload for when a Page is deleted properties: @@ -29869,6 +30451,7 @@ webhooks: "types": { "ScriptsGetCustomCodeResponse": { "docs": undefined, + "inline": undefined, "properties": { "createdOn": { "docs": "Date when the Site's scripts were created", @@ -29889,6 +30472,7 @@ webhooks: }, "ScriptsGetCustomCodeResponseScriptsItem": { "docs": undefined, + "inline": true, "properties": { "attributes": { "docs": "Developer-specified key/value pairs to be applied as attributes to the script", @@ -29925,6 +30509,7 @@ webhooks: }, "ScriptsUpsertCustomCodeRequestScriptsItem": { "docs": undefined, + "inline": true, "properties": { "attributes": { "docs": "Developer-specified key/value pairs to be applied as attributes to the script", @@ -29961,6 +30546,7 @@ webhooks: }, "ScriptsUpsertCustomCodeResponse": { "docs": undefined, + "inline": undefined, "properties": { "createdOn": { "docs": "Date when the Site's scripts were created", @@ -29981,6 +30567,7 @@ webhooks: }, "ScriptsUpsertCustomCodeResponseScriptsItem": { "docs": undefined, + "inline": true, "properties": { "attributes": { "docs": "Developer-specified key/value pairs to be applied as attributes to the script", @@ -30049,6 +30636,7 @@ webhooks: script source: openapi: ../openapi.yml + inline: true ScriptsGetCustomCodeResponse: properties: scripts: @@ -30093,6 +30681,7 @@ webhooks: script source: openapi: ../openapi.yml + inline: true ScriptsUpsertCustomCodeResponseScriptsItemLocation: enum: - header @@ -30124,6 +30713,7 @@ webhooks: script source: openapi: ../openapi.yml + inline: true ScriptsUpsertCustomCodeResponse: properties: scripts: @@ -31089,6 +31679,7 @@ Required scope | `ecommerce:write` "types": { "ProductsCreateRequestProduct": { "docs": "The Product object", + "inline": true, "properties": { "fieldData": { "docs": "Contains content-specific details for a product, covering both standard (e.g., title, description) and custom fields tailored to the product setup.", @@ -31101,6 +31692,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateRequestProductFieldData": { "docs": "Contains content-specific details for a product, covering both standard (e.g., title, description) and custom fields tailored to the product setup.", + "inline": true, "properties": { "categories": { "docs": "The categories your product belongs to.", @@ -31157,6 +31749,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateRequestProductFieldDataSkuPropertiesItem": { "docs": "A variant/option type for a SKU", + "inline": true, "properties": { "enum": { "docs": "The individual Product variants that are contained within the collection", @@ -31177,6 +31770,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateRequestProductFieldDataSkuPropertiesItemEnumItem": { "docs": "Enumerated Product variants/Options for the SKU", + "inline": true, "properties": { "id": { "docs": "Unique identifier for a Product variant/Option", @@ -31329,6 +31923,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateRequestSku": { "docs": "The SKU object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -31361,6 +31956,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateRequestSkuFieldData": { "docs": "Standard and Custom fields for a SKU", + "inline": true, "properties": { "compare-at-price": { "docs": "comparison price of SKU", @@ -31401,6 +31997,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateRequestSkuFieldDataCompareAtPrice": { "docs": "comparison price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -31429,6 +32026,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateRequestSkuFieldDataEcSkuSubscriptionPlan": { "docs": undefined, + "inline": true, "properties": { "frequency": { "docs": "Frequncy of billing within interval", @@ -31462,6 +32060,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateRequestSkuFieldDataEcSkuSubscriptionPlanPlansItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier of the plan", @@ -31493,6 +32092,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateRequestSkuFieldDataPrice": { "docs": "price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -31509,6 +32109,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateResponse": { "docs": "A product and its SKUs.", + "inline": undefined, "properties": { "product": { "docs": "The Product object", @@ -31525,6 +32126,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateResponseProduct": { "docs": "The Product object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -31567,6 +32169,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateResponseProductFieldData": { "docs": "Contains content-specific details for a product, covering both standard (e.g., title, description) and custom fields tailored to the product setup.", + "inline": true, "properties": { "categories": { "docs": "The categories your product belongs to.", @@ -31623,6 +32226,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateResponseProductFieldDataSkuPropertiesItem": { "docs": "A variant/option type for a SKU", + "inline": true, "properties": { "enum": { "docs": "The individual Product variants that are contained within the collection", @@ -31643,6 +32247,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateResponseProductFieldDataSkuPropertiesItemEnumItem": { "docs": "Enumerated Product variants/Options for the SKU", + "inline": true, "properties": { "id": { "docs": "Unique identifier for a Product variant/Option", @@ -31784,6 +32389,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateResponseSkusItem": { "docs": "The SKU object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -31816,6 +32422,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateResponseSkusItemFieldData": { "docs": "Standard and Custom fields for a SKU", + "inline": true, "properties": { "compare-at-price": { "docs": "comparison price of SKU", @@ -31856,6 +32463,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateResponseSkusItemFieldDataCompareAtPrice": { "docs": "comparison price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -31884,6 +32492,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateResponseSkusItemFieldDataEcSkuSubscriptionPlan": { "docs": undefined, + "inline": true, "properties": { "frequency": { "docs": "Frequncy of billing within interval", @@ -31917,6 +32526,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateResponseSkusItemFieldDataEcSkuSubscriptionPlanPlansItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier of the plan", @@ -31948,6 +32558,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateResponseSkusItemFieldDataPrice": { "docs": "price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -31975,6 +32586,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuRequestSkusItem": { "docs": "The SKU object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -32007,6 +32619,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuRequestSkusItemFieldData": { "docs": "Standard and Custom fields for a SKU", + "inline": true, "properties": { "compare-at-price": { "docs": "comparison price of SKU", @@ -32047,6 +32660,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuRequestSkusItemFieldDataCompareAtPrice": { "docs": "comparison price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -32075,6 +32689,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuRequestSkusItemFieldDataEcSkuSubscriptionPlan": { "docs": undefined, + "inline": true, "properties": { "frequency": { "docs": "Frequncy of billing within interval", @@ -32108,6 +32723,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuRequestSkusItemFieldDataEcSkuSubscriptionPlanPlansItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier of the plan", @@ -32139,6 +32755,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuRequestSkusItemFieldDataPrice": { "docs": "price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -32155,6 +32772,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuResponse": { "docs": undefined, + "inline": undefined, "properties": { "skus": "optional>", }, @@ -32164,6 +32782,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuResponseSkusItem": { "docs": "The SKU object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -32196,6 +32815,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuResponseSkusItemFieldData": { "docs": "Standard and Custom fields for a SKU", + "inline": true, "properties": { "compare-at-price": { "docs": "comparison price of SKU", @@ -32236,6 +32856,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuResponseSkusItemFieldDataCompareAtPrice": { "docs": "comparison price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -32264,6 +32885,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuResponseSkusItemFieldDataEcSkuSubscriptionPlan": { "docs": undefined, + "inline": true, "properties": { "frequency": { "docs": "Frequncy of billing within interval", @@ -32297,6 +32919,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuResponseSkusItemFieldDataEcSkuSubscriptionPlanPlansItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier of the plan", @@ -32328,6 +32951,7 @@ Required scope | `ecommerce:write` }, "ProductsCreateSkuResponseSkusItemFieldDataPrice": { "docs": "price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -32344,6 +32968,7 @@ Required scope | `ecommerce:write` }, "ProductsGetResponse": { "docs": "A product and its SKUs.", + "inline": undefined, "properties": { "product": { "docs": "The Product object", @@ -32360,6 +32985,7 @@ Required scope | `ecommerce:write` }, "ProductsGetResponseProduct": { "docs": "The Product object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -32402,6 +33028,7 @@ Required scope | `ecommerce:write` }, "ProductsGetResponseProductFieldData": { "docs": "Contains content-specific details for a product, covering both standard (e.g., title, description) and custom fields tailored to the product setup.", + "inline": true, "properties": { "categories": { "docs": "The categories your product belongs to.", @@ -32458,6 +33085,7 @@ Required scope | `ecommerce:write` }, "ProductsGetResponseProductFieldDataSkuPropertiesItem": { "docs": "A variant/option type for a SKU", + "inline": true, "properties": { "enum": { "docs": "The individual Product variants that are contained within the collection", @@ -32478,6 +33106,7 @@ Required scope | `ecommerce:write` }, "ProductsGetResponseProductFieldDataSkuPropertiesItemEnumItem": { "docs": "Enumerated Product variants/Options for the SKU", + "inline": true, "properties": { "id": { "docs": "Unique identifier for a Product variant/Option", @@ -32619,6 +33248,7 @@ Required scope | `ecommerce:write` }, "ProductsGetResponseSkusItem": { "docs": "The SKU object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -32651,6 +33281,7 @@ Required scope | `ecommerce:write` }, "ProductsGetResponseSkusItemFieldData": { "docs": "Standard and Custom fields for a SKU", + "inline": true, "properties": { "compare-at-price": { "docs": "comparison price of SKU", @@ -32691,6 +33322,7 @@ Required scope | `ecommerce:write` }, "ProductsGetResponseSkusItemFieldDataCompareAtPrice": { "docs": "comparison price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -32719,6 +33351,7 @@ Required scope | `ecommerce:write` }, "ProductsGetResponseSkusItemFieldDataEcSkuSubscriptionPlan": { "docs": undefined, + "inline": true, "properties": { "frequency": { "docs": "Frequncy of billing within interval", @@ -32752,6 +33385,7 @@ Required scope | `ecommerce:write` }, "ProductsGetResponseSkusItemFieldDataEcSkuSubscriptionPlanPlansItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier of the plan", @@ -32783,6 +33417,7 @@ Required scope | `ecommerce:write` }, "ProductsGetResponseSkusItemFieldDataPrice": { "docs": "price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -32799,6 +33434,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponse": { "docs": "Results from product list", + "inline": undefined, "properties": { "items": { "docs": "List of Item objects within the Collection. Contains product and skus keys for each Item", @@ -32815,6 +33451,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponseItemsItem": { "docs": "A product and its SKUs.", + "inline": true, "properties": { "product": { "docs": "The Product object", @@ -32831,6 +33468,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponseItemsItemProduct": { "docs": "The Product object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -32873,6 +33511,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponseItemsItemProductFieldData": { "docs": "Contains content-specific details for a product, covering both standard (e.g., title, description) and custom fields tailored to the product setup.", + "inline": true, "properties": { "categories": { "docs": "The categories your product belongs to.", @@ -32929,6 +33568,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponseItemsItemProductFieldDataSkuPropertiesItem": { "docs": "A variant/option type for a SKU", + "inline": true, "properties": { "enum": { "docs": "The individual Product variants that are contained within the collection", @@ -32949,6 +33589,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponseItemsItemProductFieldDataSkuPropertiesItemEnumItem": { "docs": "Enumerated Product variants/Options for the SKU", + "inline": true, "properties": { "id": { "docs": "Unique identifier for a Product variant/Option", @@ -33090,6 +33731,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponseItemsItemSkusItem": { "docs": "The SKU object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -33122,6 +33764,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponseItemsItemSkusItemFieldData": { "docs": "Standard and Custom fields for a SKU", + "inline": true, "properties": { "compare-at-price": { "docs": "comparison price of SKU", @@ -33162,6 +33805,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponseItemsItemSkusItemFieldDataCompareAtPrice": { "docs": "comparison price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -33190,6 +33834,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponseItemsItemSkusItemFieldDataEcSkuSubscriptionPlan": { "docs": undefined, + "inline": true, "properties": { "frequency": { "docs": "Frequncy of billing within interval", @@ -33223,6 +33868,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponseItemsItemSkusItemFieldDataEcSkuSubscriptionPlanPlansItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier of the plan", @@ -33254,6 +33900,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponseItemsItemSkusItemFieldDataPrice": { "docs": "price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -33270,6 +33917,7 @@ Required scope | `ecommerce:write` }, "ProductsListResponsePagination": { "docs": "Pagination object", + "inline": true, "properties": { "limit": { "docs": "The limit used for pagination", @@ -33290,6 +33938,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateRequestProduct": { "docs": "The Product object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -33332,6 +33981,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateRequestProductFieldData": { "docs": "Contains content-specific details for a product, covering both standard (e.g., title, description) and custom fields tailored to the product setup.", + "inline": true, "properties": { "categories": { "docs": "The categories your product belongs to.", @@ -33388,6 +34038,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateRequestProductFieldDataSkuPropertiesItem": { "docs": "A variant/option type for a SKU", + "inline": true, "properties": { "enum": { "docs": "The individual Product variants that are contained within the collection", @@ -33408,6 +34059,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateRequestProductFieldDataSkuPropertiesItemEnumItem": { "docs": "Enumerated Product variants/Options for the SKU", + "inline": true, "properties": { "id": { "docs": "Unique identifier for a Product variant/Option", @@ -33560,6 +34212,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateRequestSku": { "docs": "The SKU object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -33592,6 +34245,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateRequestSkuFieldData": { "docs": "Standard and Custom fields for a SKU", + "inline": true, "properties": { "compare-at-price": { "docs": "comparison price of SKU", @@ -33632,6 +34286,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateRequestSkuFieldDataCompareAtPrice": { "docs": "comparison price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -33660,6 +34315,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateRequestSkuFieldDataEcSkuSubscriptionPlan": { "docs": undefined, + "inline": true, "properties": { "frequency": { "docs": "Frequncy of billing within interval", @@ -33693,6 +34349,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateRequestSkuFieldDataEcSkuSubscriptionPlanPlansItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier of the plan", @@ -33724,6 +34381,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateRequestSkuFieldDataPrice": { "docs": "price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -33740,6 +34398,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateResponse": { "docs": "The Product object", + "inline": undefined, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -33782,6 +34441,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateResponseFieldData": { "docs": "Contains content-specific details for a product, covering both standard (e.g., title, description) and custom fields tailored to the product setup.", + "inline": true, "properties": { "categories": { "docs": "The categories your product belongs to.", @@ -33838,6 +34498,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateResponseFieldDataSkuPropertiesItem": { "docs": "A variant/option type for a SKU", + "inline": true, "properties": { "enum": { "docs": "The individual Product variants that are contained within the collection", @@ -33858,6 +34519,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateResponseFieldDataSkuPropertiesItemEnumItem": { "docs": "Enumerated Product variants/Options for the SKU", + "inline": true, "properties": { "id": { "docs": "Unique identifier for a Product variant/Option", @@ -34010,6 +34672,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuRequestSku": { "docs": "The SKU object", + "inline": true, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -34042,6 +34705,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuRequestSkuFieldData": { "docs": "Standard and Custom fields for a SKU", + "inline": true, "properties": { "compare-at-price": { "docs": "comparison price of SKU", @@ -34082,6 +34746,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuRequestSkuFieldDataCompareAtPrice": { "docs": "comparison price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -34110,6 +34775,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuRequestSkuFieldDataEcSkuSubscriptionPlan": { "docs": undefined, + "inline": true, "properties": { "frequency": { "docs": "Frequncy of billing within interval", @@ -34143,6 +34809,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuRequestSkuFieldDataEcSkuSubscriptionPlanPlansItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier of the plan", @@ -34174,6 +34841,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuRequestSkuFieldDataPrice": { "docs": "price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -34190,6 +34858,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuResponse": { "docs": "The SKU object", + "inline": undefined, "properties": { "cmsLocaleId": { "docs": "Identifier for the locale of the CMS item", @@ -34222,6 +34891,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuResponseFieldData": { "docs": "Standard and Custom fields for a SKU", + "inline": true, "properties": { "compare-at-price": { "docs": "comparison price of SKU", @@ -34262,6 +34932,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuResponseFieldDataCompareAtPrice": { "docs": "comparison price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -34290,6 +34961,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuResponseFieldDataEcSkuSubscriptionPlan": { "docs": undefined, + "inline": true, "properties": { "frequency": { "docs": "Frequncy of billing within interval", @@ -34323,6 +34995,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuResponseFieldDataEcSkuSubscriptionPlanPlansItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "The unique identifier of the plan", @@ -34354,6 +35027,7 @@ Required scope | `ecommerce:write` }, "ProductsUpdateSkuResponseFieldDataPrice": { "docs": "price of SKU", + "inline": true, "properties": { "unit": { "docs": "Currency of Item", @@ -34385,6 +35059,7 @@ Required scope | `ecommerce:write` docs: Slug for the Product variant/Option in the Site URL structure source: openapi: ../openapi.yml + inline: true ProductsListResponseItemsItemProductFieldDataSkuPropertiesItem: docs: A variant/option type for a SKU properties: @@ -34402,6 +35077,7 @@ Required scope | `ecommerce:write` list source: openapi: ../openapi.yml + inline: true ProductsListResponseItemsItemProductFieldDataTaxCategory: enum: - value: standard-taxable @@ -34517,6 +35193,7 @@ Required scope | `ecommerce:write` Digital, Service, Advanced" source: openapi: ../openapi.yml + inline: true ProductsListResponseItemsItemProduct: docs: The Product object properties: @@ -34551,6 +35228,7 @@ Required scope | `ecommerce:write` product setup. source: openapi: ../openapi.yml + inline: true ProductsListResponseItemsItemSkusItemFieldDataPrice: docs: price of SKU properties: @@ -34562,6 +35240,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsListResponseItemsItemSkusItemFieldDataCompareAtPrice: docs: comparison price of SKU properties: @@ -34573,6 +35252,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsListResponseItemsItemSkusItemFieldDataEcSkuBillingMethod: enum: - value: one-time @@ -34611,6 +35291,7 @@ Required scope | `ecommerce:write` docs: The status of the plan source: openapi: ../openapi.yml + inline: true ProductsListResponseItemsItemSkusItemFieldDataEcSkuSubscriptionPlan: properties: interval: @@ -34627,6 +35308,7 @@ Required scope | `ecommerce:write` optional> source: openapi: ../openapi.yml + inline: true ProductsListResponseItemsItemSkusItemFieldData: docs: Standard and Custom fields for a SKU properties: @@ -34662,6 +35344,7 @@ Required scope | `ecommerce:write` docs: Quantity of SKU that will be tracked as items are ordered. source: openapi: ../openapi.yml + inline: true ProductsListResponseItemsItemSkusItem: docs: The SKU object properties: @@ -34685,6 +35368,7 @@ Required scope | `ecommerce:write` docs: Standard and Custom fields for a SKU source: openapi: ../openapi.yml + inline: true ProductsListResponseItemsItem: docs: A product and its SKUs. properties: @@ -34696,6 +35380,7 @@ Required scope | `ecommerce:write` docs: A list of SKU Objects source: openapi: ../openapi.yml + inline: true ProductsListResponsePagination: docs: Pagination object properties: @@ -34710,6 +35395,7 @@ Required scope | `ecommerce:write` docs: The total number of records source: openapi: ../openapi.yml + inline: true ProductsListResponse: docs: Results from product list properties: @@ -34745,6 +35431,7 @@ Required scope | `ecommerce:write` docs: Slug for the Product variant/Option in the Site URL structure source: openapi: ../openapi.yml + inline: true ProductsCreateRequestProductFieldDataSkuPropertiesItem: docs: A variant/option type for a SKU properties: @@ -34761,6 +35448,7 @@ Required scope | `ecommerce:write` type: list source: openapi: ../openapi.yml + inline: true ProductsCreateRequestProductFieldDataTaxCategory: enum: - value: standard-taxable @@ -34875,6 +35563,7 @@ Required scope | `ecommerce:write` Digital, Service, Advanced" source: openapi: ../openapi.yml + inline: true ProductsCreateRequestProduct: docs: The Product object properties: @@ -34886,6 +35575,7 @@ Required scope | `ecommerce:write` product setup. source: openapi: ../openapi.yml + inline: true ProductsCreateRequestSkuFieldDataPrice: docs: price of SKU properties: @@ -34897,6 +35587,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsCreateRequestSkuFieldDataCompareAtPrice: docs: comparison price of SKU properties: @@ -34908,6 +35599,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsCreateRequestSkuFieldDataEcSkuBillingMethod: enum: - value: one-time @@ -34946,6 +35638,7 @@ Required scope | `ecommerce:write` docs: The status of the plan source: openapi: ../openapi.yml + inline: true ProductsCreateRequestSkuFieldDataEcSkuSubscriptionPlan: properties: interval: @@ -34962,6 +35655,7 @@ Required scope | `ecommerce:write` optional> source: openapi: ../openapi.yml + inline: true ProductsCreateRequestSkuFieldData: docs: Standard and Custom fields for a SKU properties: @@ -34995,6 +35689,7 @@ Required scope | `ecommerce:write` docs: Quantity of SKU that will be tracked as items are ordered. source: openapi: ../openapi.yml + inline: true ProductsCreateRequestSku: docs: The SKU object properties: @@ -35018,6 +35713,7 @@ Required scope | `ecommerce:write` docs: Standard and Custom fields for a SKU source: openapi: ../openapi.yml + inline: true ProductsCreateResponseProductFieldDataSkuPropertiesItemEnumItem: docs: Enumerated Product variants/Options for the SKU properties: @@ -35032,6 +35728,7 @@ Required scope | `ecommerce:write` docs: Slug for the Product variant/Option in the Site URL structure source: openapi: ../openapi.yml + inline: true ProductsCreateResponseProductFieldDataSkuPropertiesItem: docs: A variant/option type for a SKU properties: @@ -35048,6 +35745,7 @@ Required scope | `ecommerce:write` type: list source: openapi: ../openapi.yml + inline: true ProductsCreateResponseProductFieldDataTaxCategory: enum: - value: standard-taxable @@ -35163,6 +35861,7 @@ Required scope | `ecommerce:write` Digital, Service, Advanced" source: openapi: ../openapi.yml + inline: true ProductsCreateResponseProduct: docs: The Product object properties: @@ -35197,6 +35896,7 @@ Required scope | `ecommerce:write` product setup. source: openapi: ../openapi.yml + inline: true ProductsCreateResponseSkusItemFieldDataPrice: docs: price of SKU properties: @@ -35208,6 +35908,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsCreateResponseSkusItemFieldDataCompareAtPrice: docs: comparison price of SKU properties: @@ -35219,6 +35920,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsCreateResponseSkusItemFieldDataEcSkuBillingMethod: enum: - value: one-time @@ -35257,6 +35959,7 @@ Required scope | `ecommerce:write` docs: The status of the plan source: openapi: ../openapi.yml + inline: true ProductsCreateResponseSkusItemFieldDataEcSkuSubscriptionPlan: properties: interval: @@ -35273,6 +35976,7 @@ Required scope | `ecommerce:write` optional> source: openapi: ../openapi.yml + inline: true ProductsCreateResponseSkusItemFieldData: docs: Standard and Custom fields for a SKU properties: @@ -35306,6 +36010,7 @@ Required scope | `ecommerce:write` docs: Quantity of SKU that will be tracked as items are ordered. source: openapi: ../openapi.yml + inline: true ProductsCreateResponseSkusItem: docs: The SKU object properties: @@ -35329,6 +36034,7 @@ Required scope | `ecommerce:write` docs: Standard and Custom fields for a SKU source: openapi: ../openapi.yml + inline: true ProductsCreateResponse: docs: A product and its SKUs. properties: @@ -35354,6 +36060,7 @@ Required scope | `ecommerce:write` docs: Slug for the Product variant/Option in the Site URL structure source: openapi: ../openapi.yml + inline: true ProductsGetResponseProductFieldDataSkuPropertiesItem: docs: A variant/option type for a SKU properties: @@ -35370,6 +36077,7 @@ Required scope | `ecommerce:write` type: list source: openapi: ../openapi.yml + inline: true ProductsGetResponseProductFieldDataTaxCategory: enum: - value: standard-taxable @@ -35484,6 +36192,7 @@ Required scope | `ecommerce:write` Digital, Service, Advanced" source: openapi: ../openapi.yml + inline: true ProductsGetResponseProduct: docs: The Product object properties: @@ -35518,6 +36227,7 @@ Required scope | `ecommerce:write` product setup. source: openapi: ../openapi.yml + inline: true ProductsGetResponseSkusItemFieldDataPrice: docs: price of SKU properties: @@ -35529,6 +36239,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsGetResponseSkusItemFieldDataCompareAtPrice: docs: comparison price of SKU properties: @@ -35540,6 +36251,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsGetResponseSkusItemFieldDataEcSkuBillingMethod: enum: - value: one-time @@ -35578,6 +36290,7 @@ Required scope | `ecommerce:write` docs: The status of the plan source: openapi: ../openapi.yml + inline: true ProductsGetResponseSkusItemFieldDataEcSkuSubscriptionPlan: properties: interval: @@ -35594,6 +36307,7 @@ Required scope | `ecommerce:write` optional> source: openapi: ../openapi.yml + inline: true ProductsGetResponseSkusItemFieldData: docs: Standard and Custom fields for a SKU properties: @@ -35627,6 +36341,7 @@ Required scope | `ecommerce:write` docs: Quantity of SKU that will be tracked as items are ordered. source: openapi: ../openapi.yml + inline: true ProductsGetResponseSkusItem: docs: The SKU object properties: @@ -35650,6 +36365,7 @@ Required scope | `ecommerce:write` docs: Standard and Custom fields for a SKU source: openapi: ../openapi.yml + inline: true ProductsGetResponse: docs: A product and its SKUs. properties: @@ -35683,6 +36399,7 @@ Required scope | `ecommerce:write` docs: Slug for the Product variant/Option in the Site URL structure source: openapi: ../openapi.yml + inline: true ProductsUpdateRequestProductFieldDataSkuPropertiesItem: docs: A variant/option type for a SKU properties: @@ -35699,6 +36416,7 @@ Required scope | `ecommerce:write` type: list source: openapi: ../openapi.yml + inline: true ProductsUpdateRequestProductFieldDataTaxCategory: enum: - value: standard-taxable @@ -35813,6 +36531,7 @@ Required scope | `ecommerce:write` Digital, Service, Advanced" source: openapi: ../openapi.yml + inline: true ProductsUpdateRequestProduct: docs: The Product object properties: @@ -35847,6 +36566,7 @@ Required scope | `ecommerce:write` product setup. source: openapi: ../openapi.yml + inline: true ProductsUpdateRequestSkuFieldDataPrice: docs: price of SKU properties: @@ -35858,6 +36578,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsUpdateRequestSkuFieldDataCompareAtPrice: docs: comparison price of SKU properties: @@ -35869,6 +36590,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsUpdateRequestSkuFieldDataEcSkuBillingMethod: enum: - value: one-time @@ -35907,6 +36629,7 @@ Required scope | `ecommerce:write` docs: The status of the plan source: openapi: ../openapi.yml + inline: true ProductsUpdateRequestSkuFieldDataEcSkuSubscriptionPlan: properties: interval: @@ -35923,6 +36646,7 @@ Required scope | `ecommerce:write` optional> source: openapi: ../openapi.yml + inline: true ProductsUpdateRequestSkuFieldData: docs: Standard and Custom fields for a SKU properties: @@ -35956,6 +36680,7 @@ Required scope | `ecommerce:write` docs: Quantity of SKU that will be tracked as items are ordered. source: openapi: ../openapi.yml + inline: true ProductsUpdateRequestSku: docs: The SKU object properties: @@ -35979,6 +36704,7 @@ Required scope | `ecommerce:write` docs: Standard and Custom fields for a SKU source: openapi: ../openapi.yml + inline: true ProductsUpdateResponseFieldDataSkuPropertiesItemEnumItem: docs: Enumerated Product variants/Options for the SKU properties: @@ -35993,6 +36719,7 @@ Required scope | `ecommerce:write` docs: Slug for the Product variant/Option in the Site URL structure source: openapi: ../openapi.yml + inline: true ProductsUpdateResponseFieldDataSkuPropertiesItem: docs: A variant/option type for a SKU properties: @@ -36009,6 +36736,7 @@ Required scope | `ecommerce:write` type: list source: openapi: ../openapi.yml + inline: true ProductsUpdateResponseFieldDataTaxCategory: enum: - value: standard-taxable @@ -36123,6 +36851,7 @@ Required scope | `ecommerce:write` Digital, Service, Advanced" source: openapi: ../openapi.yml + inline: true ProductsUpdateResponse: docs: The Product object properties: @@ -36176,6 +36905,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsCreateSkuRequestSkusItemFieldDataCompareAtPrice: docs: comparison price of SKU properties: @@ -36187,6 +36917,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsCreateSkuRequestSkusItemFieldDataEcSkuBillingMethod: enum: - value: one-time @@ -36225,6 +36956,7 @@ Required scope | `ecommerce:write` docs: The status of the plan source: openapi: ../openapi.yml + inline: true ProductsCreateSkuRequestSkusItemFieldDataEcSkuSubscriptionPlan: properties: interval: @@ -36241,6 +36973,7 @@ Required scope | `ecommerce:write` optional> source: openapi: ../openapi.yml + inline: true ProductsCreateSkuRequestSkusItemFieldData: docs: Standard and Custom fields for a SKU properties: @@ -36274,6 +37007,7 @@ Required scope | `ecommerce:write` docs: Quantity of SKU that will be tracked as items are ordered. source: openapi: ../openapi.yml + inline: true ProductsCreateSkuRequestSkusItem: docs: The SKU object properties: @@ -36297,6 +37031,7 @@ Required scope | `ecommerce:write` docs: Standard and Custom fields for a SKU source: openapi: ../openapi.yml + inline: true ProductsCreateSkuResponseSkusItemFieldDataPrice: docs: price of SKU properties: @@ -36308,6 +37043,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsCreateSkuResponseSkusItemFieldDataCompareAtPrice: docs: comparison price of SKU properties: @@ -36319,6 +37055,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsCreateSkuResponseSkusItemFieldDataEcSkuBillingMethod: enum: - value: one-time @@ -36357,6 +37094,7 @@ Required scope | `ecommerce:write` docs: The status of the plan source: openapi: ../openapi.yml + inline: true ProductsCreateSkuResponseSkusItemFieldDataEcSkuSubscriptionPlan: properties: interval: @@ -36373,6 +37111,7 @@ Required scope | `ecommerce:write` optional> source: openapi: ../openapi.yml + inline: true ProductsCreateSkuResponseSkusItemFieldData: docs: Standard and Custom fields for a SKU properties: @@ -36407,6 +37146,7 @@ Required scope | `ecommerce:write` docs: Quantity of SKU that will be tracked as items are ordered. source: openapi: ../openapi.yml + inline: true ProductsCreateSkuResponseSkusItem: docs: The SKU object properties: @@ -36430,6 +37170,7 @@ Required scope | `ecommerce:write` docs: Standard and Custom fields for a SKU source: openapi: ../openapi.yml + inline: true ProductsCreateSkuResponse: properties: skus: optional> @@ -36454,6 +37195,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsUpdateSkuRequestSkuFieldDataCompareAtPrice: docs: comparison price of SKU properties: @@ -36465,6 +37207,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsUpdateSkuRequestSkuFieldDataEcSkuBillingMethod: enum: - value: one-time @@ -36503,6 +37246,7 @@ Required scope | `ecommerce:write` docs: The status of the plan source: openapi: ../openapi.yml + inline: true ProductsUpdateSkuRequestSkuFieldDataEcSkuSubscriptionPlan: properties: interval: @@ -36519,6 +37263,7 @@ Required scope | `ecommerce:write` optional> source: openapi: ../openapi.yml + inline: true ProductsUpdateSkuRequestSkuFieldData: docs: Standard and Custom fields for a SKU properties: @@ -36552,6 +37297,7 @@ Required scope | `ecommerce:write` docs: Quantity of SKU that will be tracked as items are ordered. source: openapi: ../openapi.yml + inline: true ProductsUpdateSkuRequestSku: docs: The SKU object properties: @@ -36575,6 +37321,7 @@ Required scope | `ecommerce:write` docs: Standard and Custom fields for a SKU source: openapi: ../openapi.yml + inline: true ProductsUpdateSkuResponseFieldDataPrice: docs: price of SKU properties: @@ -36586,6 +37333,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsUpdateSkuResponseFieldDataCompareAtPrice: docs: comparison price of SKU properties: @@ -36597,6 +37345,7 @@ Required scope | `ecommerce:write` docs: Currency of Item source: openapi: ../openapi.yml + inline: true ProductsUpdateSkuResponseFieldDataEcSkuBillingMethod: enum: - value: one-time @@ -36635,6 +37384,7 @@ Required scope | `ecommerce:write` docs: The status of the plan source: openapi: ../openapi.yml + inline: true ProductsUpdateSkuResponseFieldDataEcSkuSubscriptionPlan: properties: interval: @@ -36651,6 +37401,7 @@ Required scope | `ecommerce:write` optional> source: openapi: ../openapi.yml + inline: true ProductsUpdateSkuResponseFieldData: docs: Standard and Custom fields for a SKU properties: @@ -36684,6 +37435,7 @@ Required scope | `ecommerce:write` docs: Quantity of SKU that will be tracked as items are ordered. source: openapi: ../openapi.yml + inline: true ProductsUpdateSkuResponse: docs: The SKU object properties: @@ -37577,6 +38329,7 @@ service: "types": { "ScriptsListResponse": { "docs": "A list of scripts registered to the site", + "inline": undefined, "properties": { "registeredScripts": "optional>", }, @@ -37586,6 +38339,7 @@ service: }, "ScriptsListResponseRegisteredScriptsItem": { "docs": "Registered custom code for application", + "inline": true, "properties": { "canCopy": { "default": false, @@ -37627,6 +38381,7 @@ service: }, "ScriptsRegisterHostedResponse": { "docs": "Registered custom code for application", + "inline": undefined, "properties": { "canCopy": { "default": false, @@ -37668,6 +38423,7 @@ service: }, "ScriptsRegisterInlineResponse": { "docs": "Registered custom code for application", + "inline": undefined, "properties": { "canCopy": { "default": false, @@ -37746,6 +38502,7 @@ service: docs: A Semantic Version (SemVer) string, denoting the version of the script source: openapi: ../openapi.yml + inline: true ScriptsListResponse: docs: A list of scripts registered to the site properties: @@ -38427,6 +39184,7 @@ service: "types": { "SitePublishPayload": { "docs": "The Webhook payload for when a Site is published", + "inline": undefined, "properties": { "payload": { "docs": "The payload of data sent from Webflow", @@ -38443,6 +39201,7 @@ service: }, "SitePublishPayloadPayload": { "docs": "The payload of data sent from Webflow", + "inline": true, "properties": { "domains": { "docs": "The domains that were published", @@ -38467,6 +39226,7 @@ service: }, "SitesGetCustomDomainResponse": { "docs": undefined, + "inline": undefined, "properties": { "customDomains": "optional>", }, @@ -38476,6 +39236,7 @@ service: }, "SitesGetCustomDomainResponseCustomDomainsItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "Unique identifier for the Domain", @@ -38492,6 +39253,7 @@ service: }, "SitesGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "createdOn": { "docs": "Date the Site was created", @@ -38548,6 +39310,7 @@ service: }, "SitesGetResponseCustomDomainsItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "Unique identifier for the Domain", @@ -38564,6 +39327,7 @@ service: }, "SitesGetResponseLocales": { "docs": undefined, + "inline": true, "properties": { "primary": { "docs": "The primary locale for the site or application.", @@ -38580,6 +39344,7 @@ service: }, "SitesGetResponseLocalesPrimary": { "docs": "The primary locale for the site or application.", + "inline": true, "properties": { "cmsLocaleId": { "docs": "A CMS-specific identifier for the locale.", @@ -38620,6 +39385,7 @@ service: }, "SitesGetResponseLocalesSecondaryItem": { "docs": undefined, + "inline": true, "properties": { "cmsLocaleId": { "docs": "A CMS-specific identifier for the locale.", @@ -38660,6 +39426,7 @@ service: }, "SitesListResponse": { "docs": undefined, + "inline": undefined, "properties": { "sites": "optional>", }, @@ -38669,6 +39436,7 @@ service: }, "SitesListResponseSitesItem": { "docs": undefined, + "inline": true, "properties": { "createdOn": { "docs": "Date the Site was created", @@ -38725,6 +39493,7 @@ service: }, "SitesListResponseSitesItemCustomDomainsItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "Unique identifier for the Domain", @@ -38741,6 +39510,7 @@ service: }, "SitesListResponseSitesItemLocales": { "docs": undefined, + "inline": true, "properties": { "primary": { "docs": "The primary locale for the site or application.", @@ -38757,6 +39527,7 @@ service: }, "SitesListResponseSitesItemLocalesPrimary": { "docs": "The primary locale for the site or application.", + "inline": true, "properties": { "cmsLocaleId": { "docs": "A CMS-specific identifier for the locale.", @@ -38797,6 +39568,7 @@ service: }, "SitesListResponseSitesItemLocalesSecondaryItem": { "docs": undefined, + "inline": true, "properties": { "cmsLocaleId": { "docs": "A CMS-specific identifier for the locale.", @@ -38837,6 +39609,7 @@ service: }, "SitesPublishResponse": { "docs": undefined, + "inline": undefined, "properties": { "customDomains": { "docs": "Array of domains objects", @@ -38854,6 +39627,7 @@ service: }, "SitesPublishResponseCustomDomainsItem": { "docs": undefined, + "inline": true, "properties": { "id": { "docs": "Unique identifier for the Domain", @@ -38911,6 +39685,7 @@ service: docs: The registered Domain name source: openapi: ../openapi.yml + inline: true SitesListResponseSitesItemLocalesPrimary: docs: The primary locale for the site or application. properties: @@ -38942,6 +39717,7 @@ service: format like 'en-US'. source: openapi: ../openapi.yml + inline: true SitesListResponseSitesItemLocalesSecondaryItem: properties: id: @@ -38972,6 +39748,7 @@ service: format like 'en-US'. source: openapi: ../openapi.yml + inline: true SitesListResponseSitesItemLocales: properties: primary: @@ -38982,6 +39759,7 @@ service: docs: A list of secondary locales available for the site or application. source: openapi: ../openapi.yml + inline: true SitesListResponseSitesItem: properties: id: @@ -39020,6 +39798,7 @@ service: locales: optional source: openapi: ../openapi.yml + inline: true SitesListResponse: properties: sites: optional> @@ -39035,6 +39814,7 @@ service: docs: The registered Domain name source: openapi: ../openapi.yml + inline: true SitesGetResponseLocalesPrimary: docs: The primary locale for the site or application. properties: @@ -39066,6 +39846,7 @@ service: format like 'en-US'. source: openapi: ../openapi.yml + inline: true SitesGetResponseLocalesSecondaryItem: properties: id: @@ -39096,6 +39877,7 @@ service: format like 'en-US'. source: openapi: ../openapi.yml + inline: true SitesGetResponseLocales: properties: primary: @@ -39106,6 +39888,7 @@ service: docs: A list of secondary locales available for the site or application. source: openapi: ../openapi.yml + inline: true SitesGetResponse: properties: id: @@ -39154,6 +39937,7 @@ service: docs: The registered Domain name source: openapi: ../openapi.yml + inline: true SitesGetCustomDomainResponse: properties: customDomains: optional> @@ -39169,6 +39953,7 @@ service: docs: The registered Domain name source: openapi: ../openapi.yml + inline: true SitesPublishResponse: properties: customDomains: @@ -39197,6 +39982,7 @@ service: docs: The name and id of the user who published the site source: openapi: ../openapi.yml + inline: true SitePublishPayload: docs: The Webhook payload for when a Site is published properties: @@ -39594,6 +40380,7 @@ webhooks: "types": { "ActivityLogsListResponse": { "docs": undefined, + "inline": undefined, "properties": { "items": "optional>", "pagination": { @@ -39607,6 +40394,7 @@ webhooks: }, "ActivityLogsListResponseItemsItem": { "docs": undefined, + "inline": true, "properties": { "createdOn": "optional", "event": "optional", @@ -39638,6 +40426,7 @@ webhooks: }, "ActivityLogsListResponseItemsItemUser": { "docs": undefined, + "inline": true, "properties": { "displayName": "optional", "id": "optional", @@ -39648,6 +40437,7 @@ webhooks: }, "ActivityLogsListResponsePagination": { "docs": "Pagination object", + "inline": true, "properties": { "limit": { "docs": "The limit used for pagination", @@ -39684,6 +40474,7 @@ webhooks: displayName: optional source: openapi: ../openapi.yml + inline: true ActivityLogsListResponseItemsItem: properties: id: optional @@ -39699,6 +40490,7 @@ webhooks: payload: optional> source: openapi: ../openapi.yml + inline: true ActivityLogsListResponsePagination: docs: Pagination object properties: @@ -39713,6 +40505,7 @@ webhooks: docs: The total number of records source: openapi: ../openapi.yml + inline: true ActivityLogsListResponse: properties: items: optional> @@ -40092,6 +40885,7 @@ service: "types": { "ScriptsGetCustomCodeResponse": { "docs": undefined, + "inline": undefined, "properties": { "createdOn": { "docs": "Date when the Site's scripts were created", @@ -40112,6 +40906,7 @@ service: }, "ScriptsGetCustomCodeResponseScriptsItem": { "docs": undefined, + "inline": true, "properties": { "attributes": { "docs": "Developer-specified key/value pairs to be applied as attributes to the script", @@ -40148,6 +40943,7 @@ service: }, "ScriptsListCustomCodeBlocksResponse": { "docs": "Custom Code Blocks corresponding to where scripts were applied", + "inline": undefined, "properties": { "blocks": "optional>", "pagination": { @@ -40161,6 +40957,7 @@ service: }, "ScriptsListCustomCodeBlocksResponseBlocksItem": { "docs": "A specific instance of Custom Code applied to a Site or Page", + "inline": true, "properties": { "createdOn": { "docs": "The date the Block was created", @@ -40193,6 +40990,7 @@ service: }, "ScriptsListCustomCodeBlocksResponseBlocksItemScriptsItem": { "docs": undefined, + "inline": true, "properties": { "attributes": { "docs": "Developer-specified key/value pairs to be applied as attributes to the script", @@ -40239,6 +41037,7 @@ service: }, "ScriptsListCustomCodeBlocksResponsePagination": { "docs": "Pagination object", + "inline": true, "properties": { "limit": { "docs": "The limit used for pagination", @@ -40259,6 +41058,7 @@ service: }, "ScriptsUpsertCustomCodeRequestScriptsItem": { "docs": undefined, + "inline": true, "properties": { "attributes": { "docs": "Developer-specified key/value pairs to be applied as attributes to the script", @@ -40295,6 +41095,7 @@ service: }, "ScriptsUpsertCustomCodeResponse": { "docs": undefined, + "inline": undefined, "properties": { "createdOn": { "docs": "Date when the Site's scripts were created", @@ -40315,6 +41116,7 @@ service: }, "ScriptsUpsertCustomCodeResponseScriptsItem": { "docs": undefined, + "inline": true, "properties": { "attributes": { "docs": "Developer-specified key/value pairs to be applied as attributes to the script", @@ -40383,6 +41185,7 @@ service: script source: openapi: ../openapi.yml + inline: true ScriptsGetCustomCodeResponse: properties: scripts: @@ -40427,6 +41230,7 @@ service: script source: openapi: ../openapi.yml + inline: true ScriptsUpsertCustomCodeResponseScriptsItemLocation: enum: - header @@ -40458,6 +41262,7 @@ service: script source: openapi: ../openapi.yml + inline: true ScriptsUpsertCustomCodeResponse: properties: scripts: @@ -40509,6 +41314,7 @@ service: script source: openapi: ../openapi.yml + inline: true ScriptsListCustomCodeBlocksResponseBlocksItem: docs: A specific instance of Custom Code applied to a Site or Page properties: @@ -40535,6 +41341,7 @@ service: docs: The date the Block was most recently updated source: openapi: ../openapi.yml + inline: true ScriptsListCustomCodeBlocksResponsePagination: docs: Pagination object properties: @@ -40549,6 +41356,7 @@ service: docs: The total number of records source: openapi: ../openapi.yml + inline: true ScriptsListCustomCodeBlocksResponse: docs: Custom Code Blocks corresponding to where scripts were applied properties: @@ -40878,6 +41686,7 @@ service: "types": { "TokenAuthorizedByResponse": { "docs": undefined, + "inline": undefined, "properties": { "email": { "docs": "The user's email address", @@ -40908,6 +41717,7 @@ service: }, "TokenIntrospectResponse": { "docs": undefined, + "inline": undefined, "properties": { "application": "optional", "authorization": { @@ -40921,6 +41731,7 @@ service: }, "TokenIntrospectResponseAuthorization": { "docs": "The Authorization object", + "inline": true, "properties": { "authorizedTo": "optional", "createdOn": { @@ -40954,6 +41765,7 @@ service: }, "TokenIntrospectResponseAuthorizationAuthorizedTo": { "docs": undefined, + "inline": true, "properties": { "siteIds": { "docs": "Array of Sites this app is authorized to", @@ -41006,6 +41818,7 @@ service: docs: Array of Users this app is authorized to source: openapi: ../openapi.yml + inline: true TokenIntrospectResponseAuthorization: docs: The Authorization object properties: @@ -41030,6 +41843,7 @@ service: authorizedTo: optional source: openapi: ../openapi.yml + inline: true TokenIntrospectResponse: properties: authorization: @@ -41569,6 +42383,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) "types": { "UserAccountAddedPayload": { "docs": undefined, + "inline": undefined, "properties": { "payload": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items @@ -41587,6 +42402,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) "UserAccountAddedPayloadPayload": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": true, "properties": { "accessGroups": { "docs": "Access groups the user belongs to", @@ -41631,6 +42447,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UserAccountAddedPayloadPayloadAccessGroupsItem": { "docs": "Access group slugs and types", + "inline": true, "properties": { "slug": { "docs": "Access group identifier for APIs", @@ -41663,6 +42480,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UserAccountAddedPayloadPayloadData": { "docs": "An object containing the User's basic info and custom fields", + "inline": true, "properties": { "data": "optional", }, @@ -41672,6 +42490,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UserAccountAddedPayloadPayloadDataData": { "docs": undefined, + "inline": true, "properties": { "accept-communications": { "docs": "Boolean indicating if the user has accepted to receive communications @@ -41726,6 +42545,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UserAccountDeletedPayload": { "docs": undefined, + "inline": undefined, "properties": { "payload": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items @@ -41744,6 +42564,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) "UserAccountDeletedPayloadPayload": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": true, "properties": { "accessGroups": { "docs": "Access groups the user belongs to", @@ -41788,6 +42609,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UserAccountDeletedPayloadPayloadAccessGroupsItem": { "docs": "Access group slugs and types", + "inline": true, "properties": { "slug": { "docs": "Access group identifier for APIs", @@ -41820,6 +42642,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UserAccountDeletedPayloadPayloadData": { "docs": "An object containing the User's basic info and custom fields", + "inline": true, "properties": { "data": "optional", }, @@ -41829,6 +42652,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UserAccountDeletedPayloadPayloadDataData": { "docs": undefined, + "inline": true, "properties": { "accept-communications": { "docs": "Boolean indicating if the user has accepted to receive communications @@ -41883,6 +42707,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UserAccountUpdatedPayload": { "docs": undefined, + "inline": undefined, "properties": { "payload": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items @@ -41901,6 +42726,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) "UserAccountUpdatedPayloadPayload": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": true, "properties": { "accessGroups": { "docs": "Access groups the user belongs to", @@ -41945,6 +42771,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UserAccountUpdatedPayloadPayloadAccessGroupsItem": { "docs": "Access group slugs and types", + "inline": true, "properties": { "slug": { "docs": "Access group identifier for APIs", @@ -41977,6 +42804,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UserAccountUpdatedPayloadPayloadData": { "docs": "An object containing the User's basic info and custom fields", + "inline": true, "properties": { "data": "optional", }, @@ -41986,6 +42814,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UserAccountUpdatedPayloadPayloadDataData": { "docs": undefined, + "inline": true, "properties": { "accept-communications": { "docs": "Boolean indicating if the user has accepted to receive communications @@ -42041,6 +42870,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) "UsersGetResponse": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "accessGroups": { "docs": "Access groups the user belongs to", @@ -42085,6 +42915,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersGetResponseAccessGroupsItem": { "docs": "Access group slugs and types", + "inline": true, "properties": { "slug": { "docs": "Access group identifier for APIs", @@ -42117,6 +42948,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersGetResponseData": { "docs": "An object containing the User's basic info and custom fields", + "inline": true, "properties": { "data": "optional", }, @@ -42126,6 +42958,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersGetResponseDataData": { "docs": undefined, + "inline": true, "properties": { "accept-communications": { "docs": "Boolean indicating if the user has accepted to receive communications @@ -42170,6 +43003,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) "UsersInviteResponse": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "accessGroups": { "docs": "Access groups the user belongs to", @@ -42214,6 +43048,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersInviteResponseAccessGroupsItem": { "docs": "Access group slugs and types", + "inline": true, "properties": { "slug": { "docs": "Access group identifier for APIs", @@ -42246,6 +43081,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersInviteResponseData": { "docs": "An object containing the User's basic info and custom fields", + "inline": true, "properties": { "data": "optional", }, @@ -42255,6 +43091,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersInviteResponseDataData": { "docs": undefined, + "inline": true, "properties": { "accept-communications": { "docs": "Boolean indicating if the user has accepted to receive communications @@ -42355,6 +43192,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersListResponse": { "docs": "The list users results", + "inline": undefined, "properties": { "count": { "docs": "Number of users returned", @@ -42386,6 +43224,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) "UsersListResponseUsersItem": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": true, "properties": { "accessGroups": { "docs": "Access groups the user belongs to", @@ -42430,6 +43269,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersListResponseUsersItemAccessGroupsItem": { "docs": "Access group slugs and types", + "inline": true, "properties": { "slug": { "docs": "Access group identifier for APIs", @@ -42462,6 +43302,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersListResponseUsersItemData": { "docs": "An object containing the User's basic info and custom fields", + "inline": true, "properties": { "data": "optional", }, @@ -42471,6 +43312,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersListResponseUsersItemDataData": { "docs": undefined, + "inline": true, "properties": { "accept-communications": { "docs": "Boolean indicating if the user has accepted to receive communications @@ -42514,6 +43356,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersUpdateRequestData": { "docs": undefined, + "inline": true, "properties": { "accept-communications": { "docs": "Boolean indicating if the user has accepted to receive communications @@ -42538,6 +43381,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) "UsersUpdateResponse": { "docs": "The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items ", + "inline": undefined, "properties": { "accessGroups": { "docs": "Access groups the user belongs to", @@ -42582,6 +43426,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersUpdateResponseAccessGroupsItem": { "docs": "Access group slugs and types", + "inline": true, "properties": { "slug": { "docs": "Access group identifier for APIs", @@ -42614,6 +43459,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersUpdateResponseData": { "docs": "An object containing the User's basic info and custom fields", + "inline": true, "properties": { "data": "optional", }, @@ -42623,6 +43469,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) }, "UsersUpdateResponseDataData": { "docs": undefined, + "inline": true, "properties": { "accept-communications": { "docs": "Boolean indicating if the user has accepted to receive communications @@ -42822,6 +43669,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) * `ecommerce` - Assigned to the user via an ecommerce purchase source: openapi: ../openapi.yml + inline: true UsersListResponseUsersItemDataData: properties: name: @@ -42845,12 +43693,14 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: Custom user attributes source: openapi: ../openapi.yml + inline: true UsersListResponseUsersItemData: docs: An object containing the User's basic info and custom fields properties: data: optional source: openapi: ../openapi.yml + inline: true UsersListResponseUsersItem: docs: > The fields that define the schema for a given Item are based on the @@ -42887,6 +43737,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: An object containing the User's basic info and custom fields source: openapi: ../openapi.yml + inline: true UsersListResponse: docs: The list users results properties: @@ -42941,6 +43792,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) * `ecommerce` - Assigned to the user via an ecommerce purchase source: openapi: ../openapi.yml + inline: true UsersGetResponseDataData: properties: name: @@ -42964,12 +43816,14 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: Custom user attributes source: openapi: ../openapi.yml + inline: true UsersGetResponseData: docs: An object containing the User's basic info and custom fields properties: data: optional source: openapi: ../openapi.yml + inline: true UsersGetResponse: docs: > The fields that define the schema for a given Item are based on the @@ -43022,6 +43876,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) Boolean indicating if the user has accepted to receive communications source: openapi: ../openapi.yml + inline: true UsersUpdateResponseStatus: enum: - invited @@ -43054,6 +43909,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) * `ecommerce` - Assigned to the user via an ecommerce purchase source: openapi: ../openapi.yml + inline: true UsersUpdateResponseDataData: properties: name: @@ -43077,12 +43933,14 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: Custom user attributes source: openapi: ../openapi.yml + inline: true UsersUpdateResponseData: docs: An object containing the User's basic info and custom fields properties: data: optional source: openapi: ../openapi.yml + inline: true UsersUpdateResponse: docs: > The fields that define the schema for a given Item are based on the @@ -43151,6 +44009,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) * `ecommerce` - Assigned to the user via an ecommerce purchase source: openapi: ../openapi.yml + inline: true UsersInviteResponseDataData: properties: name: @@ -43174,12 +44033,14 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: Custom user attributes source: openapi: ../openapi.yml + inline: true UsersInviteResponseData: docs: An object containing the User's basic info and custom fields properties: data: optional source: openapi: ../openapi.yml + inline: true UsersInviteResponse: docs: > The fields that define the schema for a given Item are based on the @@ -43256,6 +44117,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) * `ecommerce` - Assigned to the user via an ecommerce purchase source: openapi: ../openapi.yml + inline: true UserAccountAddedPayloadPayloadDataData: properties: name: @@ -43279,12 +44141,14 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: Custom user attributes source: openapi: ../openapi.yml + inline: true UserAccountAddedPayloadPayloadData: docs: An object containing the User's basic info and custom fields properties: data: optional source: openapi: ../openapi.yml + inline: true UserAccountAddedPayloadPayload: docs: > The fields that define the schema for a given Item are based on the @@ -43321,6 +44185,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: An object containing the User's basic info and custom fields source: openapi: ../openapi.yml + inline: true UserAccountAddedPayload: properties: triggerType: @@ -43375,6 +44240,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) * `ecommerce` - Assigned to the user via an ecommerce purchase source: openapi: ../openapi.yml + inline: true UserAccountUpdatedPayloadPayloadDataData: properties: name: @@ -43398,12 +44264,14 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: Custom user attributes source: openapi: ../openapi.yml + inline: true UserAccountUpdatedPayloadPayloadData: docs: An object containing the User's basic info and custom fields properties: data: optional source: openapi: ../openapi.yml + inline: true UserAccountUpdatedPayloadPayload: docs: > The fields that define the schema for a given Item are based on the @@ -43440,6 +44308,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: An object containing the User's basic info and custom fields source: openapi: ../openapi.yml + inline: true UserAccountUpdatedPayload: properties: triggerType: @@ -43494,6 +44363,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) * `ecommerce` - Assigned to the user via an ecommerce purchase source: openapi: ../openapi.yml + inline: true UserAccountDeletedPayloadPayloadDataData: properties: name: @@ -43517,12 +44387,14 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: Custom user attributes source: openapi: ../openapi.yml + inline: true UserAccountDeletedPayloadPayloadData: docs: An object containing the User's basic info and custom fields properties: data: optional source: openapi: ../openapi.yml + inline: true UserAccountDeletedPayloadPayload: docs: > The fields that define the schema for a given Item are based on the @@ -43559,6 +44431,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) docs: An object containing the User's basic info and custom fields source: openapi: ../openapi.yml + inline: true UserAccountDeletedPayload: properties: triggerType: @@ -44228,6 +45101,7 @@ webhooks: "types": { "WebhooksCreateRequestFilter": { "docs": "Only supported for the `form_submission` trigger type. Filter for the form you want Webhooks to be sent for. ", + "inline": true, "properties": { "name": { "docs": "The name of the form you'd like to recieve notifications for.", @@ -44278,6 +45152,7 @@ webhooks: }, "WebhooksCreateResponse": { "docs": undefined, + "inline": undefined, "properties": { "createdOn": { "docs": "Date the Webhook registration was created", @@ -44333,6 +45208,7 @@ webhooks: }, "WebhooksCreateResponseFilter": { "docs": "Only supported for the `form_submission` trigger type. Filter for the form you want Webhooks to be sent for. ", + "inline": true, "properties": { "name": { "docs": "The name of the form you'd like to recieve notifications for.", @@ -44383,6 +45259,7 @@ webhooks: }, "WebhooksGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "createdOn": { "docs": "Date the Webhook registration was created", @@ -44438,6 +45315,7 @@ webhooks: }, "WebhooksGetResponseFilter": { "docs": "Only supported for the `form_submission` trigger type. Filter for the form you want Webhooks to be sent for. ", + "inline": true, "properties": { "name": { "docs": "The name of the form you'd like to recieve notifications for.", @@ -44488,6 +45366,7 @@ webhooks: }, "WebhooksListResponse": { "docs": undefined, + "inline": undefined, "properties": { "pagination": { "docs": "Pagination object", @@ -44501,6 +45380,7 @@ webhooks: }, "WebhooksListResponsePagination": { "docs": "Pagination object", + "inline": true, "properties": { "limit": { "docs": "The limit used for pagination", @@ -44521,6 +45401,7 @@ webhooks: }, "WebhooksListResponseWebhooksItem": { "docs": undefined, + "inline": true, "properties": { "createdOn": { "docs": "Date the Webhook registration was created", @@ -44576,6 +45457,7 @@ webhooks: }, "WebhooksListResponseWebhooksItemFilter": { "docs": "Only supported for the `form_submission` trigger type. Filter for the form you want Webhooks to be sent for. ", + "inline": true, "properties": { "name": { "docs": "The name of the form you'd like to recieve notifications for.", @@ -44641,6 +45523,7 @@ webhooks: docs: The total number of records source: openapi: ../openapi.yml + inline: true WebhooksListResponseWebhooksItemTriggerType: enum: - form_submission @@ -44711,6 +45594,7 @@ webhooks: docs: The name of the form you'd like to recieve notifications for. source: openapi: ../openapi.yml + inline: true WebhooksListResponseWebhooksItem: properties: id: @@ -44782,6 +45666,7 @@ webhooks: docs: Date the Webhook registration was created source: openapi: ../openapi.yml + inline: true WebhooksListResponse: properties: pagination: @@ -44860,6 +45745,7 @@ webhooks: docs: The name of the form you'd like to recieve notifications for. source: openapi: ../openapi.yml + inline: true WebhooksCreateResponseTriggerType: enum: - form_submission @@ -44930,6 +45816,7 @@ webhooks: docs: The name of the form you'd like to recieve notifications for. source: openapi: ../openapi.yml + inline: true WebhooksCreateResponse: properties: id: @@ -45071,6 +45958,7 @@ webhooks: docs: The name of the form you'd like to recieve notifications for. source: openapi: ../openapi.yml + inline: true WebhooksGetResponse: properties: id: diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/webhooks.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/webhooks.json index d52ee4ba306..6549bc09a14 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/webhooks.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/webhooks.json @@ -8,6 +8,7 @@ "types": { "Pet": { "docs": undefined, + "inline": undefined, "properties": { "id": "long", "name": "string", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-audiences.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-audiences.json index 9ea17ce95a6..692e2c0fb1d 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-audiences.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-audiences.json @@ -51,6 +51,7 @@ "types": { "BaseUser": { "docs": undefined, + "inline": undefined, "properties": { "id": { "audiences": [ diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-auth-variables.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-auth-variables.json index 2c23ca6fdaf..0b288cfa31b 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-auth-variables.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-auth-variables.json @@ -71,6 +71,7 @@ "types": { "UserGetAllResponseItem": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", @@ -88,6 +89,7 @@ }, "UserGetResponse": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-encoding.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-encoding.json index ae27944f654..915d16f92c3 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-encoding.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-encoding.json @@ -22,6 +22,7 @@ "type": "google.protobuf.Value", }, }, + "inline": undefined, "source": { "openapi": "../openapi.yml", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-global-headers.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-global-headers.json index 3918bfd4d6d..c96e3d9c727 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-global-headers.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-global-headers.json @@ -8,6 +8,7 @@ "types": { "StreamUser": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", @@ -26,6 +27,7 @@ }, "User": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-ignore.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-ignore.json index f63e11f3957..3ae3f0d02bb 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-ignore.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-ignore.json @@ -58,6 +58,7 @@ "types": { "Meta": { "docs": undefined, + "inline": undefined, "properties": { "hasMore": "optional", }, @@ -67,6 +68,7 @@ }, "User": { "docs": undefined, + "inline": undefined, "properties": { "age": "optional", "email": "optional", @@ -87,6 +89,7 @@ }, "UsersResponse": { "docs": undefined, + "inline": undefined, "properties": { "meta": "optional", "users": "optional>", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-pagination.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-pagination.json index a01b42ff886..d3241a7f8f5 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-pagination.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-pagination.json @@ -63,6 +63,7 @@ "types": { "Meta": { "docs": undefined, + "inline": undefined, "properties": { "hasMore": "optional", }, @@ -72,6 +73,7 @@ }, "User": { "docs": undefined, + "inline": undefined, "properties": { "age": "optional", "email": "optional", @@ -92,6 +94,7 @@ }, "UsersResponse": { "docs": undefined, + "inline": undefined, "properties": { "meta": "optional", "users": "optional>", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-property-name.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-property-name.json index 6adeac7a1c8..44779d38820 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-property-name.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-property-name.json @@ -8,6 +8,7 @@ "types": { "BaseUser": { "docs": undefined, + "inline": undefined, "properties": { "id": { "name": "renamed_id", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-resolutions.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-resolutions.json index ed9839ce3ac..98f46b082c0 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-resolutions.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-resolutions.json @@ -8,6 +8,7 @@ "types": { "User": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-sdk-group-name-with-streaming.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-sdk-group-name-with-streaming.json index ab43256e6ff..b71914d179a 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-sdk-group-name-with-streaming.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-sdk-group-name-with-streaming.json @@ -8,6 +8,7 @@ "types": { "StreamUser": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", @@ -26,6 +27,7 @@ }, "User": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-sdk-group-name.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-sdk-group-name.json index ba79432b480..8922916ae27 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-sdk-group-name.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-sdk-group-name.json @@ -8,6 +8,7 @@ "types": { "Person": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", @@ -137,6 +138,7 @@ service: "types": { "User": { "docs": "This user object should be in user.yml", + "inline": undefined, "properties": { "associatedPersons": "optional>", "id": { diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-streaming-with-audiences.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-streaming-with-audiences.json index f4893974af2..9cacc3dfa11 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-streaming-with-audiences.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-streaming-with-audiences.json @@ -8,6 +8,7 @@ "types": { "StreamUser": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", @@ -26,6 +27,7 @@ }, "User": { "docs": undefined, + "inline": undefined, "properties": { "id": { "type": "optional", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-streaming-with-reference.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-streaming-with-reference.json index 947e7655e1e..f86cece83a3 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-streaming-with-reference.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-streaming-with-reference.json @@ -8,6 +8,7 @@ "types": { "Completion": { "docs": undefined, + "inline": undefined, "properties": { "text": "optional", }, @@ -17,6 +18,7 @@ }, "CompletionChunk": { "docs": undefined, + "inline": undefined, "properties": { "text": "optional", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-streaming-with-sse.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-streaming-with-sse.json index 798002653c1..59b19cf5096 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-streaming-with-sse.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-streaming-with-sse.json @@ -8,6 +8,7 @@ "types": { "Completion": { "docs": undefined, + "inline": undefined, "properties": { "text": "optional", }, @@ -17,6 +18,7 @@ }, "CompletionChunk": { "docs": undefined, + "inline": undefined, "properties": { "text": "optional", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-streaming-with-stream-condition.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-streaming-with-stream-condition.json index c2486c68f87..1192924a90b 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-streaming-with-stream-condition.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-streaming-with-stream-condition.json @@ -116,6 +116,7 @@ "types": { "ChatFullResponse": { "docs": "Full response to a chat question when the result is not streamed.", + "inline": undefined, "properties": { "answer": { "docs": "The message from the chat model for the chat message.", @@ -136,6 +137,7 @@ }, "ChatStreamedResponse": { "docs": "An individual event when the response is streamed.", + "inline": undefined, "properties": { "chunk": { "docs": "The chunk of the response.", diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-token-variable-name.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-token-variable-name.json index cb4279a8c61..c9383c0f0d5 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-token-variable-name.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-token-variable-name.json @@ -8,6 +8,7 @@ "types": { "Completion": { "docs": undefined, + "inline": undefined, "properties": { "text": "optional", }, @@ -17,6 +18,7 @@ }, "CompletionChunk": { "docs": undefined, + "inline": undefined, "properties": { "text": "optional", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-version.json b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-version.json index 3ae0294234c..546971d5294 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-version.json +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern-tests/src/__test__/__snapshots__/openapi/x-fern-version.json @@ -8,6 +8,7 @@ "types": { "Completion": { "docs": undefined, + "inline": undefined, "properties": { "text": "optional", }, @@ -17,6 +18,7 @@ }, "CompletionChunk": { "docs": undefined, + "inline": undefined, "properties": { "text": "optional", }, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildAuthSchemes.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildAuthSchemes.ts index 777f0e59bb9..db85896d692 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildAuthSchemes.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildAuthSchemes.ts @@ -151,7 +151,7 @@ export function buildAuthSchemes(context: OpenApiIrConverterContext): void { if (securityScheme.scopesEnum != null && securityScheme.scopesEnum.values.length > 0) { context.builder.addType(RelativeFilePath.of("__package__.yml"), { name: "OauthScope", - schema: buildEnumTypeDeclaration(securityScheme.scopesEnum).schema + schema: buildEnumTypeDeclaration(securityScheme.scopesEnum, 0).schema }); } } diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildChannel.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildChannel.ts index 6cad77d57d2..b385c8fbb06 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildChannel.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildChannel.ts @@ -94,7 +94,8 @@ export function buildChannel({ schema: channel.subscribe, context, fileContainingReference: declarationFile, - namespace: maybeChannelNamespace + namespace: maybeChannelNamespace, + declarationDepth: 0 }) } }); @@ -109,7 +110,8 @@ export function buildChannel({ schema: channel.publish, context, fileContainingReference: declarationFile, - namespace: maybeChannelNamespace + namespace: maybeChannelNamespace, + declarationDepth: 0 }) } }); diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildEndpoint.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildEndpoint.ts index 0652f43e711..459a6a38d2d 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildEndpoint.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildEndpoint.ts @@ -179,7 +179,8 @@ export function buildEndpoint({ schema: jsonResponse.schema, context, fileContainingReference: declarationFile, - namespace: maybeEndpointNamespace + namespace: maybeEndpointNamespace, + declarationDepth: 0 }); convertedEndpoint.response = { docs: jsonResponse.description ?? undefined, @@ -194,7 +195,8 @@ export function buildEndpoint({ schema: jsonResponse.schema, context, fileContainingReference: declarationFile, - namespace: maybeEndpointNamespace + namespace: maybeEndpointNamespace, + declarationDepth: 0 }); convertedEndpoint["response-stream"] = { docs: jsonResponse.description ?? undefined, @@ -207,7 +209,8 @@ export function buildEndpoint({ schema: jsonResponse.schema, context, fileContainingReference: declarationFile, - namespace: maybeEndpointNamespace + namespace: maybeEndpointNamespace, + declarationDepth: 0 }); convertedEndpoint["response-stream"] = { docs: jsonResponse.description ?? undefined, @@ -289,7 +292,8 @@ export function buildEndpoint({ context, fileContainingReference: errorDeclarationFile, declarationFile: errorDeclarationFile, - namespace: maybeEndpointNamespace + namespace: maybeEndpointNamespace, + declarationDepth: 0 }); errorDeclaration.type = getTypeFromTypeReference(typeReference); errorDeclaration.docs = httpError.description; @@ -412,7 +416,8 @@ function getRequest({ schema: request.schema, fileContainingReference: declarationFile, context, - namespace + namespace, + declarationDepth: 0 }); const convertedRequest: ConvertedRequest = { schemaIdsToExclude: [], @@ -465,7 +470,8 @@ function getRequest({ schema: property.schema, fileContainingReference: declarationFile, context, - namespace + namespace, + declarationDepth: 1 // 1 level deep for request body properties }); // TODO: clean up conditional logic @@ -523,7 +529,8 @@ function getRequest({ schema: Schema.reference(referencedSchema), fileContainingReference: declarationFile, context, - namespace + namespace, + declarationDepth: 0 }); return getTypeFromTypeReference(allOfTypeReference); }); @@ -589,7 +596,8 @@ function getRequest({ schema: property.schema.value, fileContainingReference: declarationFile, context, - namespace + namespace, + declarationDepth: 1 // 1 level deep for request body properties }); if (property.contentType != null) { if (typeof propertyTypeReference === "string") { diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildFernDefinition.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildFernDefinition.ts index b312a42daea..7a1df104343 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildFernDefinition.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildFernDefinition.ts @@ -40,7 +40,13 @@ function addSchemas({ } const declarationFile = getDeclarationFileForSchema(schema); - const typeDeclaration = buildTypeDeclaration({ schema, context, declarationFile, namespace }); + const typeDeclaration = buildTypeDeclaration({ + schema, + context, + declarationFile, + namespace, + declarationDepth: 0 + }); // HACKHACK: Skip self-referencing schemas. I'm not sure if this is the right way to do this. if (isRawAliasDefinition(typeDeclaration.schema)) { diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildGlobalHeaders.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildGlobalHeaders.ts index 5f33baf737c..bed1a4d3032 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildGlobalHeaders.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildGlobalHeaders.ts @@ -65,7 +65,8 @@ export function buildGlobalHeaders(context: OpenApiIrConverterContext): void { fileContainingReference: namespace ? join(RelativeFilePath.of(camelCase(namespace)), defaultFile) : defaultFile, - namespace + namespace, + declarationDepth: 0 }) ) ?? "optional" : "optional" diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildHeader.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildHeader.ts index 62f0795c7af..6421e05b491 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildHeader.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildHeader.ts @@ -22,7 +22,8 @@ export function buildHeader({ schema: header.schema, context, fileContainingReference, - namespace + namespace, + declarationDepth: 0 }); const headerType = getTypeFromTypeReference(typeReference); const headerWithoutXPrefix = header.name.replace(/^x-|^X-/, ""); diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildPathParameter.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildPathParameter.ts index 40d17539f11..64843e28e3e 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildPathParameter.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildPathParameter.ts @@ -21,7 +21,8 @@ export function buildPathParameter({ schema: pathParameter.schema, context, fileContainingReference, - namespace + namespace, + declarationDepth: 0 }); if ( pathParameter.variableReference == null && diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildQueryParameter.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildQueryParameter.ts index 452108871bf..bac2fadb1de 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildQueryParameter.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildQueryParameter.ts @@ -113,7 +113,8 @@ function getQueryParameterTypeReference({ context, declarationFile: RelativeFilePath.of(FERN_PACKAGE_MARKER_FILENAME), fileContainingReference, - namespace + namespace, + declarationDepth: 0 }), allowMultiple: true }; @@ -164,7 +165,8 @@ function getQueryParameterTypeReference({ }), context, fileContainingReference, - namespace + namespace, + declarationDepth: 0 }), allowMultiple: true }; @@ -187,7 +189,8 @@ function getQueryParameterTypeReference({ }), context, fileContainingReference, - namespace + namespace, + declarationDepth: 0 }), allowMultiple: true }; @@ -210,7 +213,8 @@ function getQueryParameterTypeReference({ context, fileContainingReference, declarationFile: RelativeFilePath.of(FERN_PACKAGE_MARKER_FILENAME), - namespace + namespace, + declarationDepth: 0 }), allowMultiple: false }; @@ -237,7 +241,8 @@ function getQueryParameterTypeReference({ context, fileContainingReference, declarationFile: RelativeFilePath.of(FERN_PACKAGE_MARKER_FILENAME), - namespace + namespace, + declarationDepth: 0 }), allowMultiple: true }; @@ -248,7 +253,8 @@ function getQueryParameterTypeReference({ context, fileContainingReference, declarationFile: RelativeFilePath.of(FERN_PACKAGE_MARKER_FILENAME), - namespace + namespace, + declarationDepth: 0 }), allowMultiple: false }; @@ -268,7 +274,8 @@ function getQueryParameterTypeReference({ }), context, fileContainingReference, - namespace + namespace, + declarationDepth: 0 }), allowMultiple: true }; @@ -319,7 +326,8 @@ function getQueryParameterTypeReference({ }), context, fileContainingReference, - namespace + namespace, + declarationDepth: 0 }), allowMultiple: true }; @@ -342,7 +350,8 @@ function getQueryParameterTypeReference({ }), context, fileContainingReference, - namespace + namespace, + declarationDepth: 0 }), allowMultiple: true }; @@ -374,7 +383,8 @@ function getQueryParameterTypeReference({ context, fileContainingReference, declarationFile: RelativeFilePath.of(FERN_PACKAGE_MARKER_FILENAME), - namespace + namespace, + declarationDepth: 0 }), allowMultiple: false }; @@ -386,7 +396,8 @@ function getQueryParameterTypeReference({ schema, context, fileContainingReference, - namespace + namespace, + declarationDepth: 0 }), allowMultiple: false }; @@ -406,7 +417,8 @@ function getQueryParameterTypeReference({ }), context, fileContainingReference, - namespace + namespace, + declarationDepth: 0 }), allowMultiple: true }; @@ -416,7 +428,8 @@ function getQueryParameterTypeReference({ schema, context, fileContainingReference, - namespace + namespace, + declarationDepth: 0 }), allowMultiple: false }; diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeDeclaration.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeDeclaration.ts index 50f07a344ea..c23a010f319 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeDeclaration.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeDeclaration.ts @@ -42,36 +42,44 @@ export function buildTypeDeclaration({ schema, context, declarationFile, - namespace + namespace, + declarationDepth }: { schema: Schema; context: OpenApiIrConverterContext; /* The file the type declaration will be added to */ declarationFile: RelativeFilePath; namespace: string | undefined; + declarationDepth: number; }): ConvertedTypeDeclaration { switch (schema.type) { case "primitive": return buildPrimitiveTypeDeclaration(schema); case "array": - return buildArrayTypeDeclaration({ schema, context, declarationFile, namespace }); + return buildArrayTypeDeclaration({ schema, context, declarationFile, namespace, declarationDepth }); case "map": - return buildMapTypeDeclaration({ schema, context, declarationFile, namespace }); + return buildMapTypeDeclaration({ schema, context, declarationFile, namespace, declarationDepth }); case "reference": return buildReferenceTypeDeclaration({ schema, context, declarationFile, namespace }); case "unknown": return buildUnknownTypeDeclaration(schema.nameOverride, schema.generatedName); case "optional": case "nullable": - return buildOptionalTypeDeclaration({ schema, context, declarationFile, namespace }); + return buildOptionalTypeDeclaration({ schema, context, declarationFile, namespace, declarationDepth }); case "enum": - return buildEnumTypeDeclaration(schema); + return buildEnumTypeDeclaration(schema, declarationDepth); case "literal": return buildLiteralTypeDeclaration(schema, schema.nameOverride, schema.generatedName); case "object": - return buildObjectTypeDeclaration({ schema, context, declarationFile, namespace }); + return buildObjectTypeDeclaration({ schema, context, declarationFile, namespace, declarationDepth }); case "oneOf": - return buildOneOfTypeDeclaration({ schema: schema.value, context, declarationFile, namespace }); + return buildOneOfTypeDeclaration({ + schema: schema.value, + context, + declarationFile, + namespace, + declarationDepth + }); default: assertNever(schema); } @@ -81,12 +89,14 @@ export function buildObjectTypeDeclaration({ schema, context, declarationFile, - namespace + namespace, + declarationDepth }: { schema: ObjectSchema; context: OpenApiIrConverterContext; declarationFile: RelativeFilePath; namespace: string | undefined; + declarationDepth: number; }): ConvertedTypeDeclaration { const shouldSkipReadonly = context.isInState(State.Request) && @@ -131,19 +141,19 @@ export function buildObjectTypeDeclaration({ schema: property.schema, context, fileContainingReference: declarationFile, - namespace + namespace, + declarationDepth: declarationDepth + 1 }); const audiences = property.audiences; const name = property.nameOverride; const availability = convertAvailability(property.availability); - - properties[property.key] = convertPropertyTypeReferenceToTypeDefinition( + properties[property.key] = convertPropertyTypeReferenceToTypeDefinition({ typeReference, audiences, name, availability - ); + }); } const propertiesToSetToUnknown: Set = new Set(); @@ -167,7 +177,8 @@ export function buildObjectTypeDeclaration({ schema: Schema.reference(allOf), context, fileContainingReference: declarationFile, - namespace + namespace, + declarationDepth: declarationDepth + 1 }); extendedSchemas.push(getTypeFromTypeReference(allOfTypeReference)); } @@ -183,7 +194,8 @@ export function buildObjectTypeDeclaration({ schema: propertyToInline.schema, context, fileContainingReference: declarationFile, - namespace + namespace, + declarationDepth: declarationDepth + 1 }); } } @@ -195,7 +207,8 @@ export function buildObjectTypeDeclaration({ schema: Schema.reference(extendedSchema), context, fileContainingReference: declarationFile, - namespace + namespace, + declarationDepth: declarationDepth + 1 }); extendedSchemas.push(getTypeFromTypeReference(extendedSchemaTypeReference)); } @@ -236,6 +249,8 @@ export function buildObjectTypeDeclaration({ objectTypeDeclaration.source = convertToSourceSchema(schema.source); } + objectTypeDeclaration.inline = getInline(declarationDepth); + const name = schema.nameOverride ?? schema.generatedName; return { name: readOnlyPropertyPresent && context.respectReadonlySchemas && !shouldSkipReadonly ? `${name}Read` : name, @@ -302,12 +317,14 @@ export function buildArrayTypeDeclaration({ schema, context, declarationFile, - namespace + namespace, + declarationDepth }: { schema: ArraySchema; context: OpenApiIrConverterContext; declarationFile: RelativeFilePath; namespace: string | undefined; + declarationDepth: number; }): ConvertedTypeDeclaration { return { name: schema.nameOverride ?? schema.generatedName, @@ -316,7 +333,8 @@ export function buildArrayTypeDeclaration({ fileContainingReference: declarationFile, declarationFile, context, - namespace + namespace, + declarationDepth }) }; } @@ -325,12 +343,14 @@ export function buildMapTypeDeclaration({ schema, context, declarationFile, - namespace + namespace, + declarationDepth }: { schema: MapSchema; context: OpenApiIrConverterContext; declarationFile: RelativeFilePath; namespace: string | undefined; + declarationDepth: number; }): ConvertedTypeDeclaration { return { name: schema.nameOverride ?? schema.generatedName, @@ -339,7 +359,8 @@ export function buildMapTypeDeclaration({ fileContainingReference: declarationFile, declarationFile, context, - namespace + namespace, + declarationDepth }) }; } @@ -367,7 +388,7 @@ function isCasingEmpty(casing: CasingOverrides): boolean { return casing.camel == null && casing.pascal == null && casing.screamingSnake == null && casing.snake == null; } -export function buildEnumTypeDeclaration(schema: EnumSchema): ConvertedTypeDeclaration { +export function buildEnumTypeDeclaration(schema: EnumSchema, declarationDepth: number): ConvertedTypeDeclaration { const enumSchema: RawSchemas.EnumSchema = { enum: schema.values.map((enumValue) => { const name = enumValue.nameOverride ?? enumValue.generatedName; @@ -434,6 +455,8 @@ export function buildEnumTypeDeclaration(schema: EnumSchema): ConvertedTypeDecla uniqueEnumName.add(name.toLowerCase()); } // TODO: log a warning if the name is not unique } + enumSchema.inline = getInline(declarationDepth); + return { name: schema.nameOverride ?? schema.generatedName, schema: uniqueEnumSchema @@ -453,7 +476,12 @@ export function buildReferenceTypeDeclaration({ }): ConvertedTypeDeclaration { return { name: schema.nameOverride ?? schema.generatedName, - schema: buildReferenceTypeReference({ schema, context, fileContainingReference: declarationFile, namespace }) + schema: buildReferenceTypeReference({ + schema, + context, + fileContainingReference: declarationFile, + namespace + }) }; } @@ -461,12 +489,14 @@ export function buildOptionalTypeDeclaration({ schema, context, declarationFile, - namespace + namespace, + declarationDepth }: { schema: OptionalSchema; context: OpenApiIrConverterContext; declarationFile: RelativeFilePath; namespace: string | undefined; + declarationDepth: number; }): ConvertedTypeDeclaration { return { name: schema.nameOverride ?? schema.generatedName, @@ -475,7 +505,8 @@ export function buildOptionalTypeDeclaration({ context, fileContainingReference: declarationFile, declarationFile, - namespace + namespace, + declarationDepth }) }; } @@ -505,12 +536,14 @@ export function buildOneOfTypeDeclaration({ schema, context, declarationFile, - namespace + namespace, + declarationDepth }: { schema: OneOfSchema; context: OpenApiIrConverterContext; declarationFile: RelativeFilePath; namespace: string | undefined; + declarationDepth: number; }): ConvertedTypeDeclaration { const encoding = schema.encoding != null ? convertToEncodingSchema(schema.encoding) : undefined; if (schema.type === "discriminated") { @@ -520,7 +553,8 @@ export function buildOneOfTypeDeclaration({ schema: property.schema, fileContainingReference: declarationFile, context, - namespace + namespace, + declarationDepth: declarationDepth + 1 }); } const union: Record = {}; @@ -529,7 +563,8 @@ export function buildOneOfTypeDeclaration({ schema: subSchema, context, fileContainingReference: declarationFile, - namespace + namespace, + declarationDepth: declarationDepth + 1 }); } return { @@ -553,7 +588,8 @@ export function buildOneOfTypeDeclaration({ schema: subSchema, fileContainingReference: declarationFile, context, - namespace + namespace, + declarationDepth: declarationDepth + 1 }) ); } @@ -564,7 +600,8 @@ export function buildOneOfTypeDeclaration({ docs: schema.description ?? undefined, union, encoding, - source: schema.source != null ? convertToSourceSchema(schema.source) : undefined + source: schema.source != null ? convertToSourceSchema(schema.source) : undefined, + inline: getInline(declarationDepth) } }; } @@ -593,12 +630,17 @@ function getSchemaIdOfResolvedType({ return schema; } -function convertPropertyTypeReferenceToTypeDefinition( - typeReference: RawSchemas.TypeReferenceSchema, - audiences: string[], - name?: string | undefined, - availability?: RawSchemas.AvailabilityUnionSchema -): RawSchemas.ObjectPropertySchema { +function convertPropertyTypeReferenceToTypeDefinition({ + typeReference, + audiences, + name, + availability +}: { + typeReference: RawSchemas.TypeReferenceSchema; + audiences: string[]; + name?: string | undefined; + availability?: RawSchemas.AvailabilityUnionSchema; +}): RawSchemas.ObjectPropertySchema { if (audiences.length === 0 && name == null && availability == null) { return typeReference; } else { @@ -610,3 +652,13 @@ function convertPropertyTypeReferenceToTypeDefinition( }; } } + +/** + * Returns whether the declaration should be inlined. + * If a declaration is nested within another declaration, it should be inlined. + * @param declarationDepth Keeps track of how nested the declaration is. + * @returns `true` if the declaration should be inlined, `undefined` otherwise. + */ +function getInline(declarationDepth: number): boolean | undefined { + return declarationDepth > 0 ? true : undefined; +} diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeReference.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeReference.ts index 7c00ce49751..ef832baec35 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeReference.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildTypeReference.ts @@ -50,13 +50,15 @@ export function buildTypeReference({ /* The file any type declarations will be written to. Defaults to fileContainingReference if not present */ declarationFile = fileContainingReference, context, - namespace + namespace, + declarationDepth }: { schema: Schema; fileContainingReference: RelativeFilePath; declarationFile?: RelativeFilePath; context: OpenApiIrConverterContext; namespace: string | undefined; + declarationDepth: number; }): RawSchemas.TypeReferenceSchema { if (context.shouldMarkSchemaAsReferenced()) { context.markSchemaAsReferenced(schema, namespace); @@ -66,30 +68,70 @@ export function buildTypeReference({ return buildPrimitiveTypeReference(schema); } case "array": - return buildArrayTypeReference({ schema, fileContainingReference, context, declarationFile, namespace }); + return buildArrayTypeReference({ + schema, + fileContainingReference, + context, + declarationFile, + namespace, + declarationDepth + }); case "map": - return buildMapTypeReference({ schema, fileContainingReference, context, declarationFile, namespace }); + return buildMapTypeReference({ + schema, + fileContainingReference, + context, + declarationFile, + namespace, + declarationDepth + }); case "reference": - return buildReferenceTypeReference({ schema, fileContainingReference, context, namespace }); + return buildReferenceTypeReference({ + schema, + fileContainingReference, + context, + namespace + }); case "unknown": return buildUnknownTypeReference(); case "optional": case "nullable": - return buildOptionalTypeReference({ schema, fileContainingReference, context, declarationFile, namespace }); + return buildOptionalTypeReference({ + schema, + fileContainingReference, + context, + declarationFile, + namespace, + declarationDepth + }); case "enum": - return buildEnumTypeReference({ schema, fileContainingReference, context, declarationFile }); + return buildEnumTypeReference({ + schema, + fileContainingReference, + context, + declarationFile, + declarationDepth + }); case "literal": schema.value; return buildLiteralTypeReference(schema); case "object": - return buildObjectTypeReference({ schema, fileContainingReference, context, declarationFile, namespace }); + return buildObjectTypeReference({ + schema, + fileContainingReference, + context, + declarationFile, + namespace, + declarationDepth + }); case "oneOf": return buildOneOfTypeReference({ schema: schema.value, fileContainingReference, context, declarationFile, - namespace + namespace, + declarationDepth }); default: assertNever(schema); @@ -435,20 +477,23 @@ export function buildArrayTypeReference({ fileContainingReference, declarationFile, context, - namespace + namespace, + declarationDepth }: { schema: ArraySchema; fileContainingReference: RelativeFilePath; declarationFile: RelativeFilePath; context: OpenApiIrConverterContext; namespace: string | undefined; + declarationDepth: number; }): RawSchemas.TypeReferenceSchema { const item = buildTypeReference({ schema: schema.value, fileContainingReference, declarationFile, context, - namespace + namespace, + declarationDepth }); const type = `list<${getTypeFromTypeReference(item)}>`; if (schema.description == null && schema.title == null) { @@ -466,13 +511,15 @@ export function buildMapTypeReference({ fileContainingReference, declarationFile, context, - namespace + namespace, + declarationDepth }: { schema: MapSchema; fileContainingReference: RelativeFilePath; declarationFile: RelativeFilePath; context: OpenApiIrConverterContext; namespace: string | undefined; + declarationDepth: number; }): RawSchemas.TypeReferenceSchema { const keyTypeReference = buildPrimitiveTypeReference(schema.key); const valueTypeReference = buildTypeReference({ @@ -480,7 +527,8 @@ export function buildMapTypeReference({ fileContainingReference, declarationFile, context, - namespace + namespace, + declarationDepth }); const encoding = schema.encoding != null ? convertToEncodingSchema(schema.encoding) : undefined; const type = `map<${getTypeFromTypeReference(keyTypeReference)}, ${getTypeFromTypeReference(valueTypeReference)}>`; @@ -507,20 +555,23 @@ export function buildOptionalTypeReference({ fileContainingReference, declarationFile, context, - namespace + namespace, + declarationDepth }: { schema: OptionalSchema; fileContainingReference: RelativeFilePath; declarationFile: RelativeFilePath; context: OpenApiIrConverterContext; namespace: string | undefined; + declarationDepth: number; }): RawSchemas.TypeReferenceSchema { const itemTypeReference = buildTypeReference({ schema: schema.value, fileContainingReference, declarationFile, context, - namespace + namespace, + declarationDepth }); const itemType = getTypeFromTypeReference(itemTypeReference); const itemDocs = getDocsFromTypeReference(itemTypeReference); @@ -587,14 +638,16 @@ export function buildEnumTypeReference({ schema, fileContainingReference, declarationFile, - context + context, + declarationDepth }: { schema: EnumSchema; fileContainingReference: RelativeFilePath; declarationFile: RelativeFilePath; context: OpenApiIrConverterContext; + declarationDepth: number; }): RawSchemas.TypeReferenceSchema { - const enumTypeDeclaration = buildEnumTypeDeclaration(schema); + const enumTypeDeclaration = buildEnumTypeDeclaration(schema, declarationDepth); const name = schema.nameOverride ?? schema.generatedName; context.builder.addType(declarationFile, { name, @@ -625,19 +678,22 @@ export function buildObjectTypeReference({ fileContainingReference, declarationFile, context, - namespace + namespace, + declarationDepth }: { schema: ObjectSchema; fileContainingReference: RelativeFilePath; declarationFile: RelativeFilePath; context: OpenApiIrConverterContext; namespace: string | undefined; + declarationDepth: number; }): RawSchemas.TypeReferenceSchema { const objectTypeDeclaration = buildObjectTypeDeclaration({ schema, declarationFile, context, - namespace + namespace, + declarationDepth }); const name = schema.nameOverride ?? schema.generatedName; context.builder.addType(declarationFile, { @@ -660,19 +716,22 @@ export function buildOneOfTypeReference({ fileContainingReference, declarationFile, context, - namespace + namespace, + declarationDepth }: { schema: OneOfSchema; fileContainingReference: RelativeFilePath; declarationFile: RelativeFilePath; context: OpenApiIrConverterContext; namespace: string | undefined; + declarationDepth: number; }): RawSchemas.TypeReferenceSchema { const unionTypeDeclaration = buildOneOfTypeDeclaration({ schema, declarationFile, context, - namespace + namespace, + declarationDepth }); const name = schema.nameOverride ?? schema.generatedName; context.builder.addType(declarationFile, { diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildVariables.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildVariables.ts index 267647b39cc..2278f3cf6b3 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildVariables.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildVariables.ts @@ -15,7 +15,8 @@ export function buildVariables(context: OpenApiIrConverterContext): void { schema: Schema.primitive(variableSchema), context, fileContainingReference: RelativeFilePath.of(FERN_PACKAGE_MARKER_FILENAME), - namespace + namespace, + declarationDepth: 0 }); context.builder.addVariable({ name: variable, diff --git a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildWebhooks.ts b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildWebhooks.ts index 873b197e638..fd93e7b9d52 100644 --- a/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildWebhooks.ts +++ b/packages/cli/api-importers/openapi/openapi-ir-to-fern/src/buildWebhooks.ts @@ -38,7 +38,8 @@ export function buildWebhooks(context: OpenApiIrConverterContext): void { schema: webhook.payload, context, fileContainingReference: webhookLocation.file, - namespace: maybeWebhookNamespace + namespace: maybeWebhookNamespace, + declarationDepth: 0 }), examples: webhook.examples != null diff --git a/packages/cli/api-importers/openapi/openapi-ir/fern/definition/parseIr.yml b/packages/cli/api-importers/openapi/openapi-ir/fern/definition/parseIr.yml index e90083864e7..f5d974fc73a 100644 --- a/packages/cli/api-importers/openapi/openapi-ir/fern/definition/parseIr.yml +++ b/packages/cli/api-importers/openapi/openapi-ir/fern/definition/parseIr.yml @@ -30,7 +30,7 @@ types: path: type: string docs: | - This string includes templated path parameters. + This string includes templated path parameters. For example, `/users/{userId}` is a valid value. summary: optional operationId: optional diff --git a/packages/cli/cli/versions.yml b/packages/cli/cli/versions.yml index 8b5560f35c1..9145038262a 100644 --- a/packages/cli/cli/versions.yml +++ b/packages/cli/cli/versions.yml @@ -1,3 +1,11 @@ +- changelogEntry: + - summary: | + Add `inline` field to type declarations in the Fern definition and IR. + Add support for importing inline types from OpenAPI into Fern definition and IR. + type: internal + irVersion: 53 + version: 0.45.1 + - changelogEntry: - summary: | Several improvements to docs, conjure importer, and the cli. @@ -58,7 +66,7 @@ - changelogEntry: - summary: | - OAuth Client Credential Auth Scheme now supports the ability to optionally + OAuth Client Credential Auth Scheme now supports the ability to optionally set token header and prefix fields for use with docs playground. ```yml api.yml @@ -125,7 +133,7 @@ - changelogEntry: - summary: | - The OpenAPI importer now supports correlating request and response examples by name. When an example name is shared + The OpenAPI importer now supports correlating request and response examples by name. When an example name is shared between a request body and response, they will be paired together in the generated Fern definition. type: fix irVersion: 53 @@ -133,7 +141,7 @@ - changelogEntry: - summary: | - The OpenAPI importer now supports respecting readonly properties in schemas. When enabled, readonly properties will be excluded from request bodies for + The OpenAPI importer now supports respecting readonly properties in schemas. When enabled, readonly properties will be excluded from request bodies for POST/PUT/PATCH endpoints. To enable this, configure the setting in your `generators.yml`: ```yml diff --git a/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__DiscriminatedUnion1.json b/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__DiscriminatedUnion1.json new file mode 100644 index 00000000000..56723478151 --- /dev/null +++ b/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__DiscriminatedUnion1.json @@ -0,0 +1,71 @@ +{ + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "type1", + "type2" + ] + } + }, + "required": [ + "type" + ], + "oneOf": [ + { + "properties": { + "type": { + "const": "type1" + }, + "foo": { + "type": "string" + }, + "bar": { + "$ref": "#/definitions/NestedInlineType1" + } + }, + "required": [ + "type", + "foo", + "bar" + ] + }, + { + "properties": { + "type": { + "const": "type2" + }, + "foo": { + "type": "string" + }, + "bar": { + "type": "string" + } + }, + "required": [ + "type", + "foo", + "bar" + ] + } + ], + "definitions": { + "NestedInlineType1": { + "type": "object", + "properties": { + "foo": { + "type": "string" + }, + "bar": { + "type": "string" + } + }, + "required": [ + "foo", + "bar" + ], + "additionalProperties": false + } + } +} \ No newline at end of file diff --git a/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__InlineEnum.json b/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__InlineEnum.json new file mode 100644 index 00000000000..247b41d0eb2 --- /dev/null +++ b/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__InlineEnum.json @@ -0,0 +1,10 @@ +{ + "type": "string", + "enum": [ + "SUNNY", + "CLOUDY", + "RAINING", + "SNOWING" + ], + "definitions": {} +} \ No newline at end of file diff --git a/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__InlineType1.json b/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__InlineType1.json new file mode 100644 index 00000000000..5204fe27698 --- /dev/null +++ b/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__InlineType1.json @@ -0,0 +1,47 @@ +{ + "type": "object", + "properties": { + "foo": { + "type": "string" + }, + "bar": { + "$ref": "#/definitions/NestedInlineType1" + } + }, + "required": [ + "foo", + "bar" + ], + "additionalProperties": false, + "definitions": { + "InlineEnum": { + "type": "string", + "enum": [ + "SUNNY", + "CLOUDY", + "RAINING", + "SNOWING" + ] + }, + "NestedInlineType1": { + "type": "object", + "properties": { + "foo": { + "type": "string" + }, + "bar": { + "type": "string" + }, + "myEnum": { + "$ref": "#/definitions/InlineEnum" + } + }, + "required": [ + "foo", + "bar", + "myEnum" + ], + "additionalProperties": false + } + } +} \ No newline at end of file diff --git a/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__InlineType2.json b/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__InlineType2.json new file mode 100644 index 00000000000..801c382f354 --- /dev/null +++ b/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__InlineType2.json @@ -0,0 +1,13 @@ +{ + "type": "object", + "properties": { + "baz": { + "type": "string" + } + }, + "required": [ + "baz" + ], + "additionalProperties": false, + "definitions": {} +} \ No newline at end of file diff --git a/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__InlinedDiscriminatedUnion1.json b/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__InlinedDiscriminatedUnion1.json new file mode 100644 index 00000000000..8b87c341009 --- /dev/null +++ b/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__InlinedDiscriminatedUnion1.json @@ -0,0 +1,80 @@ +{ + "type": "object", + "properties": { + "type": { + "type": "string", + "enum": [ + "type1", + "type2" + ] + } + }, + "required": [ + "type" + ], + "oneOf": [ + { + "properties": { + "type": { + "const": "type1" + }, + "foo": { + "type": "string" + }, + "bar": { + "$ref": "#/definitions/NestedInlineType1" + } + }, + "required": [ + "type", + "foo", + "bar" + ] + }, + { + "properties": { + "type": { + "const": "type2" + }, + "baz": { + "type": "string" + } + }, + "required": [ + "type", + "baz" + ] + } + ], + "definitions": { + "InlineEnum": { + "type": "string", + "enum": [ + "SUNNY", + "CLOUDY", + "RAINING", + "SNOWING" + ] + }, + "NestedInlineType1": { + "type": "object", + "properties": { + "foo": { + "type": "string" + }, + "bar": { + "type": "string" + }, + "myEnum": { + "$ref": "#/definitions/InlineEnum" + } + }, + "required": [ + "foo", + "bar", + "myEnum" + ], + "additionalProperties": false + } + } +} \ No newline at end of file diff --git a/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__InlinedUndiscriminatedUnion1.json b/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__InlinedUndiscriminatedUnion1.json new file mode 100644 index 00000000000..6cd71fc31ed --- /dev/null +++ b/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__InlinedUndiscriminatedUnion1.json @@ -0,0 +1,69 @@ +{ + "anyOf": [ + { + "$ref": "#/definitions/InlineType1" + }, + { + "$ref": "#/definitions/InlineType2" + } + ], + "definitions": { + "InlineEnum": { + "type": "string", + "enum": [ + "SUNNY", + "CLOUDY", + "RAINING", + "SNOWING" + ] + }, + "NestedInlineType1": { + "type": "object", + "properties": { + "foo": { + "type": "string" + }, + "bar": { + "type": "string" + }, + "myEnum": { + "$ref": "#/definitions/InlineEnum" + } + }, + "required": [ + "foo", + "bar", + "myEnum" + ], + "additionalProperties": false + }, + "InlineType1": { + "type": "object", + "properties": { + "foo": { + "type": "string" + }, + "bar": { + "$ref": "#/definitions/NestedInlineType1" + } + }, + "required": [ + "foo", + "bar" + ], + "additionalProperties": false + }, + "InlineType2": { + "type": "object", + "properties": { + "baz": { + "type": "string" + } + }, + "required": [ + "baz" + ], + "additionalProperties": false + } + } +} \ No newline at end of file diff --git a/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__MixedInlineType1.json b/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__MixedInlineType1.json new file mode 100644 index 00000000000..a86a97251cf --- /dev/null +++ b/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__MixedInlineType1.json @@ -0,0 +1,17 @@ +{ + "type": "object", + "properties": { + "foo": { + "type": "string" + }, + "bar": { + "type": "string" + } + }, + "required": [ + "foo", + "bar" + ], + "additionalProperties": false, + "definitions": {} +} \ No newline at end of file diff --git a/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__NestedInlineType1.json b/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__NestedInlineType1.json new file mode 100644 index 00000000000..45e73a2f960 --- /dev/null +++ b/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__NestedInlineType1.json @@ -0,0 +1,31 @@ +{ + "type": "object", + "properties": { + "foo": { + "type": "string" + }, + "bar": { + "type": "string" + }, + "myEnum": { + "$ref": "#/definitions/InlineEnum" + } + }, + "required": [ + "foo", + "bar", + "myEnum" + ], + "additionalProperties": false, + "definitions": { + "InlineEnum": { + "type": "string", + "enum": [ + "SUNNY", + "CLOUDY", + "RAINING", + "SNOWING" + ] + } + } +} \ No newline at end of file diff --git a/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__RootType1.json b/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__RootType1.json new file mode 100644 index 00000000000..2e21be35674 --- /dev/null +++ b/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__RootType1.json @@ -0,0 +1,63 @@ +{ + "type": "object", + "properties": { + "foo": { + "type": "string" + }, + "bar": { + "$ref": "#/definitions/InlineType1" + } + }, + "required": [ + "foo", + "bar" + ], + "additionalProperties": false, + "definitions": { + "InlineEnum": { + "type": "string", + "enum": [ + "SUNNY", + "CLOUDY", + "RAINING", + "SNOWING" + ] + }, + "NestedInlineType1": { + "type": "object", + "properties": { + "foo": { + "type": "string" + }, + "bar": { + "type": "string" + }, + "myEnum": { + "$ref": "#/definitions/InlineEnum" + } + }, + "required": [ + "foo", + "bar", + "myEnum" + ], + "additionalProperties": false + }, + "InlineType1": { + "type": "object", + "properties": { + "foo": { + "type": "string" + }, + "bar": { + "$ref": "#/definitions/NestedInlineType1" + } + }, + "required": [ + "foo", + "bar" + ], + "additionalProperties": false + } + } +} \ No newline at end of file diff --git a/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__RootType2.json b/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__RootType2.json new file mode 100644 index 00000000000..326461285ac --- /dev/null +++ b/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__RootType2.json @@ -0,0 +1,34 @@ +{ + "type": "object", + "properties": { + "one": { + "type": "integer" + }, + "two": { + "$ref": "#/definitions/MixedInlineType1" + } + }, + "required": [ + "one", + "two" + ], + "additionalProperties": false, + "definitions": { + "MixedInlineType1": { + "type": "object", + "properties": { + "foo": { + "type": "string" + }, + "bar": { + "type": "string" + } + }, + "required": [ + "foo", + "bar" + ], + "additionalProperties": false + } + } +} \ No newline at end of file diff --git a/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__UndiscriminatedUnion1.json b/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__UndiscriminatedUnion1.json new file mode 100644 index 00000000000..eb5b53eba17 --- /dev/null +++ b/packages/cli/fern-definition/ir-to-jsonschema/src/__test__/__snapshots__/inline-types/type__UndiscriminatedUnion1.json @@ -0,0 +1,60 @@ +{ + "anyOf": [ + { + "$ref": "#/definitions/InlineType1" + }, + { + "$ref": "#/definitions/MixedInlineType1" + } + ], + "definitions": { + "NestedInlineType1": { + "type": "object", + "properties": { + "foo": { + "type": "string" + }, + "bar": { + "type": "string" + } + }, + "required": [ + "foo", + "bar" + ], + "additionalProperties": false + }, + "InlineType1": { + "type": "object", + "properties": { + "foo": { + "type": "string" + }, + "bar": { + "$ref": "#/definitions/NestedInlineType1" + } + }, + "required": [ + "foo", + "bar" + ], + "additionalProperties": false + }, + "MixedInlineType1": { + "type": "object", + "properties": { + "foo": { + "type": "string" + }, + "bar": { + "type": "string" + } + }, + "required": [ + "foo", + "bar" + ], + "additionalProperties": false + } + } +} \ No newline at end of file diff --git a/packages/cli/fern-definition/schema/src/schemas/api/resources/types/types/BaseTypeDeclarationSchema.ts b/packages/cli/fern-definition/schema/src/schemas/api/resources/types/types/BaseTypeDeclarationSchema.ts index a68fd6984df..7479ce9d2ae 100644 --- a/packages/cli/fern-definition/schema/src/schemas/api/resources/types/types/BaseTypeDeclarationSchema.ts +++ b/packages/cli/fern-definition/schema/src/schemas/api/resources/types/types/BaseTypeDeclarationSchema.ts @@ -11,4 +11,5 @@ export interface BaseTypeDeclarationSchema examples?: FernDefinition.ExampleTypeSchema[]; encoding?: FernDefinition.EncodingSchema; source?: FernDefinition.SourceSchema; + inline?: boolean; } diff --git a/packages/cli/fern-definition/schema/src/schemas/serialization/resources/types/types/BaseTypeDeclarationSchema.ts b/packages/cli/fern-definition/schema/src/schemas/serialization/resources/types/types/BaseTypeDeclarationSchema.ts index 8f8709e330d..510d1aeb0cf 100644 --- a/packages/cli/fern-definition/schema/src/schemas/serialization/resources/types/types/BaseTypeDeclarationSchema.ts +++ b/packages/cli/fern-definition/schema/src/schemas/serialization/resources/types/types/BaseTypeDeclarationSchema.ts @@ -20,6 +20,7 @@ export const BaseTypeDeclarationSchema: core.serialization.ObjectSchema< examples: core.serialization.list(ExampleTypeSchema).optional(), encoding: EncodingSchema.optional(), source: SourceSchema.optional(), + inline: core.serialization.boolean().optional(), }) .extend(WithDocsSchema) .extend(WithAvailability) @@ -30,5 +31,6 @@ export declare namespace BaseTypeDeclarationSchema { examples?: ExampleTypeSchema.Raw[] | null; encoding?: EncodingSchema.Raw | null; source?: SourceSchema.Raw | null; + inline?: boolean | null; } } diff --git a/packages/cli/fern-definition/validator/src/ast/visitors/visitTypeDeclarations.ts b/packages/cli/fern-definition/validator/src/ast/visitors/visitTypeDeclarations.ts index c23f7dff567..320d3f88a3f 100644 --- a/packages/cli/fern-definition/validator/src/ast/visitors/visitTypeDeclarations.ts +++ b/packages/cli/fern-definition/validator/src/ast/visitors/visitTypeDeclarations.ts @@ -72,7 +72,8 @@ export async function visitTypeDeclaration({ examples: visitExamples, validation: noop, encoding: noop, - source: noop + source: noop, + inline: noop }); } }, @@ -122,7 +123,8 @@ export async function visitTypeDeclaration({ audiences: noop, encoding: noop, source: noop, - examples: visitExamples + examples: visitExamples, + inline: noop }); }, discriminatedUnion: async (union) => { @@ -166,7 +168,8 @@ export async function visitTypeDeclaration({ audiences: noop, encoding: noop, source: noop, - examples: visitExamples + examples: visitExamples, + inline: noop }); }, undiscriminatedUnion: async (union) => { @@ -191,7 +194,8 @@ export async function visitTypeDeclaration({ audiences: noop, encoding: noop, source: noop, - examples: visitExamples + examples: visitExamples, + inline: noop }); }, enum: async (_enum) => { @@ -219,7 +223,8 @@ export async function visitTypeDeclaration({ default: noop, encoding: noop, source: noop, - examples: visitExamples + examples: visitExamples, + inline: noop }); } }); diff --git a/packages/cli/generation/ir-generator/src/FernFileContext.ts b/packages/cli/generation/ir-generator/src/FernFileContext.ts index cdde0bc824b..92e3b6275ab 100644 --- a/packages/cli/generation/ir-generator/src/FernFileContext.ts +++ b/packages/cli/generation/ir-generator/src/FernFileContext.ts @@ -16,7 +16,7 @@ export interface FernFileContext { imports: Record; definitionFile: DefinitionFileSchema; parseTypeReference: ( - type: string | { type: string; default?: unknown; validation?: RawSchemas.ValidationSchema } + type: string | { type: string; inline?: boolean; default?: unknown; validation?: RawSchemas.ValidationSchema } ) => TypeReference; casingsGenerator: CasingsGenerator; rootApiFile: RootApiFileSchema; @@ -59,10 +59,15 @@ export function constructFernFileContext({ imports: mapValues(definitionFile.imports ?? {}, RelativeFilePath.of), definitionFile, parseTypeReference: (type) => { - const typeAsString = typeof type === "string" ? type : type.type; - const _default = typeof type === "string" ? undefined : type.default; - const validation = typeof type === "string" ? undefined : type.validation; - return parseInlineType({ type: typeAsString, _default, validation, file }); + if (typeof type === "string") { + return parseInlineType({ type, _default: undefined, validation: undefined, file }); + } + return parseInlineType({ + type: type.type, + _default: type.default, + validation: type.validation, + file + }); }, casingsGenerator, rootApiFile diff --git a/packages/cli/generation/ir-generator/src/__test__/irs/audiences.json b/packages/cli/generation/ir-generator/src/__test__/irs/audiences.json index f7a3dc2e6ff..aa8902cacc6 100644 --- a/packages/cli/generation/ir-generator/src/__test__/irs/audiences.json +++ b/packages/cli/generation/ir-generator/src/__test__/irs/audiences.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_imdb:MovieId": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "MovieId", @@ -134,7 +134,7 @@ "docs": "The unique identifier for a Movie in the database" }, "type_imdb:CreateMovieRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "CreateMovieRequest", @@ -294,7 +294,7 @@ "docs": null }, "type_webhooks:User": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "User", diff --git a/packages/cli/generation/ir-generator/src/__test__/irs/availability.json b/packages/cli/generation/ir-generator/src/__test__/irs/availability.json index 54c70dccc51..48a8a7f42ca 100644 --- a/packages/cli/generation/ir-generator/src/__test__/irs/availability.json +++ b/packages/cli/generation/ir-generator/src/__test__/irs/availability.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_service:Object": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Object", diff --git a/packages/cli/generation/ir-generator/src/__test__/irs/docs.json b/packages/cli/generation/ir-generator/src/__test__/irs/docs.json index 30a802bcf26..dbea4f3c9f9 100644 --- a/packages/cli/generation/ir-generator/src/__test__/irs/docs.json +++ b/packages/cli/generation/ir-generator/src/__test__/irs/docs.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_service:Object": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Object", diff --git a/packages/cli/generation/ir-generator/src/__test__/irs/environmentAudiences.json b/packages/cli/generation/ir-generator/src/__test__/irs/environmentAudiences.json index 9535c34cf54..3bdcdeb4f31 100644 --- a/packages/cli/generation/ir-generator/src/__test__/irs/environmentAudiences.json +++ b/packages/cli/generation/ir-generator/src/__test__/irs/environmentAudiences.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_imdb:MovieId": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "MovieId", @@ -134,7 +134,7 @@ "docs": "The unique identifier for a Movie in the database" }, "type_imdb:Movie": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Movie", @@ -492,7 +492,7 @@ "docs": null }, "type_imdb:CreateMovieRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "CreateMovieRequest", @@ -652,7 +652,7 @@ "docs": null }, "type_imdb:Cast": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Cast", @@ -916,7 +916,7 @@ "docs": null }, "type_imdb:Name": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Name", @@ -1019,7 +1019,7 @@ "docs": null }, "type_webhooks:User": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "User", diff --git a/packages/cli/generation/ir-generator/src/__test__/irs/environmentAudiencesAllHack.json b/packages/cli/generation/ir-generator/src/__test__/irs/environmentAudiencesAllHack.json index eed7da0551e..c7bb890e9af 100644 --- a/packages/cli/generation/ir-generator/src/__test__/irs/environmentAudiencesAllHack.json +++ b/packages/cli/generation/ir-generator/src/__test__/irs/environmentAudiencesAllHack.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_imdb:MovieId": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "MovieId", @@ -134,7 +134,7 @@ "docs": "The unique identifier for a Movie in the database" }, "type_imdb:Movie": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Movie", @@ -390,7 +390,7 @@ "docs": null }, "type_imdb:CreateMovieRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "CreateMovieRequest", @@ -550,7 +550,7 @@ "docs": null }, "type_webhooks:User": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "User", diff --git a/packages/cli/generation/ir-generator/src/__test__/irs/environmentAudiencesSelectHack.json b/packages/cli/generation/ir-generator/src/__test__/irs/environmentAudiencesSelectHack.json index 86d173fd024..988efb7b67a 100644 --- a/packages/cli/generation/ir-generator/src/__test__/irs/environmentAudiencesSelectHack.json +++ b/packages/cli/generation/ir-generator/src/__test__/irs/environmentAudiencesSelectHack.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_imdb:MovieId": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "MovieId", @@ -134,7 +134,7 @@ "docs": "The unique identifier for a Movie in the database" }, "type_imdb:CreateMovieRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "CreateMovieRequest", @@ -294,7 +294,7 @@ "docs": null }, "type_webhooks:User": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "User", diff --git a/packages/cli/generation/ir-generator/src/__test__/irs/generics.json b/packages/cli/generation/ir-generator/src/__test__/irs/generics.json index 5e45d1d7d6c..f49bf0477dd 100644 --- a/packages/cli/generation/ir-generator/src/__test__/irs/generics.json +++ b/packages/cli/generation/ir-generator/src/__test__/irs/generics.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_imdb:MovieId": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "MovieId", @@ -134,7 +134,7 @@ "docs": "The unique identifier for a Movie in the database" }, "type_imdb:Movie": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Movie", @@ -492,7 +492,7 @@ "docs": null }, "type_imdb:CreateMovieRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "CreateMovieRequest", @@ -652,7 +652,7 @@ "docs": null }, "type_imdb:Cast": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Cast", @@ -916,7 +916,7 @@ "docs": null }, "type_imdb:Name": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Name", @@ -1019,7 +1019,7 @@ "docs": null }, "type_imdb:GenericApplication": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GenericApplication", @@ -1299,7 +1299,7 @@ "docs": "This is a generic application type" }, "type_imdb:Sample": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Sample", @@ -1578,7 +1578,7 @@ "docs": null }, "type_imdb:VanillaAlias": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "VanillaAlias", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions-openapi/code-samples-open-api.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions-openapi/code-samples-open-api.json index 642c493e777..eafc56353f8 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions-openapi/code-samples-open-api.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions-openapi/code-samples-open-api.json @@ -56,7 +56,7 @@ "idempotencyHeaders": [], "types": { "type_:TelemetryResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TelemetryResponse", @@ -250,7 +250,7 @@ "docs": null }, "type_:TelemetryData": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TelemetryData", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions-openapi/enum-casing.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions-openapi/enum-casing.json index 939d432ca32..2539210aa96 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions-openapi/enum-casing.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions-openapi/enum-casing.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_:ExampleResponseStatus": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ExampleResponseStatus", @@ -129,7 +129,7 @@ "docs": null }, "type_:ExampleResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ExampleResponse", @@ -344,7 +344,7 @@ "docs": null }, "type_:GrantTypeEnum": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GrantTypeEnum", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions-openapi/inline-schema-reference.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions-openapi/inline-schema-reference.json index 70a841cb7a5..95328ccb2e3 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions-openapi/inline-schema-reference.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions-openapi/inline-schema-reference.json @@ -30,99 +30,8 @@ "headers": [], "idempotencyHeaders": [], "types": { - "type_:NotFound": { - "inline": false, - "name": { - "name": { - "originalName": "NotFound", - "camelCase": { - "unsafeName": "notFound", - "safeName": "notFound" - }, - "snakeCase": { - "unsafeName": "not_found", - "safeName": "not_found" - }, - "screamingSnakeCase": { - "unsafeName": "NOT_FOUND", - "safeName": "NOT_FOUND" - }, - "pascalCase": { - "unsafeName": "NotFound", - "safeName": "NotFound" - } - }, - "fernFilepath": { - "allParts": [], - "packagePath": [], - "file": null - }, - "typeId": "type_:NotFound" - }, - "shape": { - "_type": "object", - "extends": [], - "properties": [ - { - "name": { - "name": { - "originalName": "message", - "camelCase": { - "unsafeName": "message", - "safeName": "message" - }, - "snakeCase": { - "unsafeName": "message", - "safeName": "message" - }, - "screamingSnakeCase": { - "unsafeName": "MESSAGE", - "safeName": "MESSAGE" - }, - "pascalCase": { - "unsafeName": "Message", - "safeName": "Message" - } - }, - "wireValue": "message" - }, - "valueType": { - "_type": "container", - "container": { - "_type": "optional", - "optional": { - "_type": "primitive", - "primitive": { - "v1": "STRING", - "v2": { - "type": "string", - "default": null, - "validation": null - } - } - } - } - }, - "availability": null, - "docs": null - } - ], - "extra-properties": false, - "extendedProperties": [] - }, - "referencedTypes": [], - "encoding": { - "json": {}, - "proto": null - }, - "source": null, - "userProvidedExamples": [], - "autogeneratedExamples": [], - "availability": null, - "docs": null - }, "type_:GetExampleResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GetExampleResponse", @@ -153,39 +62,6 @@ "shape": { "_type": "undiscriminatedUnion", "members": [ - { - "type": { - "_type": "named", - "name": { - "originalName": "NotFound", - "camelCase": { - "unsafeName": "notFound", - "safeName": "notFound" - }, - "snakeCase": { - "unsafeName": "not_found", - "safeName": "not_found" - }, - "screamingSnakeCase": { - "unsafeName": "NOT_FOUND", - "safeName": "NOT_FOUND" - }, - "pascalCase": { - "unsafeName": "NotFound", - "safeName": "NotFound" - } - }, - "fernFilepath": { - "allParts": [], - "packagePath": [], - "file": null - }, - "typeId": "type_:NotFound", - "default": null, - "inline": null - }, - "docs": null - }, { "type": { "_type": "named", @@ -255,9 +131,15 @@ ] }, "referencedTypes": [ - "type_:NotFound", "type_:Schema1", - "type_:Schema2" + "type_:Schema2", + "type_:Schema2TestEnum", + "type_:Schema2TestDiscriminatedUnion", + "type_:Schema2TestDiscriminatedUnionZero", + "type_:Schema2TestDiscriminatedUnionOne", + "type_:Schema2TestUnion", + "type_:Schema2TestUnionA", + "type_:Schema2TestUnionB" ], "encoding": { "json": {}, @@ -269,26 +151,26 @@ "availability": null, "docs": null }, - "type_:Schema1": { - "inline": false, + "type_:PostRootRequestBarInnerBar": { + "inline": true, "name": { "name": { - "originalName": "Schema1", + "originalName": "PostRootRequestBarInnerBar", "camelCase": { - "unsafeName": "schema1", - "safeName": "schema1" + "unsafeName": "postRootRequestBarInnerBar", + "safeName": "postRootRequestBarInnerBar" }, "snakeCase": { - "unsafeName": "schema1", - "safeName": "schema1" + "unsafeName": "post_root_request_bar_inner_bar", + "safeName": "post_root_request_bar_inner_bar" }, "screamingSnakeCase": { - "unsafeName": "SCHEMA1", - "safeName": "SCHEMA1" + "unsafeName": "POST_ROOT_REQUEST_BAR_INNER_BAR", + "safeName": "POST_ROOT_REQUEST_BAR_INNER_BAR" }, "pascalCase": { - "unsafeName": "Schema1", - "safeName": "Schema1" + "unsafeName": "PostRootRequestBarInnerBar", + "safeName": "PostRootRequestBarInnerBar" } }, "fernFilepath": { @@ -296,7 +178,7 @@ "packagePath": [], "file": null }, - "typeId": "type_:Schema1" + "typeId": "type_:PostRootRequestBarInnerBar" }, "shape": { "_type": "object", @@ -305,25 +187,25 @@ { "name": { "name": { - "originalName": "id", + "originalName": "foo", "camelCase": { - "unsafeName": "id", - "safeName": "id" + "unsafeName": "foo", + "safeName": "foo" }, "snakeCase": { - "unsafeName": "id", - "safeName": "id" + "unsafeName": "foo", + "safeName": "foo" }, "screamingSnakeCase": { - "unsafeName": "ID", - "safeName": "ID" + "unsafeName": "FOO", + "safeName": "FOO" }, "pascalCase": { - "unsafeName": "ID", - "safeName": "ID" + "unsafeName": "Foo", + "safeName": "Foo" } }, - "wireValue": "id" + "wireValue": "foo" }, "valueType": { "_type": "container", @@ -332,9 +214,9 @@ "optional": { "_type": "primitive", "primitive": { - "v1": "INTEGER", + "v1": "STRING", "v2": { - "type": "integer", + "type": "string", "default": null, "validation": null } @@ -348,25 +230,25 @@ { "name": { "name": { - "originalName": "name", + "originalName": "bar", "camelCase": { - "unsafeName": "name", - "safeName": "name" + "unsafeName": "bar", + "safeName": "bar" }, "snakeCase": { - "unsafeName": "name", - "safeName": "name" + "unsafeName": "bar", + "safeName": "bar" }, "screamingSnakeCase": { - "unsafeName": "NAME", - "safeName": "NAME" + "unsafeName": "BAR", + "safeName": "BAR" }, "pascalCase": { - "unsafeName": "Name", - "safeName": "Name" + "unsafeName": "Bar", + "safeName": "Bar" } }, - "wireValue": "name" + "wireValue": "bar" }, "valueType": { "_type": "container", @@ -403,26 +285,26 @@ "availability": null, "docs": null }, - "type_:Schema2": { - "inline": false, + "type_:PostRootRequestBar": { + "inline": true, "name": { "name": { - "originalName": "Schema2", + "originalName": "PostRootRequestBar", "camelCase": { - "unsafeName": "schema2", - "safeName": "schema2" + "unsafeName": "postRootRequestBar", + "safeName": "postRootRequestBar" }, "snakeCase": { - "unsafeName": "schema2", - "safeName": "schema2" + "unsafeName": "post_root_request_bar", + "safeName": "post_root_request_bar" }, "screamingSnakeCase": { - "unsafeName": "SCHEMA2", - "safeName": "SCHEMA2" + "unsafeName": "POST_ROOT_REQUEST_BAR", + "safeName": "POST_ROOT_REQUEST_BAR" }, "pascalCase": { - "unsafeName": "Schema2", - "safeName": "Schema2" + "unsafeName": "PostRootRequestBar", + "safeName": "PostRootRequestBar" } }, "fernFilepath": { @@ -430,7 +312,7 @@ "packagePath": [], "file": null }, - "typeId": "type_:Schema2" + "typeId": "type_:PostRootRequestBar" }, "shape": { "_type": "object", @@ -439,25 +321,25 @@ { "name": { "name": { - "originalName": "email", + "originalName": "foo", "camelCase": { - "unsafeName": "email", - "safeName": "email" + "unsafeName": "foo", + "safeName": "foo" }, "snakeCase": { - "unsafeName": "email", - "safeName": "email" + "unsafeName": "foo", + "safeName": "foo" }, "screamingSnakeCase": { - "unsafeName": "EMAIL", - "safeName": "EMAIL" + "unsafeName": "FOO", + "safeName": "FOO" }, "pascalCase": { - "unsafeName": "Email", - "safeName": "Email" + "unsafeName": "Foo", + "safeName": "Foo" } }, - "wireValue": "email" + "wireValue": "foo" }, "valueType": { "_type": "container", @@ -482,40 +364,59 @@ { "name": { "name": { - "originalName": "age", + "originalName": "inner_bar", "camelCase": { - "unsafeName": "age", - "safeName": "age" + "unsafeName": "innerBar", + "safeName": "innerBar" }, "snakeCase": { - "unsafeName": "age", - "safeName": "age" + "unsafeName": "inner_bar", + "safeName": "inner_bar" }, "screamingSnakeCase": { - "unsafeName": "AGE", - "safeName": "AGE" + "unsafeName": "INNER_BAR", + "safeName": "INNER_BAR" }, "pascalCase": { - "unsafeName": "Age", - "safeName": "Age" + "unsafeName": "InnerBar", + "safeName": "InnerBar" } }, - "wireValue": "age" + "wireValue": "inner_bar" }, "valueType": { "_type": "container", "container": { "_type": "optional", "optional": { - "_type": "primitive", - "primitive": { - "v1": "INTEGER", - "v2": { - "type": "integer", - "default": null, - "validation": null + "_type": "named", + "name": { + "originalName": "PostRootRequestBarInnerBar", + "camelCase": { + "unsafeName": "postRootRequestBarInnerBar", + "safeName": "postRootRequestBarInnerBar" + }, + "snakeCase": { + "unsafeName": "post_root_request_bar_inner_bar", + "safeName": "post_root_request_bar_inner_bar" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_REQUEST_BAR_INNER_BAR", + "safeName": "POST_ROOT_REQUEST_BAR_INNER_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootRequestBarInnerBar", + "safeName": "PostRootRequestBarInnerBar" } - } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:PostRootRequestBarInnerBar", + "default": null, + "inline": null } } }, @@ -526,7 +427,9 @@ "extra-properties": false, "extendedProperties": [] }, - "referencedTypes": [], + "referencedTypes": [ + "type_:PostRootRequestBarInnerBar" + ], "encoding": { "json": {}, "proto": null @@ -536,99 +439,263 @@ "autogeneratedExamples": [], "availability": null, "docs": null - } - }, - "errors": {}, - "services": { - "service_": { - "availability": null, + }, + "type_:PostRootResponseBarInnerBar": { + "inline": true, "name": { + "name": { + "originalName": "PostRootResponseBarInnerBar", + "camelCase": { + "unsafeName": "postRootResponseBarInnerBar", + "safeName": "postRootResponseBarInnerBar" + }, + "snakeCase": { + "unsafeName": "post_root_response_bar_inner_bar", + "safeName": "post_root_response_bar_inner_bar" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE_BAR_INNER_BAR", + "safeName": "POST_ROOT_RESPONSE_BAR_INNER_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootResponseBarInnerBar", + "safeName": "PostRootResponseBarInnerBar" + } + }, "fernFilepath": { "allParts": [], "packagePath": [], "file": null - } - }, - "displayName": null, - "basePath": { - "head": "", - "parts": [] - }, - "headers": [], - "pathParameters": [], - "encoding": { - "json": {}, - "proto": null - }, - "transport": { - "type": "http" + }, + "typeId": "type_:PostRootResponseBarInnerBar" }, - "endpoints": [ - { - "id": "endpoint_.getExample", - "name": { - "originalName": "getExample", - "camelCase": { - "unsafeName": "getExample", - "safeName": "getExample" - }, - "snakeCase": { - "unsafeName": "get_example", - "safeName": "get_example" - }, - "screamingSnakeCase": { - "unsafeName": "GET_EXAMPLE", - "safeName": "GET_EXAMPLE" + "shape": { + "_type": "object", + "extends": [], + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" }, - "pascalCase": { - "unsafeName": "GetExample", - "safeName": "GetExample" - } + "valueType": { + "_type": "container", + "container": { + "_type": "optional", + "optional": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + } + } + }, + "availability": null, + "docs": null }, - "displayName": "Get Example", - "auth": false, - "idempotent": false, - "baseUrl": null, - "method": "GET", - "basePath": null, - "path": { - "head": "/example", - "parts": [] + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "valueType": { + "_type": "container", + "container": { + "_type": "optional", + "optional": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + } + } + }, + "availability": null, + "docs": null + } + ], + "extra-properties": false, + "extendedProperties": [] + }, + "referencedTypes": [], + "encoding": { + "json": {}, + "proto": null + }, + "source": null, + "userProvidedExamples": [], + "autogeneratedExamples": [], + "availability": null, + "docs": null + }, + "type_:PostRootResponseBar": { + "inline": true, + "name": { + "name": { + "originalName": "PostRootResponseBar", + "camelCase": { + "unsafeName": "postRootResponseBar", + "safeName": "postRootResponseBar" }, - "fullPath": { - "head": "example", - "parts": [] + "snakeCase": { + "unsafeName": "post_root_response_bar", + "safeName": "post_root_response_bar" }, - "pathParameters": [], - "allPathParameters": [], - "queryParameters": [], - "headers": [], - "requestBody": null, - "sdkRequest": null, - "response": { - "body": { - "type": "json", - "value": { - "type": "response", - "responseBodyType": { + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE_BAR", + "safeName": "POST_ROOT_RESPONSE_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootResponseBar", + "safeName": "PostRootResponseBar" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:PostRootResponseBar" + }, + "shape": { + "_type": "object", + "extends": [], + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "valueType": { + "_type": "container", + "container": { + "_type": "optional", + "optional": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + } + } + }, + "availability": null, + "docs": null + }, + { + "name": { + "name": { + "originalName": "inner_bar", + "camelCase": { + "unsafeName": "innerBar", + "safeName": "innerBar" + }, + "snakeCase": { + "unsafeName": "inner_bar", + "safeName": "inner_bar" + }, + "screamingSnakeCase": { + "unsafeName": "INNER_BAR", + "safeName": "INNER_BAR" + }, + "pascalCase": { + "unsafeName": "InnerBar", + "safeName": "InnerBar" + } + }, + "wireValue": "inner_bar" + }, + "valueType": { + "_type": "container", + "container": { + "_type": "optional", + "optional": { "_type": "named", "name": { - "originalName": "GetExampleResponse", + "originalName": "PostRootResponseBarInnerBar", "camelCase": { - "unsafeName": "getExampleResponse", - "safeName": "getExampleResponse" + "unsafeName": "postRootResponseBarInnerBar", + "safeName": "postRootResponseBarInnerBar" }, "snakeCase": { - "unsafeName": "get_example_response", - "safeName": "get_example_response" + "unsafeName": "post_root_response_bar_inner_bar", + "safeName": "post_root_response_bar_inner_bar" }, "screamingSnakeCase": { - "unsafeName": "GET_EXAMPLE_RESPONSE", - "safeName": "GET_EXAMPLE_RESPONSE" + "unsafeName": "POST_ROOT_RESPONSE_BAR_INNER_BAR", + "safeName": "POST_ROOT_RESPONSE_BAR_INNER_BAR" }, "pascalCase": { - "unsafeName": "GetExampleResponse", - "safeName": "GetExampleResponse" + "unsafeName": "PostRootResponseBarInnerBar", + "safeName": "PostRootResponseBarInnerBar" } }, "fernFilepath": { @@ -636,29 +703,2313 @@ "packagePath": [], "file": null }, - "typeId": "type_:GetExampleResponse", + "typeId": "type_:PostRootResponseBarInnerBar", "default": null, "inline": null + } + } + }, + "availability": null, + "docs": null + } + ], + "extra-properties": false, + "extendedProperties": [] + }, + "referencedTypes": [ + "type_:PostRootResponseBarInnerBar" + ], + "encoding": { + "json": {}, + "proto": null + }, + "source": null, + "userProvidedExamples": [], + "autogeneratedExamples": [], + "availability": null, + "docs": null + }, + "type_:PostRootResponse": { + "inline": null, + "name": { + "name": { + "originalName": "PostRootResponse", + "camelCase": { + "unsafeName": "postRootResponse", + "safeName": "postRootResponse" + }, + "snakeCase": { + "unsafeName": "post_root_response", + "safeName": "post_root_response" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE", + "safeName": "POST_ROOT_RESPONSE" + }, + "pascalCase": { + "unsafeName": "PostRootResponse", + "safeName": "PostRootResponse" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:PostRootResponse" + }, + "shape": { + "_type": "object", + "extends": [], + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" }, - "docs": "Successful response" + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "valueType": { + "_type": "container", + "container": { + "_type": "optional", + "optional": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + } } }, - "status-code": null + "availability": null, + "docs": null }, - "errors": [], - "userSpecifiedExamples": [ - { - "example": { - "id": "31a7f125b757ecb88c3de1e90f768cd1d886a61a082744712200711bff86f040", - "name": null, - "url": "/example", - "rootPathParameters": [], - "endpointPathParameters": [], - "servicePathParameters": [], - "endpointHeaders": [], - "serviceHeaders": [], + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "valueType": { + "_type": "container", + "container": { + "_type": "optional", + "optional": { + "_type": "named", + "name": { + "originalName": "PostRootResponseBar", + "camelCase": { + "unsafeName": "postRootResponseBar", + "safeName": "postRootResponseBar" + }, + "snakeCase": { + "unsafeName": "post_root_response_bar", + "safeName": "post_root_response_bar" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE_BAR", + "safeName": "POST_ROOT_RESPONSE_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootResponseBar", + "safeName": "PostRootResponseBar" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:PostRootResponseBar", + "default": null, + "inline": null + } + } + }, + "availability": null, + "docs": null + } + ], + "extra-properties": false, + "extendedProperties": [] + }, + "referencedTypes": [ + "type_:PostRootResponseBar", + "type_:PostRootResponseBarInnerBar" + ], + "encoding": { + "json": {}, + "proto": null + }, + "source": null, + "userProvidedExamples": [], + "autogeneratedExamples": [], + "availability": null, + "docs": null + }, + "type_:Schema1": { + "inline": null, + "name": { + "name": { + "originalName": "Schema1", + "camelCase": { + "unsafeName": "schema1", + "safeName": "schema1" + }, + "snakeCase": { + "unsafeName": "schema1", + "safeName": "schema1" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA1", + "safeName": "SCHEMA1" + }, + "pascalCase": { + "unsafeName": "Schema1", + "safeName": "Schema1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:Schema1" + }, + "shape": { + "_type": "object", + "extends": [], + "properties": [ + { + "name": { + "name": { + "originalName": "id", + "camelCase": { + "unsafeName": "id", + "safeName": "id" + }, + "snakeCase": { + "unsafeName": "id", + "safeName": "id" + }, + "screamingSnakeCase": { + "unsafeName": "ID", + "safeName": "ID" + }, + "pascalCase": { + "unsafeName": "ID", + "safeName": "ID" + } + }, + "wireValue": "id" + }, + "valueType": { + "_type": "container", + "container": { + "_type": "optional", + "optional": { + "_type": "primitive", + "primitive": { + "v1": "INTEGER", + "v2": { + "type": "integer", + "default": null, + "validation": null + } + } + } + } + }, + "availability": null, + "docs": null + }, + { + "name": { + "name": { + "originalName": "name", + "camelCase": { + "unsafeName": "name", + "safeName": "name" + }, + "snakeCase": { + "unsafeName": "name", + "safeName": "name" + }, + "screamingSnakeCase": { + "unsafeName": "NAME", + "safeName": "NAME" + }, + "pascalCase": { + "unsafeName": "Name", + "safeName": "Name" + } + }, + "wireValue": "name" + }, + "valueType": { + "_type": "container", + "container": { + "_type": "optional", + "optional": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + } + } + }, + "availability": null, + "docs": null + } + ], + "extra-properties": false, + "extendedProperties": [] + }, + "referencedTypes": [], + "encoding": { + "json": {}, + "proto": null + }, + "source": null, + "userProvidedExamples": [], + "autogeneratedExamples": [], + "availability": null, + "docs": null + }, + "type_:Schema2TestEnum": { + "inline": null, + "name": { + "name": { + "originalName": "Schema2TestEnum", + "camelCase": { + "unsafeName": "schema2TestEnum", + "safeName": "schema2TestEnum" + }, + "snakeCase": { + "unsafeName": "schema2test_enum", + "safeName": "schema2test_enum" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA2TEST_ENUM", + "safeName": "SCHEMA2TEST_ENUM" + }, + "pascalCase": { + "unsafeName": "Schema2TestEnum", + "safeName": "Schema2TestEnum" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:Schema2TestEnum" + }, + "shape": { + "_type": "enum", + "default": null, + "values": [ + { + "name": { + "name": { + "originalName": "test1", + "camelCase": { + "unsafeName": "test1", + "safeName": "test1" + }, + "snakeCase": { + "unsafeName": "test1", + "safeName": "test1" + }, + "screamingSnakeCase": { + "unsafeName": "TEST1", + "safeName": "TEST1" + }, + "pascalCase": { + "unsafeName": "Test1", + "safeName": "Test1" + } + }, + "wireValue": "test1" + }, + "availability": null, + "docs": null + }, + { + "name": { + "name": { + "originalName": "test2", + "camelCase": { + "unsafeName": "test2", + "safeName": "test2" + }, + "snakeCase": { + "unsafeName": "test2", + "safeName": "test2" + }, + "screamingSnakeCase": { + "unsafeName": "TEST2", + "safeName": "TEST2" + }, + "pascalCase": { + "unsafeName": "Test2", + "safeName": "Test2" + } + }, + "wireValue": "test2" + }, + "availability": null, + "docs": null + }, + { + "name": { + "name": { + "originalName": "test3", + "camelCase": { + "unsafeName": "test3", + "safeName": "test3" + }, + "snakeCase": { + "unsafeName": "test3", + "safeName": "test3" + }, + "screamingSnakeCase": { + "unsafeName": "TEST3", + "safeName": "TEST3" + }, + "pascalCase": { + "unsafeName": "Test3", + "safeName": "Test3" + } + }, + "wireValue": "test3" + }, + "availability": null, + "docs": null + } + ] + }, + "referencedTypes": [], + "encoding": { + "json": {}, + "proto": null + }, + "source": null, + "userProvidedExamples": [], + "autogeneratedExamples": [], + "availability": null, + "docs": null + }, + "type_:Schema2TestDiscriminatedUnionZero": { + "inline": true, + "name": { + "name": { + "originalName": "Schema2TestDiscriminatedUnionZero", + "camelCase": { + "unsafeName": "schema2TestDiscriminatedUnionZero", + "safeName": "schema2TestDiscriminatedUnionZero" + }, + "snakeCase": { + "unsafeName": "schema2test_discriminated_union_zero", + "safeName": "schema2test_discriminated_union_zero" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA2TEST_DISCRIMINATED_UNION_ZERO", + "safeName": "SCHEMA2TEST_DISCRIMINATED_UNION_ZERO" + }, + "pascalCase": { + "unsafeName": "Schema2TestDiscriminatedUnionZero", + "safeName": "Schema2TestDiscriminatedUnionZero" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:Schema2TestDiscriminatedUnionZero" + }, + "shape": { + "_type": "object", + "extends": [], + "properties": [ + { + "name": { + "name": { + "originalName": "objectType", + "camelCase": { + "unsafeName": "objectType", + "safeName": "objectType" + }, + "snakeCase": { + "unsafeName": "object_type", + "safeName": "object_type" + }, + "screamingSnakeCase": { + "unsafeName": "OBJECT_TYPE", + "safeName": "OBJECT_TYPE" + }, + "pascalCase": { + "unsafeName": "ObjectType", + "safeName": "ObjectType" + } + }, + "wireValue": "objectType" + }, + "valueType": { + "_type": "container", + "container": { + "_type": "optional", + "optional": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + } + } + }, + "availability": null, + "docs": null + } + ], + "extra-properties": false, + "extendedProperties": [] + }, + "referencedTypes": [], + "encoding": { + "json": {}, + "proto": null + }, + "source": null, + "userProvidedExamples": [], + "autogeneratedExamples": [], + "availability": null, + "docs": null + }, + "type_:Schema2TestDiscriminatedUnionOne": { + "inline": true, + "name": { + "name": { + "originalName": "Schema2TestDiscriminatedUnionOne", + "camelCase": { + "unsafeName": "schema2TestDiscriminatedUnionOne", + "safeName": "schema2TestDiscriminatedUnionOne" + }, + "snakeCase": { + "unsafeName": "schema2test_discriminated_union_one", + "safeName": "schema2test_discriminated_union_one" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA2TEST_DISCRIMINATED_UNION_ONE", + "safeName": "SCHEMA2TEST_DISCRIMINATED_UNION_ONE" + }, + "pascalCase": { + "unsafeName": "Schema2TestDiscriminatedUnionOne", + "safeName": "Schema2TestDiscriminatedUnionOne" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:Schema2TestDiscriminatedUnionOne" + }, + "shape": { + "_type": "object", + "extends": [], + "properties": [ + { + "name": { + "name": { + "originalName": "objectType", + "camelCase": { + "unsafeName": "objectType", + "safeName": "objectType" + }, + "snakeCase": { + "unsafeName": "object_type", + "safeName": "object_type" + }, + "screamingSnakeCase": { + "unsafeName": "OBJECT_TYPE", + "safeName": "OBJECT_TYPE" + }, + "pascalCase": { + "unsafeName": "ObjectType", + "safeName": "ObjectType" + } + }, + "wireValue": "objectType" + }, + "valueType": { + "_type": "container", + "container": { + "_type": "optional", + "optional": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + } + } + }, + "availability": null, + "docs": null + } + ], + "extra-properties": false, + "extendedProperties": [] + }, + "referencedTypes": [], + "encoding": { + "json": {}, + "proto": null + }, + "source": null, + "userProvidedExamples": [], + "autogeneratedExamples": [], + "availability": null, + "docs": null + }, + "type_:Schema2TestDiscriminatedUnion": { + "inline": true, + "name": { + "name": { + "originalName": "Schema2TestDiscriminatedUnion", + "camelCase": { + "unsafeName": "schema2TestDiscriminatedUnion", + "safeName": "schema2TestDiscriminatedUnion" + }, + "snakeCase": { + "unsafeName": "schema2test_discriminated_union", + "safeName": "schema2test_discriminated_union" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA2TEST_DISCRIMINATED_UNION", + "safeName": "SCHEMA2TEST_DISCRIMINATED_UNION" + }, + "pascalCase": { + "unsafeName": "Schema2TestDiscriminatedUnion", + "safeName": "Schema2TestDiscriminatedUnion" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:Schema2TestDiscriminatedUnion" + }, + "shape": { + "_type": "undiscriminatedUnion", + "members": [ + { + "type": { + "_type": "named", + "name": { + "originalName": "Schema2TestDiscriminatedUnionZero", + "camelCase": { + "unsafeName": "schema2TestDiscriminatedUnionZero", + "safeName": "schema2TestDiscriminatedUnionZero" + }, + "snakeCase": { + "unsafeName": "schema2test_discriminated_union_zero", + "safeName": "schema2test_discriminated_union_zero" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA2TEST_DISCRIMINATED_UNION_ZERO", + "safeName": "SCHEMA2TEST_DISCRIMINATED_UNION_ZERO" + }, + "pascalCase": { + "unsafeName": "Schema2TestDiscriminatedUnionZero", + "safeName": "Schema2TestDiscriminatedUnionZero" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:Schema2TestDiscriminatedUnionZero", + "default": null, + "inline": null + }, + "docs": null + }, + { + "type": { + "_type": "named", + "name": { + "originalName": "Schema2TestDiscriminatedUnionOne", + "camelCase": { + "unsafeName": "schema2TestDiscriminatedUnionOne", + "safeName": "schema2TestDiscriminatedUnionOne" + }, + "snakeCase": { + "unsafeName": "schema2test_discriminated_union_one", + "safeName": "schema2test_discriminated_union_one" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA2TEST_DISCRIMINATED_UNION_ONE", + "safeName": "SCHEMA2TEST_DISCRIMINATED_UNION_ONE" + }, + "pascalCase": { + "unsafeName": "Schema2TestDiscriminatedUnionOne", + "safeName": "Schema2TestDiscriminatedUnionOne" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:Schema2TestDiscriminatedUnionOne", + "default": null, + "inline": null + }, + "docs": null + } + ] + }, + "referencedTypes": [ + "type_:Schema2TestDiscriminatedUnionZero", + "type_:Schema2TestDiscriminatedUnionOne" + ], + "encoding": { + "json": {}, + "proto": null + }, + "source": null, + "userProvidedExamples": [], + "autogeneratedExamples": [], + "availability": null, + "docs": null + }, + "type_:Schema2TestUnionA": { + "inline": true, + "name": { + "name": { + "originalName": "Schema2TestUnionA", + "camelCase": { + "unsafeName": "schema2TestUnionA", + "safeName": "schema2TestUnionA" + }, + "snakeCase": { + "unsafeName": "schema2test_union_a", + "safeName": "schema2test_union_a" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA2TEST_UNION_A", + "safeName": "SCHEMA2TEST_UNION_A" + }, + "pascalCase": { + "unsafeName": "Schema2TestUnionA", + "safeName": "Schema2TestUnionA" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:Schema2TestUnionA" + }, + "shape": { + "_type": "object", + "extends": [], + "properties": [ + { + "name": { + "name": { + "originalName": "a", + "camelCase": { + "unsafeName": "a", + "safeName": "a" + }, + "snakeCase": { + "unsafeName": "a", + "safeName": "a" + }, + "screamingSnakeCase": { + "unsafeName": "A", + "safeName": "A" + }, + "pascalCase": { + "unsafeName": "A", + "safeName": "A" + } + }, + "wireValue": "a" + }, + "valueType": { + "_type": "container", + "container": { + "_type": "optional", + "optional": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + } + } + }, + "availability": null, + "docs": null + } + ], + "extra-properties": false, + "extendedProperties": [] + }, + "referencedTypes": [], + "encoding": { + "json": {}, + "proto": null + }, + "source": null, + "userProvidedExamples": [], + "autogeneratedExamples": [], + "availability": null, + "docs": null + }, + "type_:Schema2TestUnionB": { + "inline": true, + "name": { + "name": { + "originalName": "Schema2TestUnionB", + "camelCase": { + "unsafeName": "schema2TestUnionB", + "safeName": "schema2TestUnionB" + }, + "snakeCase": { + "unsafeName": "schema2test_union_b", + "safeName": "schema2test_union_b" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA2TEST_UNION_B", + "safeName": "SCHEMA2TEST_UNION_B" + }, + "pascalCase": { + "unsafeName": "Schema2TestUnionB", + "safeName": "Schema2TestUnionB" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:Schema2TestUnionB" + }, + "shape": { + "_type": "object", + "extends": [], + "properties": [ + { + "name": { + "name": { + "originalName": "b", + "camelCase": { + "unsafeName": "b", + "safeName": "b" + }, + "snakeCase": { + "unsafeName": "b", + "safeName": "b" + }, + "screamingSnakeCase": { + "unsafeName": "B", + "safeName": "B" + }, + "pascalCase": { + "unsafeName": "B", + "safeName": "B" + } + }, + "wireValue": "b" + }, + "valueType": { + "_type": "container", + "container": { + "_type": "optional", + "optional": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + } + } + }, + "availability": null, + "docs": null + } + ], + "extra-properties": false, + "extendedProperties": [] + }, + "referencedTypes": [], + "encoding": { + "json": {}, + "proto": null + }, + "source": null, + "userProvidedExamples": [], + "autogeneratedExamples": [], + "availability": null, + "docs": null + }, + "type_:Schema2TestUnion": { + "inline": true, + "name": { + "name": { + "originalName": "Schema2TestUnion", + "camelCase": { + "unsafeName": "schema2TestUnion", + "safeName": "schema2TestUnion" + }, + "snakeCase": { + "unsafeName": "schema2test_union", + "safeName": "schema2test_union" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA2TEST_UNION", + "safeName": "SCHEMA2TEST_UNION" + }, + "pascalCase": { + "unsafeName": "Schema2TestUnion", + "safeName": "Schema2TestUnion" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:Schema2TestUnion" + }, + "shape": { + "_type": "undiscriminatedUnion", + "members": [ + { + "type": { + "_type": "named", + "name": { + "originalName": "Schema2TestUnionA", + "camelCase": { + "unsafeName": "schema2TestUnionA", + "safeName": "schema2TestUnionA" + }, + "snakeCase": { + "unsafeName": "schema2test_union_a", + "safeName": "schema2test_union_a" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA2TEST_UNION_A", + "safeName": "SCHEMA2TEST_UNION_A" + }, + "pascalCase": { + "unsafeName": "Schema2TestUnionA", + "safeName": "Schema2TestUnionA" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:Schema2TestUnionA", + "default": null, + "inline": null + }, + "docs": null + }, + { + "type": { + "_type": "named", + "name": { + "originalName": "Schema2TestUnionB", + "camelCase": { + "unsafeName": "schema2TestUnionB", + "safeName": "schema2TestUnionB" + }, + "snakeCase": { + "unsafeName": "schema2test_union_b", + "safeName": "schema2test_union_b" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA2TEST_UNION_B", + "safeName": "SCHEMA2TEST_UNION_B" + }, + "pascalCase": { + "unsafeName": "Schema2TestUnionB", + "safeName": "Schema2TestUnionB" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:Schema2TestUnionB", + "default": null, + "inline": null + }, + "docs": null + } + ] + }, + "referencedTypes": [ + "type_:Schema2TestUnionA", + "type_:Schema2TestUnionB" + ], + "encoding": { + "json": {}, + "proto": null + }, + "source": null, + "userProvidedExamples": [], + "autogeneratedExamples": [], + "availability": null, + "docs": null + }, + "type_:Schema2": { + "inline": null, + "name": { + "name": { + "originalName": "Schema2", + "camelCase": { + "unsafeName": "schema2", + "safeName": "schema2" + }, + "snakeCase": { + "unsafeName": "schema2", + "safeName": "schema2" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA2", + "safeName": "SCHEMA2" + }, + "pascalCase": { + "unsafeName": "Schema2", + "safeName": "Schema2" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:Schema2" + }, + "shape": { + "_type": "object", + "extends": [], + "properties": [ + { + "name": { + "name": { + "originalName": "email", + "camelCase": { + "unsafeName": "email", + "safeName": "email" + }, + "snakeCase": { + "unsafeName": "email", + "safeName": "email" + }, + "screamingSnakeCase": { + "unsafeName": "EMAIL", + "safeName": "EMAIL" + }, + "pascalCase": { + "unsafeName": "Email", + "safeName": "Email" + } + }, + "wireValue": "email" + }, + "valueType": { + "_type": "container", + "container": { + "_type": "optional", + "optional": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + } + } + }, + "availability": null, + "docs": null + }, + { + "name": { + "name": { + "originalName": "age", + "camelCase": { + "unsafeName": "age", + "safeName": "age" + }, + "snakeCase": { + "unsafeName": "age", + "safeName": "age" + }, + "screamingSnakeCase": { + "unsafeName": "AGE", + "safeName": "AGE" + }, + "pascalCase": { + "unsafeName": "Age", + "safeName": "Age" + } + }, + "wireValue": "age" + }, + "valueType": { + "_type": "container", + "container": { + "_type": "optional", + "optional": { + "_type": "primitive", + "primitive": { + "v1": "INTEGER", + "v2": { + "type": "integer", + "default": null, + "validation": null + } + } + } + } + }, + "availability": null, + "docs": null + }, + { + "name": { + "name": { + "originalName": "testEnum", + "camelCase": { + "unsafeName": "testEnum", + "safeName": "testEnum" + }, + "snakeCase": { + "unsafeName": "test_enum", + "safeName": "test_enum" + }, + "screamingSnakeCase": { + "unsafeName": "TEST_ENUM", + "safeName": "TEST_ENUM" + }, + "pascalCase": { + "unsafeName": "TestEnum", + "safeName": "TestEnum" + } + }, + "wireValue": "testEnum" + }, + "valueType": { + "_type": "container", + "container": { + "_type": "optional", + "optional": { + "_type": "named", + "name": { + "originalName": "Schema2TestEnum", + "camelCase": { + "unsafeName": "schema2TestEnum", + "safeName": "schema2TestEnum" + }, + "snakeCase": { + "unsafeName": "schema2test_enum", + "safeName": "schema2test_enum" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA2TEST_ENUM", + "safeName": "SCHEMA2TEST_ENUM" + }, + "pascalCase": { + "unsafeName": "Schema2TestEnum", + "safeName": "Schema2TestEnum" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:Schema2TestEnum", + "default": null, + "inline": null + } + } + }, + "availability": null, + "docs": null + }, + { + "name": { + "name": { + "originalName": "testDiscriminatedUnion", + "camelCase": { + "unsafeName": "testDiscriminatedUnion", + "safeName": "testDiscriminatedUnion" + }, + "snakeCase": { + "unsafeName": "test_discriminated_union", + "safeName": "test_discriminated_union" + }, + "screamingSnakeCase": { + "unsafeName": "TEST_DISCRIMINATED_UNION", + "safeName": "TEST_DISCRIMINATED_UNION" + }, + "pascalCase": { + "unsafeName": "TestDiscriminatedUnion", + "safeName": "TestDiscriminatedUnion" + } + }, + "wireValue": "testDiscriminatedUnion" + }, + "valueType": { + "_type": "container", + "container": { + "_type": "optional", + "optional": { + "_type": "named", + "name": { + "originalName": "Schema2TestDiscriminatedUnion", + "camelCase": { + "unsafeName": "schema2TestDiscriminatedUnion", + "safeName": "schema2TestDiscriminatedUnion" + }, + "snakeCase": { + "unsafeName": "schema2test_discriminated_union", + "safeName": "schema2test_discriminated_union" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA2TEST_DISCRIMINATED_UNION", + "safeName": "SCHEMA2TEST_DISCRIMINATED_UNION" + }, + "pascalCase": { + "unsafeName": "Schema2TestDiscriminatedUnion", + "safeName": "Schema2TestDiscriminatedUnion" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:Schema2TestDiscriminatedUnion", + "default": null, + "inline": null + } + } + }, + "availability": null, + "docs": null + }, + { + "name": { + "name": { + "originalName": "testUnion", + "camelCase": { + "unsafeName": "testUnion", + "safeName": "testUnion" + }, + "snakeCase": { + "unsafeName": "test_union", + "safeName": "test_union" + }, + "screamingSnakeCase": { + "unsafeName": "TEST_UNION", + "safeName": "TEST_UNION" + }, + "pascalCase": { + "unsafeName": "TestUnion", + "safeName": "TestUnion" + } + }, + "wireValue": "testUnion" + }, + "valueType": { + "_type": "container", + "container": { + "_type": "optional", + "optional": { + "_type": "named", + "name": { + "originalName": "Schema2TestUnion", + "camelCase": { + "unsafeName": "schema2TestUnion", + "safeName": "schema2TestUnion" + }, + "snakeCase": { + "unsafeName": "schema2test_union", + "safeName": "schema2test_union" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA2TEST_UNION", + "safeName": "SCHEMA2TEST_UNION" + }, + "pascalCase": { + "unsafeName": "Schema2TestUnion", + "safeName": "Schema2TestUnion" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:Schema2TestUnion", + "default": null, + "inline": null + } + } + }, + "availability": null, + "docs": null + } + ], + "extra-properties": false, + "extendedProperties": [] + }, + "referencedTypes": [ + "type_:Schema2TestEnum", + "type_:Schema2TestDiscriminatedUnion", + "type_:Schema2TestDiscriminatedUnionZero", + "type_:Schema2TestDiscriminatedUnionOne", + "type_:Schema2TestUnion", + "type_:Schema2TestUnionA", + "type_:Schema2TestUnionB" + ], + "encoding": { + "json": {}, + "proto": null + }, + "source": null, + "userProvidedExamples": [], + "autogeneratedExamples": [], + "availability": null, + "docs": null + } + }, + "errors": {}, + "services": { + "service_": { + "availability": null, + "name": { + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "displayName": null, + "basePath": { + "head": "", + "parts": [] + }, + "headers": [], + "pathParameters": [], + "encoding": { + "json": {}, + "proto": null + }, + "transport": { + "type": "http" + }, + "endpoints": [ + { + "id": "endpoint_.getExample", + "name": { + "originalName": "getExample", + "camelCase": { + "unsafeName": "getExample", + "safeName": "getExample" + }, + "snakeCase": { + "unsafeName": "get_example", + "safeName": "get_example" + }, + "screamingSnakeCase": { + "unsafeName": "GET_EXAMPLE", + "safeName": "GET_EXAMPLE" + }, + "pascalCase": { + "unsafeName": "GetExample", + "safeName": "GetExample" + } + }, + "displayName": "Get Example", + "auth": false, + "idempotent": false, + "baseUrl": null, + "method": "GET", + "basePath": null, + "path": { + "head": "/example", + "parts": [] + }, + "fullPath": { + "head": "example", + "parts": [] + }, + "pathParameters": [], + "allPathParameters": [], + "queryParameters": [], + "headers": [], + "requestBody": null, + "sdkRequest": null, + "response": { + "body": { + "type": "json", + "value": { + "type": "response", + "responseBodyType": { + "_type": "named", + "name": { + "originalName": "GetExampleResponse", + "camelCase": { + "unsafeName": "getExampleResponse", + "safeName": "getExampleResponse" + }, + "snakeCase": { + "unsafeName": "get_example_response", + "safeName": "get_example_response" + }, + "screamingSnakeCase": { + "unsafeName": "GET_EXAMPLE_RESPONSE", + "safeName": "GET_EXAMPLE_RESPONSE" + }, + "pascalCase": { + "unsafeName": "GetExampleResponse", + "safeName": "GetExampleResponse" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:GetExampleResponse", + "default": null, + "inline": null + }, + "docs": "Successful response" + } + }, + "status-code": null + }, + "errors": [], + "userSpecifiedExamples": [ + { + "example": { + "id": "48bedd7469ebc1cb729db9f8daca25bc109b40d3e2b832b743691e4c1934295a", + "name": null, + "url": "/example", + "rootPathParameters": [], + "endpointPathParameters": [], + "servicePathParameters": [], + "endpointHeaders": [], + "serviceHeaders": [], + "queryParameters": [], + "request": null, + "response": { + "type": "ok", + "value": { + "type": "body", + "value": { + "shape": { + "type": "named", + "typeName": { + "typeId": "type_:GetExampleResponse", + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "name": { + "originalName": "GetExampleResponse", + "camelCase": { + "unsafeName": "getExampleResponse", + "safeName": "getExampleResponse" + }, + "snakeCase": { + "unsafeName": "get_example_response", + "safeName": "get_example_response" + }, + "screamingSnakeCase": { + "unsafeName": "GET_EXAMPLE_RESPONSE", + "safeName": "GET_EXAMPLE_RESPONSE" + }, + "pascalCase": { + "unsafeName": "GetExampleResponse", + "safeName": "GetExampleResponse" + } + } + }, + "shape": { + "type": "undiscriminatedUnion", + "index": 0, + "singleUnionType": { + "shape": { + "type": "named", + "typeName": { + "typeId": "type_:Schema1", + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "name": { + "originalName": "Schema1", + "camelCase": { + "unsafeName": "schema1", + "safeName": "schema1" + }, + "snakeCase": { + "unsafeName": "schema1", + "safeName": "schema1" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA1", + "safeName": "SCHEMA1" + }, + "pascalCase": { + "unsafeName": "Schema1", + "safeName": "Schema1" + } + } + }, + "shape": { + "type": "object", + "properties": [ + { + "name": { + "name": { + "originalName": "id", + "camelCase": { + "unsafeName": "id", + "safeName": "id" + }, + "snakeCase": { + "unsafeName": "id", + "safeName": "id" + }, + "screamingSnakeCase": { + "unsafeName": "ID", + "safeName": "ID" + }, + "pascalCase": { + "unsafeName": "ID", + "safeName": "ID" + } + }, + "wireValue": "id" + }, + "value": { + "shape": { + "type": "container", + "container": { + "type": "optional", + "optional": { + "shape": { + "type": "primitive", + "primitive": { + "type": "integer", + "integer": 1 + } + }, + "jsonExample": 1 + }, + "valueType": { + "_type": "primitive", + "primitive": { + "v1": "INTEGER", + "v2": { + "type": "integer", + "default": null, + "validation": null + } + } + } + } + }, + "jsonExample": 1 + }, + "originalTypeDeclaration": { + "typeId": "type_:Schema1", + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "name": { + "originalName": "Schema1", + "camelCase": { + "unsafeName": "schema1", + "safeName": "schema1" + }, + "snakeCase": { + "unsafeName": "schema1", + "safeName": "schema1" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA1", + "safeName": "SCHEMA1" + }, + "pascalCase": { + "unsafeName": "Schema1", + "safeName": "Schema1" + } + } + } + }, + { + "name": { + "name": { + "originalName": "name", + "camelCase": { + "unsafeName": "name", + "safeName": "name" + }, + "snakeCase": { + "unsafeName": "name", + "safeName": "name" + }, + "screamingSnakeCase": { + "unsafeName": "NAME", + "safeName": "NAME" + }, + "pascalCase": { + "unsafeName": "Name", + "safeName": "Name" + } + }, + "wireValue": "name" + }, + "value": { + "shape": { + "type": "container", + "container": { + "type": "optional", + "optional": { + "shape": { + "type": "primitive", + "primitive": { + "type": "string", + "string": { + "original": "name" + } + } + }, + "jsonExample": "name" + }, + "valueType": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + } + } + }, + "jsonExample": "name" + }, + "originalTypeDeclaration": { + "typeId": "type_:Schema1", + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "name": { + "originalName": "Schema1", + "camelCase": { + "unsafeName": "schema1", + "safeName": "schema1" + }, + "snakeCase": { + "unsafeName": "schema1", + "safeName": "schema1" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA1", + "safeName": "SCHEMA1" + }, + "pascalCase": { + "unsafeName": "Schema1", + "safeName": "Schema1" + } + } + } + } + ] + } + }, + "jsonExample": { + "id": 1, + "name": "name" + } + } + } + }, + "jsonExample": { + "id": 1, + "name": "name" + } + } + } + }, + "docs": null + }, + "codeSamples": null + } + ], + "autogeneratedExamples": [ + { + "example": { + "id": "0be9bc672e16c380928a1262d7f5d88409f98ace", + "url": "/example", + "name": null, + "endpointHeaders": [], + "endpointPathParameters": [], + "queryParameters": [], + "servicePathParameters": [], + "serviceHeaders": [], + "rootPathParameters": [], + "request": null, + "response": { + "type": "ok", + "value": { + "type": "body", + "value": { + "shape": { + "type": "named", + "shape": { + "type": "undiscriminatedUnion", + "index": 0, + "singleUnionType": { + "shape": { + "type": "named", + "shape": { + "type": "object", + "properties": [ + { + "name": { + "name": { + "originalName": "id", + "camelCase": { + "unsafeName": "id", + "safeName": "id" + }, + "snakeCase": { + "unsafeName": "id", + "safeName": "id" + }, + "screamingSnakeCase": { + "unsafeName": "ID", + "safeName": "ID" + }, + "pascalCase": { + "unsafeName": "ID", + "safeName": "ID" + } + }, + "wireValue": "id" + }, + "originalTypeDeclaration": { + "name": { + "originalName": "Schema1", + "camelCase": { + "unsafeName": "schema1", + "safeName": "schema1" + }, + "snakeCase": { + "unsafeName": "schema1", + "safeName": "schema1" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA1", + "safeName": "SCHEMA1" + }, + "pascalCase": { + "unsafeName": "Schema1", + "safeName": "Schema1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:Schema1" + }, + "value": { + "shape": { + "type": "container", + "container": { + "type": "optional", + "optional": { + "shape": { + "type": "primitive", + "primitive": { + "type": "integer", + "integer": 1 + } + }, + "jsonExample": 1 + }, + "valueType": { + "_type": "primitive", + "primitive": { + "v1": "INTEGER", + "v2": { + "type": "integer", + "default": null, + "validation": null + } + } + } + } + }, + "jsonExample": 1 + } + }, + { + "name": { + "name": { + "originalName": "name", + "camelCase": { + "unsafeName": "name", + "safeName": "name" + }, + "snakeCase": { + "unsafeName": "name", + "safeName": "name" + }, + "screamingSnakeCase": { + "unsafeName": "NAME", + "safeName": "NAME" + }, + "pascalCase": { + "unsafeName": "Name", + "safeName": "Name" + } + }, + "wireValue": "name" + }, + "originalTypeDeclaration": { + "name": { + "originalName": "Schema1", + "camelCase": { + "unsafeName": "schema1", + "safeName": "schema1" + }, + "snakeCase": { + "unsafeName": "schema1", + "safeName": "schema1" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA1", + "safeName": "SCHEMA1" + }, + "pascalCase": { + "unsafeName": "Schema1", + "safeName": "Schema1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:Schema1" + }, + "value": { + "shape": { + "type": "container", + "container": { + "type": "optional", + "optional": { + "shape": { + "type": "primitive", + "primitive": { + "type": "string", + "string": { + "original": "name" + } + } + }, + "jsonExample": "name" + }, + "valueType": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + } + } + }, + "jsonExample": "name" + } + } + ] + }, + "typeName": { + "name": { + "originalName": "Schema1", + "camelCase": { + "unsafeName": "schema1", + "safeName": "schema1" + }, + "snakeCase": { + "unsafeName": "schema1", + "safeName": "schema1" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA1", + "safeName": "SCHEMA1" + }, + "pascalCase": { + "unsafeName": "Schema1", + "safeName": "Schema1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:Schema1" + } + }, + "jsonExample": { + "id": 1, + "name": "name" + } + } + }, + "typeName": { + "name": { + "originalName": "GetExampleResponse", + "camelCase": { + "unsafeName": "getExampleResponse", + "safeName": "getExampleResponse" + }, + "snakeCase": { + "unsafeName": "get_example_response", + "safeName": "get_example_response" + }, + "screamingSnakeCase": { + "unsafeName": "GET_EXAMPLE_RESPONSE", + "safeName": "GET_EXAMPLE_RESPONSE" + }, + "pascalCase": { + "unsafeName": "GetExampleResponse", + "safeName": "GetExampleResponse" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:GetExampleResponse" + } + }, + "jsonExample": { + "id": 1, + "name": "name" + } + } + } + }, + "docs": null + } + } + ], + "pagination": null, + "transport": null, + "availability": null, + "docs": null + }, + { + "id": "endpoint_.postRoot", + "name": { + "originalName": "postRoot", + "camelCase": { + "unsafeName": "postRoot", + "safeName": "postRoot" + }, + "snakeCase": { + "unsafeName": "post_root", + "safeName": "post_root" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT", + "safeName": "POST_ROOT" + }, + "pascalCase": { + "unsafeName": "PostRoot", + "safeName": "PostRoot" + } + }, + "displayName": null, + "auth": false, + "idempotent": false, + "baseUrl": null, + "method": "POST", + "basePath": null, + "path": { + "head": "/root", + "parts": [] + }, + "fullPath": { + "head": "root", + "parts": [] + }, + "pathParameters": [], + "allPathParameters": [], + "queryParameters": [], + "headers": [], + "requestBody": { + "type": "inlinedRequestBody", + "name": { + "originalName": "PostRootRequest", + "camelCase": { + "unsafeName": "postRootRequest", + "safeName": "postRootRequest" + }, + "snakeCase": { + "unsafeName": "post_root_request", + "safeName": "post_root_request" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_REQUEST", + "safeName": "POST_ROOT_REQUEST" + }, + "pascalCase": { + "unsafeName": "PostRootRequest", + "safeName": "PostRootRequest" + } + }, + "extends": [], + "contentType": "application/json", + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "valueType": { + "_type": "container", + "container": { + "_type": "optional", + "optional": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + } + } + }, + "availability": null, + "docs": null + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "valueType": { + "_type": "container", + "container": { + "_type": "optional", + "optional": { + "_type": "named", + "name": { + "originalName": "PostRootRequestBar", + "camelCase": { + "unsafeName": "postRootRequestBar", + "safeName": "postRootRequestBar" + }, + "snakeCase": { + "unsafeName": "post_root_request_bar", + "safeName": "post_root_request_bar" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_REQUEST_BAR", + "safeName": "POST_ROOT_REQUEST_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootRequestBar", + "safeName": "PostRootRequestBar" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:PostRootRequestBar", + "default": null, + "inline": null + } + } + }, + "availability": null, + "docs": null + } + ], + "extra-properties": false, + "extendedProperties": [], + "docs": null + }, + "sdkRequest": { + "shape": { + "type": "wrapper", + "wrapperName": { + "originalName": "PostRootRequest", + "camelCase": { + "unsafeName": "postRootRequest", + "safeName": "postRootRequest" + }, + "snakeCase": { + "unsafeName": "post_root_request", + "safeName": "post_root_request" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_REQUEST", + "safeName": "POST_ROOT_REQUEST" + }, + "pascalCase": { + "unsafeName": "PostRootRequest", + "safeName": "PostRootRequest" + } + }, + "bodyKey": { + "originalName": "body", + "camelCase": { + "unsafeName": "body", + "safeName": "body" + }, + "snakeCase": { + "unsafeName": "body", + "safeName": "body" + }, + "screamingSnakeCase": { + "unsafeName": "BODY", + "safeName": "BODY" + }, + "pascalCase": { + "unsafeName": "Body", + "safeName": "Body" + } + }, + "includePathParameters": false, + "onlyPathParameters": false + }, + "requestParameterName": { + "originalName": "request", + "camelCase": { + "unsafeName": "request", + "safeName": "request" + }, + "snakeCase": { + "unsafeName": "request", + "safeName": "request" + }, + "screamingSnakeCase": { + "unsafeName": "REQUEST", + "safeName": "REQUEST" + }, + "pascalCase": { + "unsafeName": "Request", + "safeName": "Request" + } + }, + "streamParameter": null + }, + "response": { + "body": { + "type": "json", + "value": { + "type": "response", + "responseBodyType": { + "_type": "named", + "name": { + "originalName": "PostRootResponse", + "camelCase": { + "unsafeName": "postRootResponse", + "safeName": "postRootResponse" + }, + "snakeCase": { + "unsafeName": "post_root_response", + "safeName": "post_root_response" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE", + "safeName": "POST_ROOT_RESPONSE" + }, + "pascalCase": { + "unsafeName": "PostRootResponse", + "safeName": "PostRootResponse" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:PostRootResponse", + "default": null, + "inline": null + }, + "docs": "Successful response" + } + }, + "status-code": null + }, + "errors": [], + "userSpecifiedExamples": [ + { + "example": { + "id": "7eda6d031b33bfd08627608eb55f4a966170a0ce281f137740f324a67facb8e2", + "name": null, + "url": "/root", + "rootPathParameters": [], + "endpointPathParameters": [], + "servicePathParameters": [], + "endpointHeaders": [], + "serviceHeaders": [], "queryParameters": [], - "request": null, + "request": { + "type": "inlinedRequestBody", + "properties": [], + "jsonExample": {} + }, "response": { "type": "ok", "value": { @@ -667,434 +3018,2297 @@ "shape": { "type": "named", "typeName": { - "typeId": "type_:GetExampleResponse", + "typeId": "type_:PostRootResponse", "fernFilepath": { "allParts": [], "packagePath": [], "file": null }, "name": { - "originalName": "GetExampleResponse", + "originalName": "PostRootResponse", "camelCase": { - "unsafeName": "getExampleResponse", - "safeName": "getExampleResponse" + "unsafeName": "postRootResponse", + "safeName": "postRootResponse" }, "snakeCase": { - "unsafeName": "get_example_response", - "safeName": "get_example_response" + "unsafeName": "post_root_response", + "safeName": "post_root_response" }, "screamingSnakeCase": { - "unsafeName": "GET_EXAMPLE_RESPONSE", - "safeName": "GET_EXAMPLE_RESPONSE" + "unsafeName": "POST_ROOT_RESPONSE", + "safeName": "POST_ROOT_RESPONSE" }, "pascalCase": { - "unsafeName": "GetExampleResponse", - "safeName": "GetExampleResponse" + "unsafeName": "PostRootResponse", + "safeName": "PostRootResponse" } } }, "shape": { - "type": "undiscriminatedUnion", - "index": 0, - "singleUnionType": { - "shape": { - "type": "named", - "typeName": { - "typeId": "type_:NotFound", + "type": "object", + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "value": { + "shape": { + "type": "container", + "container": { + "type": "optional", + "optional": { + "shape": { + "type": "primitive", + "primitive": { + "type": "string", + "string": { + "original": "foo" + } + } + }, + "jsonExample": "foo" + }, + "valueType": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + } + } + }, + "jsonExample": "foo" + }, + "originalTypeDeclaration": { + "typeId": "type_:PostRootResponse", "fernFilepath": { "allParts": [], "packagePath": [], "file": null }, "name": { - "originalName": "NotFound", + "originalName": "PostRootResponse", "camelCase": { - "unsafeName": "notFound", - "safeName": "notFound" + "unsafeName": "postRootResponse", + "safeName": "postRootResponse" }, "snakeCase": { - "unsafeName": "not_found", - "safeName": "not_found" + "unsafeName": "post_root_response", + "safeName": "post_root_response" }, "screamingSnakeCase": { - "unsafeName": "NOT_FOUND", - "safeName": "NOT_FOUND" + "unsafeName": "POST_ROOT_RESPONSE", + "safeName": "POST_ROOT_RESPONSE" }, "pascalCase": { - "unsafeName": "NotFound", - "safeName": "NotFound" + "unsafeName": "PostRootResponse", + "safeName": "PostRootResponse" } } + } + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" }, - "shape": { - "type": "object", - "properties": [ - { - "name": { + "value": { + "shape": { + "type": "container", + "container": { + "type": "optional", + "optional": { + "shape": { + "type": "named", + "typeName": { + "typeId": "type_:PostRootResponseBar", + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "name": { + "originalName": "PostRootResponseBar", + "camelCase": { + "unsafeName": "postRootResponseBar", + "safeName": "postRootResponseBar" + }, + "snakeCase": { + "unsafeName": "post_root_response_bar", + "safeName": "post_root_response_bar" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE_BAR", + "safeName": "POST_ROOT_RESPONSE_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootResponseBar", + "safeName": "PostRootResponseBar" + } + } + }, + "shape": { + "type": "object", + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "value": { + "shape": { + "type": "container", + "container": { + "type": "optional", + "optional": { + "shape": { + "type": "primitive", + "primitive": { + "type": "string", + "string": { + "original": "foo" + } + } + }, + "jsonExample": "foo" + }, + "valueType": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + } + } + }, + "jsonExample": "foo" + }, + "originalTypeDeclaration": { + "typeId": "type_:PostRootResponseBar", + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "name": { + "originalName": "PostRootResponseBar", + "camelCase": { + "unsafeName": "postRootResponseBar", + "safeName": "postRootResponseBar" + }, + "snakeCase": { + "unsafeName": "post_root_response_bar", + "safeName": "post_root_response_bar" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE_BAR", + "safeName": "POST_ROOT_RESPONSE_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootResponseBar", + "safeName": "PostRootResponseBar" + } + } + } + }, + { + "name": { + "name": { + "originalName": "inner_bar", + "camelCase": { + "unsafeName": "innerBar", + "safeName": "innerBar" + }, + "snakeCase": { + "unsafeName": "inner_bar", + "safeName": "inner_bar" + }, + "screamingSnakeCase": { + "unsafeName": "INNER_BAR", + "safeName": "INNER_BAR" + }, + "pascalCase": { + "unsafeName": "InnerBar", + "safeName": "InnerBar" + } + }, + "wireValue": "inner_bar" + }, + "value": { + "shape": { + "type": "container", + "container": { + "type": "optional", + "optional": { + "shape": { + "type": "named", + "typeName": { + "typeId": "type_:PostRootResponseBarInnerBar", + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "name": { + "originalName": "PostRootResponseBarInnerBar", + "camelCase": { + "unsafeName": "postRootResponseBarInnerBar", + "safeName": "postRootResponseBarInnerBar" + }, + "snakeCase": { + "unsafeName": "post_root_response_bar_inner_bar", + "safeName": "post_root_response_bar_inner_bar" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE_BAR_INNER_BAR", + "safeName": "POST_ROOT_RESPONSE_BAR_INNER_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootResponseBarInnerBar", + "safeName": "PostRootResponseBarInnerBar" + } + } + }, + "shape": { + "type": "object", + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "value": { + "shape": { + "type": "container", + "container": { + "type": "optional", + "optional": { + "shape": { + "type": "primitive", + "primitive": { + "type": "string", + "string": { + "original": "foo" + } + } + }, + "jsonExample": "foo" + }, + "valueType": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + } + } + }, + "jsonExample": "foo" + }, + "originalTypeDeclaration": { + "typeId": "type_:PostRootResponseBarInnerBar", + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "name": { + "originalName": "PostRootResponseBarInnerBar", + "camelCase": { + "unsafeName": "postRootResponseBarInnerBar", + "safeName": "postRootResponseBarInnerBar" + }, + "snakeCase": { + "unsafeName": "post_root_response_bar_inner_bar", + "safeName": "post_root_response_bar_inner_bar" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE_BAR_INNER_BAR", + "safeName": "POST_ROOT_RESPONSE_BAR_INNER_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootResponseBarInnerBar", + "safeName": "PostRootResponseBarInnerBar" + } + } + } + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "value": { + "shape": { + "type": "container", + "container": { + "type": "optional", + "optional": { + "shape": { + "type": "primitive", + "primitive": { + "type": "string", + "string": { + "original": "bar" + } + } + }, + "jsonExample": "bar" + }, + "valueType": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + } + } + }, + "jsonExample": "bar" + }, + "originalTypeDeclaration": { + "typeId": "type_:PostRootResponseBarInnerBar", + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "name": { + "originalName": "PostRootResponseBarInnerBar", + "camelCase": { + "unsafeName": "postRootResponseBarInnerBar", + "safeName": "postRootResponseBarInnerBar" + }, + "snakeCase": { + "unsafeName": "post_root_response_bar_inner_bar", + "safeName": "post_root_response_bar_inner_bar" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE_BAR_INNER_BAR", + "safeName": "POST_ROOT_RESPONSE_BAR_INNER_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootResponseBarInnerBar", + "safeName": "PostRootResponseBarInnerBar" + } + } + } + } + ] + } + }, + "jsonExample": { + "foo": "foo", + "bar": "bar" + } + }, + "valueType": { + "_type": "named", + "name": { + "originalName": "PostRootResponseBarInnerBar", + "camelCase": { + "unsafeName": "postRootResponseBarInnerBar", + "safeName": "postRootResponseBarInnerBar" + }, + "snakeCase": { + "unsafeName": "post_root_response_bar_inner_bar", + "safeName": "post_root_response_bar_inner_bar" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE_BAR_INNER_BAR", + "safeName": "POST_ROOT_RESPONSE_BAR_INNER_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootResponseBarInnerBar", + "safeName": "PostRootResponseBarInnerBar" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:PostRootResponseBarInnerBar", + "default": null, + "inline": null + } + } + }, + "jsonExample": { + "foo": "foo", + "bar": "bar" + } + }, + "originalTypeDeclaration": { + "typeId": "type_:PostRootResponseBar", + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "name": { + "originalName": "PostRootResponseBar", + "camelCase": { + "unsafeName": "postRootResponseBar", + "safeName": "postRootResponseBar" + }, + "snakeCase": { + "unsafeName": "post_root_response_bar", + "safeName": "post_root_response_bar" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE_BAR", + "safeName": "POST_ROOT_RESPONSE_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootResponseBar", + "safeName": "PostRootResponseBar" + } + } + } + } + ] + } + }, + "jsonExample": { + "foo": "foo", + "inner_bar": { + "foo": "foo", + "bar": "bar" + } + } + }, + "valueType": { + "_type": "named", "name": { - "originalName": "message", + "originalName": "PostRootResponseBar", "camelCase": { - "unsafeName": "message", - "safeName": "message" + "unsafeName": "postRootResponseBar", + "safeName": "postRootResponseBar" }, "snakeCase": { - "unsafeName": "message", - "safeName": "message" + "unsafeName": "post_root_response_bar", + "safeName": "post_root_response_bar" }, "screamingSnakeCase": { - "unsafeName": "MESSAGE", - "safeName": "MESSAGE" + "unsafeName": "POST_ROOT_RESPONSE_BAR", + "safeName": "POST_ROOT_RESPONSE_BAR" }, "pascalCase": { - "unsafeName": "Message", - "safeName": "Message" + "unsafeName": "PostRootResponseBar", + "safeName": "PostRootResponseBar" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:PostRootResponseBar", + "default": null, + "inline": null + } + } + }, + "jsonExample": { + "foo": "foo", + "inner_bar": { + "foo": "foo", + "bar": "bar" + } + } + }, + "originalTypeDeclaration": { + "typeId": "type_:PostRootResponse", + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "name": { + "originalName": "PostRootResponse", + "camelCase": { + "unsafeName": "postRootResponse", + "safeName": "postRootResponse" + }, + "snakeCase": { + "unsafeName": "post_root_response", + "safeName": "post_root_response" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE", + "safeName": "POST_ROOT_RESPONSE" + }, + "pascalCase": { + "unsafeName": "PostRootResponse", + "safeName": "PostRootResponse" + } + } + } + } + ] + } + }, + "jsonExample": { + "foo": "foo", + "bar": { + "foo": "foo", + "inner_bar": { + "foo": "foo", + "bar": "bar" + } + } + } + } + } + }, + "docs": null + }, + "codeSamples": null + } + ], + "autogeneratedExamples": [ + { + "example": { + "id": "55381b1afc6f17c8c6a557a880679ee9e9dcc73d", + "url": "/root", + "name": null, + "endpointHeaders": [], + "endpointPathParameters": [], + "queryParameters": [], + "servicePathParameters": [], + "serviceHeaders": [], + "rootPathParameters": [], + "request": { + "type": "inlinedRequestBody", + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "originalTypeDeclaration": null, + "value": { + "shape": { + "type": "container", + "container": { + "type": "optional", + "optional": null, + "valueType": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + } + } + } + } + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "originalTypeDeclaration": null, + "value": { + "shape": { + "type": "container", + "container": { + "type": "optional", + "optional": null, + "valueType": { + "_type": "named", + "name": { + "originalName": "PostRootRequestBar", + "camelCase": { + "unsafeName": "postRootRequestBar", + "safeName": "postRootRequestBar" + }, + "snakeCase": { + "unsafeName": "post_root_request_bar", + "safeName": "post_root_request_bar" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_REQUEST_BAR", + "safeName": "POST_ROOT_REQUEST_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootRequestBar", + "safeName": "PostRootRequestBar" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:PostRootRequestBar", + "default": null, + "inline": null + } + } + } + } + } + ], + "jsonExample": {} + }, + "response": { + "type": "ok", + "value": { + "type": "body", + "value": { + "shape": { + "type": "named", + "shape": { + "type": "object", + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "originalTypeDeclaration": { + "name": { + "originalName": "PostRootResponse", + "camelCase": { + "unsafeName": "postRootResponse", + "safeName": "postRootResponse" + }, + "snakeCase": { + "unsafeName": "post_root_response", + "safeName": "post_root_response" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE", + "safeName": "POST_ROOT_RESPONSE" + }, + "pascalCase": { + "unsafeName": "PostRootResponse", + "safeName": "PostRootResponse" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:PostRootResponse" + }, + "value": { + "shape": { + "type": "container", + "container": { + "type": "optional", + "optional": { + "shape": { + "type": "primitive", + "primitive": { + "type": "string", + "string": { + "original": "foo" + } } }, - "wireValue": "message" + "jsonExample": "foo" }, - "value": { + "valueType": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + } + } + }, + "jsonExample": "foo" + } + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "originalTypeDeclaration": { + "name": { + "originalName": "PostRootResponse", + "camelCase": { + "unsafeName": "postRootResponse", + "safeName": "postRootResponse" + }, + "snakeCase": { + "unsafeName": "post_root_response", + "safeName": "post_root_response" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE", + "safeName": "POST_ROOT_RESPONSE" + }, + "pascalCase": { + "unsafeName": "PostRootResponse", + "safeName": "PostRootResponse" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:PostRootResponse" + }, + "value": { + "shape": { + "type": "container", + "container": { + "type": "optional", + "optional": { "shape": { - "type": "container", - "container": { - "type": "optional", - "optional": { - "shape": { - "type": "primitive", - "primitive": { - "type": "string", - "string": { - "original": "message" - } + "type": "named", + "shape": { + "type": "object", + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "originalTypeDeclaration": { + "name": { + "originalName": "PostRootResponseBar", + "camelCase": { + "unsafeName": "postRootResponseBar", + "safeName": "postRootResponseBar" + }, + "snakeCase": { + "unsafeName": "post_root_response_bar", + "safeName": "post_root_response_bar" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE_BAR", + "safeName": "POST_ROOT_RESPONSE_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootResponseBar", + "safeName": "PostRootResponseBar" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:PostRootResponseBar" + }, + "value": { + "shape": { + "type": "container", + "container": { + "type": "optional", + "optional": { + "shape": { + "type": "primitive", + "primitive": { + "type": "string", + "string": { + "original": "foo" + } + } + }, + "jsonExample": "foo" + }, + "valueType": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + } + } + }, + "jsonExample": "foo" } }, - "jsonExample": "message" - }, - "valueType": { - "_type": "primitive", - "primitive": { - "v1": "STRING", - "v2": { - "type": "string", - "default": null, - "validation": null + { + "name": { + "name": { + "originalName": "inner_bar", + "camelCase": { + "unsafeName": "innerBar", + "safeName": "innerBar" + }, + "snakeCase": { + "unsafeName": "inner_bar", + "safeName": "inner_bar" + }, + "screamingSnakeCase": { + "unsafeName": "INNER_BAR", + "safeName": "INNER_BAR" + }, + "pascalCase": { + "unsafeName": "InnerBar", + "safeName": "InnerBar" + } + }, + "wireValue": "inner_bar" + }, + "originalTypeDeclaration": { + "name": { + "originalName": "PostRootResponseBar", + "camelCase": { + "unsafeName": "postRootResponseBar", + "safeName": "postRootResponseBar" + }, + "snakeCase": { + "unsafeName": "post_root_response_bar", + "safeName": "post_root_response_bar" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE_BAR", + "safeName": "POST_ROOT_RESPONSE_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootResponseBar", + "safeName": "PostRootResponseBar" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:PostRootResponseBar" + }, + "value": { + "shape": { + "type": "container", + "container": { + "type": "optional", + "optional": { + "shape": { + "type": "named", + "shape": { + "type": "object", + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "originalTypeDeclaration": { + "name": { + "originalName": "PostRootResponseBarInnerBar", + "camelCase": { + "unsafeName": "postRootResponseBarInnerBar", + "safeName": "postRootResponseBarInnerBar" + }, + "snakeCase": { + "unsafeName": "post_root_response_bar_inner_bar", + "safeName": "post_root_response_bar_inner_bar" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE_BAR_INNER_BAR", + "safeName": "POST_ROOT_RESPONSE_BAR_INNER_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootResponseBarInnerBar", + "safeName": "PostRootResponseBarInnerBar" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:PostRootResponseBarInnerBar" + }, + "value": { + "shape": { + "type": "container", + "container": { + "type": "optional", + "optional": { + "shape": { + "type": "primitive", + "primitive": { + "type": "string", + "string": { + "original": "foo" + } + } + }, + "jsonExample": "foo" + }, + "valueType": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + } + } + }, + "jsonExample": "foo" + } + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "originalTypeDeclaration": { + "name": { + "originalName": "PostRootResponseBarInnerBar", + "camelCase": { + "unsafeName": "postRootResponseBarInnerBar", + "safeName": "postRootResponseBarInnerBar" + }, + "snakeCase": { + "unsafeName": "post_root_response_bar_inner_bar", + "safeName": "post_root_response_bar_inner_bar" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE_BAR_INNER_BAR", + "safeName": "POST_ROOT_RESPONSE_BAR_INNER_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootResponseBarInnerBar", + "safeName": "PostRootResponseBarInnerBar" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:PostRootResponseBarInnerBar" + }, + "value": { + "shape": { + "type": "container", + "container": { + "type": "optional", + "optional": { + "shape": { + "type": "primitive", + "primitive": { + "type": "string", + "string": { + "original": "bar" + } + } + }, + "jsonExample": "bar" + }, + "valueType": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + } + } + }, + "jsonExample": "bar" + } + } + ] + }, + "typeName": { + "name": { + "originalName": "PostRootResponseBarInnerBar", + "camelCase": { + "unsafeName": "postRootResponseBarInnerBar", + "safeName": "postRootResponseBarInnerBar" + }, + "snakeCase": { + "unsafeName": "post_root_response_bar_inner_bar", + "safeName": "post_root_response_bar_inner_bar" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE_BAR_INNER_BAR", + "safeName": "POST_ROOT_RESPONSE_BAR_INNER_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootResponseBarInnerBar", + "safeName": "PostRootResponseBarInnerBar" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:PostRootResponseBarInnerBar" + } + }, + "jsonExample": { + "foo": "foo", + "bar": "bar" + } + }, + "valueType": { + "_type": "named", + "name": { + "originalName": "PostRootResponseBarInnerBar", + "camelCase": { + "unsafeName": "postRootResponseBarInnerBar", + "safeName": "postRootResponseBarInnerBar" + }, + "snakeCase": { + "unsafeName": "post_root_response_bar_inner_bar", + "safeName": "post_root_response_bar_inner_bar" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE_BAR_INNER_BAR", + "safeName": "POST_ROOT_RESPONSE_BAR_INNER_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootResponseBarInnerBar", + "safeName": "PostRootResponseBarInnerBar" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:PostRootResponseBarInnerBar", + "default": null, + "inline": null + } + } + }, + "jsonExample": { + "foo": "foo", + "bar": "bar" + } } } - } + ] + }, + "typeName": { + "name": { + "originalName": "PostRootResponseBar", + "camelCase": { + "unsafeName": "postRootResponseBar", + "safeName": "postRootResponseBar" + }, + "snakeCase": { + "unsafeName": "post_root_response_bar", + "safeName": "post_root_response_bar" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE_BAR", + "safeName": "POST_ROOT_RESPONSE_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootResponseBar", + "safeName": "PostRootResponseBar" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:PostRootResponseBar" } }, - "jsonExample": "message" + "jsonExample": { + "foo": "foo", + "inner_bar": { + "foo": "foo", + "bar": "bar" + } + } }, - "originalTypeDeclaration": { - "typeId": "type_:NotFound", - "fernFilepath": { - "allParts": [], - "packagePath": [], - "file": null - }, + "valueType": { + "_type": "named", "name": { - "originalName": "NotFound", + "originalName": "PostRootResponseBar", "camelCase": { - "unsafeName": "notFound", - "safeName": "notFound" + "unsafeName": "postRootResponseBar", + "safeName": "postRootResponseBar" }, "snakeCase": { - "unsafeName": "not_found", - "safeName": "not_found" + "unsafeName": "post_root_response_bar", + "safeName": "post_root_response_bar" }, "screamingSnakeCase": { - "unsafeName": "NOT_FOUND", - "safeName": "NOT_FOUND" + "unsafeName": "POST_ROOT_RESPONSE_BAR", + "safeName": "POST_ROOT_RESPONSE_BAR" }, "pascalCase": { - "unsafeName": "NotFound", - "safeName": "NotFound" + "unsafeName": "PostRootResponseBar", + "safeName": "PostRootResponseBar" } - } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:PostRootResponseBar", + "default": null, + "inline": null } } - ] + }, + "jsonExample": { + "foo": "foo", + "inner_bar": { + "foo": "foo", + "bar": "bar" + } + } } + } + ] + }, + "typeName": { + "name": { + "originalName": "PostRootResponse", + "camelCase": { + "unsafeName": "postRootResponse", + "safeName": "postRootResponse" }, - "jsonExample": { - "message": "message" + "snakeCase": { + "unsafeName": "post_root_response", + "safeName": "post_root_response" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE", + "safeName": "POST_ROOT_RESPONSE" + }, + "pascalCase": { + "unsafeName": "PostRootResponse", + "safeName": "PostRootResponse" } - } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:PostRootResponse" } }, "jsonExample": { - "message": "message" + "foo": "foo", + "bar": { + "foo": "foo", + "inner_bar": { + "foo": "foo", + "bar": "bar" + } + } } } } }, - "docs": null + "docs": null + } + } + ], + "pagination": null, + "transport": null, + "availability": null, + "docs": null + } + ] + } + }, + "constants": { + "errorInstanceIdKey": { + "name": { + "originalName": "errorInstanceId", + "camelCase": { + "unsafeName": "errorInstanceID", + "safeName": "errorInstanceID" + }, + "snakeCase": { + "unsafeName": "error_instance_id", + "safeName": "error_instance_id" + }, + "screamingSnakeCase": { + "unsafeName": "ERROR_INSTANCE_ID", + "safeName": "ERROR_INSTANCE_ID" + }, + "pascalCase": { + "unsafeName": "ErrorInstanceID", + "safeName": "ErrorInstanceID" + } + }, + "wireValue": "errorInstanceId" + } + }, + "environments": null, + "errorDiscriminationStrategy": { + "type": "statusCode" + }, + "basePath": null, + "pathParameters": [], + "variables": [], + "serviceTypeReferenceInfo": { + "typesReferencedOnlyByService": { + "service_": [ + "type_:GetExampleResponse", + "type_:PostRootRequestBarInnerBar", + "type_:PostRootRequestBar", + "type_:PostRootResponseBarInnerBar", + "type_:PostRootResponseBar", + "type_:PostRootResponse", + "type_:Schema1", + "type_:Schema2TestEnum", + "type_:Schema2TestDiscriminatedUnionZero", + "type_:Schema2TestDiscriminatedUnionOne", + "type_:Schema2TestDiscriminatedUnion", + "type_:Schema2TestUnionA", + "type_:Schema2TestUnionB", + "type_:Schema2TestUnion", + "type_:Schema2" + ] + }, + "sharedTypes": [] + }, + "webhookGroups": {}, + "websocketChannels": {}, + "readmeConfig": null, + "sourceConfig": null, + "publishConfig": null, + "dynamic": { + "version": "1.0.0", + "types": { + "type_:GetExampleResponse": { + "type": "undiscriminatedUnion", + "declaration": { + "name": { + "originalName": "GetExampleResponse", + "camelCase": { + "unsafeName": "getExampleResponse", + "safeName": "getExampleResponse" + }, + "snakeCase": { + "unsafeName": "get_example_response", + "safeName": "get_example_response" + }, + "screamingSnakeCase": { + "unsafeName": "GET_EXAMPLE_RESPONSE", + "safeName": "GET_EXAMPLE_RESPONSE" + }, + "pascalCase": { + "unsafeName": "GetExampleResponse", + "safeName": "GetExampleResponse" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "types": [ + { + "_type": "named", + "value": "type_:Schema1" + }, + { + "_type": "named", + "value": "type_:Schema2" + } + ] + }, + "type_:PostRootRequestBarInnerBar": { + "type": "object", + "declaration": { + "name": { + "originalName": "PostRootRequestBarInnerBar", + "camelCase": { + "unsafeName": "postRootRequestBarInnerBar", + "safeName": "postRootRequestBarInnerBar" + }, + "snakeCase": { + "unsafeName": "post_root_request_bar_inner_bar", + "safeName": "post_root_request_bar_inner_bar" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_REQUEST_BAR_INNER_BAR", + "safeName": "POST_ROOT_REQUEST_BAR_INNER_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootRequestBarInnerBar", + "safeName": "PostRootRequestBarInnerBar" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "typeReference": { + "_type": "optional", + "value": { + "_type": "primitive", + "value": "STRING" + } + } + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "typeReference": { + "_type": "optional", + "value": { + "_type": "primitive", + "value": "STRING" + } + } + } + ] + }, + "type_:PostRootRequestBar": { + "type": "object", + "declaration": { + "name": { + "originalName": "PostRootRequestBar", + "camelCase": { + "unsafeName": "postRootRequestBar", + "safeName": "postRootRequestBar" + }, + "snakeCase": { + "unsafeName": "post_root_request_bar", + "safeName": "post_root_request_bar" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_REQUEST_BAR", + "safeName": "POST_ROOT_REQUEST_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootRequestBar", + "safeName": "PostRootRequestBar" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "typeReference": { + "_type": "optional", + "value": { + "_type": "primitive", + "value": "STRING" + } + } + }, + { + "name": { + "name": { + "originalName": "inner_bar", + "camelCase": { + "unsafeName": "innerBar", + "safeName": "innerBar" + }, + "snakeCase": { + "unsafeName": "inner_bar", + "safeName": "inner_bar" + }, + "screamingSnakeCase": { + "unsafeName": "INNER_BAR", + "safeName": "INNER_BAR" + }, + "pascalCase": { + "unsafeName": "InnerBar", + "safeName": "InnerBar" + } + }, + "wireValue": "inner_bar" + }, + "typeReference": { + "_type": "optional", + "value": { + "_type": "named", + "value": "type_:PostRootRequestBarInnerBar" + } + } + } + ] + }, + "type_:PostRootResponseBarInnerBar": { + "type": "object", + "declaration": { + "name": { + "originalName": "PostRootResponseBarInnerBar", + "camelCase": { + "unsafeName": "postRootResponseBarInnerBar", + "safeName": "postRootResponseBarInnerBar" + }, + "snakeCase": { + "unsafeName": "post_root_response_bar_inner_bar", + "safeName": "post_root_response_bar_inner_bar" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE_BAR_INNER_BAR", + "safeName": "POST_ROOT_RESPONSE_BAR_INNER_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootResponseBarInnerBar", + "safeName": "PostRootResponseBarInnerBar" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } }, - "codeSamples": null + "wireValue": "foo" + }, + "typeReference": { + "_type": "optional", + "value": { + "_type": "primitive", + "value": "STRING" + } } - ], - "autogeneratedExamples": [ - { - "example": { - "id": "d88e161aef95bb901f3579d5a4a37487d0c6a2a5", - "url": "/example", - "name": null, - "endpointHeaders": [], - "endpointPathParameters": [], - "queryParameters": [], - "servicePathParameters": [], - "serviceHeaders": [], - "rootPathParameters": [], - "request": null, - "response": { - "type": "ok", - "value": { - "type": "body", - "value": { - "shape": { - "type": "named", - "shape": { - "type": "undiscriminatedUnion", - "index": 0, - "singleUnionType": { - "shape": { - "type": "named", - "shape": { - "type": "object", - "properties": [ - { - "name": { - "name": { - "originalName": "message", - "camelCase": { - "unsafeName": "message", - "safeName": "message" - }, - "snakeCase": { - "unsafeName": "message", - "safeName": "message" - }, - "screamingSnakeCase": { - "unsafeName": "MESSAGE", - "safeName": "MESSAGE" - }, - "pascalCase": { - "unsafeName": "Message", - "safeName": "Message" - } - }, - "wireValue": "message" - }, - "originalTypeDeclaration": { - "name": { - "originalName": "NotFound", - "camelCase": { - "unsafeName": "notFound", - "safeName": "notFound" - }, - "snakeCase": { - "unsafeName": "not_found", - "safeName": "not_found" - }, - "screamingSnakeCase": { - "unsafeName": "NOT_FOUND", - "safeName": "NOT_FOUND" - }, - "pascalCase": { - "unsafeName": "NotFound", - "safeName": "NotFound" - } - }, - "fernFilepath": { - "allParts": [], - "packagePath": [], - "file": null - }, - "typeId": "type_:NotFound" - }, - "value": { - "shape": { - "type": "container", - "container": { - "type": "optional", - "optional": { - "shape": { - "type": "primitive", - "primitive": { - "type": "string", - "string": { - "original": "message" - } - } - }, - "jsonExample": "message" - }, - "valueType": { - "_type": "primitive", - "primitive": { - "v1": "STRING", - "v2": { - "type": "string", - "default": null, - "validation": null - } - } - } - } - }, - "jsonExample": "message" - } - } - ] - }, - "typeName": { - "name": { - "originalName": "NotFound", - "camelCase": { - "unsafeName": "notFound", - "safeName": "notFound" - }, - "snakeCase": { - "unsafeName": "not_found", - "safeName": "not_found" - }, - "screamingSnakeCase": { - "unsafeName": "NOT_FOUND", - "safeName": "NOT_FOUND" - }, - "pascalCase": { - "unsafeName": "NotFound", - "safeName": "NotFound" - } - }, - "fernFilepath": { - "allParts": [], - "packagePath": [], - "file": null - }, - "typeId": "type_:NotFound" - } - }, - "jsonExample": { - "message": "message" - } - } - }, - "typeName": { - "name": { - "originalName": "GetExampleResponse", - "camelCase": { - "unsafeName": "getExampleResponse", - "safeName": "getExampleResponse" - }, - "snakeCase": { - "unsafeName": "get_example_response", - "safeName": "get_example_response" - }, - "screamingSnakeCase": { - "unsafeName": "GET_EXAMPLE_RESPONSE", - "safeName": "GET_EXAMPLE_RESPONSE" - }, - "pascalCase": { - "unsafeName": "GetExampleResponse", - "safeName": "GetExampleResponse" - } - }, - "fernFilepath": { - "allParts": [], - "packagePath": [], - "file": null - }, - "typeId": "type_:GetExampleResponse" - } - }, - "jsonExample": { - "message": "message" - } - } - } + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "typeReference": { + "_type": "optional", + "value": { + "_type": "primitive", + "value": "STRING" + } + } + } + ] + }, + "type_:PostRootResponseBar": { + "type": "object", + "declaration": { + "name": { + "originalName": "PostRootResponseBar", + "camelCase": { + "unsafeName": "postRootResponseBar", + "safeName": "postRootResponseBar" + }, + "snakeCase": { + "unsafeName": "post_root_response_bar", + "safeName": "post_root_response_bar" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE_BAR", + "safeName": "POST_ROOT_RESPONSE_BAR" + }, + "pascalCase": { + "unsafeName": "PostRootResponseBar", + "safeName": "PostRootResponseBar" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "typeReference": { + "_type": "optional", + "value": { + "_type": "primitive", + "value": "STRING" + } + } + }, + { + "name": { + "name": { + "originalName": "inner_bar", + "camelCase": { + "unsafeName": "innerBar", + "safeName": "innerBar" + }, + "snakeCase": { + "unsafeName": "inner_bar", + "safeName": "inner_bar" + }, + "screamingSnakeCase": { + "unsafeName": "INNER_BAR", + "safeName": "INNER_BAR" + }, + "pascalCase": { + "unsafeName": "InnerBar", + "safeName": "InnerBar" + } + }, + "wireValue": "inner_bar" + }, + "typeReference": { + "_type": "optional", + "value": { + "_type": "named", + "value": "type_:PostRootResponseBarInnerBar" + } + } + } + ] + }, + "type_:PostRootResponse": { + "type": "object", + "declaration": { + "name": { + "originalName": "PostRootResponse", + "camelCase": { + "unsafeName": "postRootResponse", + "safeName": "postRootResponse" + }, + "snakeCase": { + "unsafeName": "post_root_response", + "safeName": "post_root_response" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_RESPONSE", + "safeName": "POST_ROOT_RESPONSE" + }, + "pascalCase": { + "unsafeName": "PostRootResponse", + "safeName": "PostRootResponse" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" }, - "docs": null + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "typeReference": { + "_type": "optional", + "value": { + "_type": "primitive", + "value": "STRING" } } - ], - "pagination": null, - "transport": null, - "availability": null, - "docs": null - } - ] - } - }, - "constants": { - "errorInstanceIdKey": { - "name": { - "originalName": "errorInstanceId", - "camelCase": { - "unsafeName": "errorInstanceID", - "safeName": "errorInstanceID" + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "typeReference": { + "_type": "optional", + "value": { + "_type": "named", + "value": "type_:PostRootResponseBar" + } + } + } + ] + }, + "type_:Schema1": { + "type": "object", + "declaration": { + "name": { + "originalName": "Schema1", + "camelCase": { + "unsafeName": "schema1", + "safeName": "schema1" + }, + "snakeCase": { + "unsafeName": "schema1", + "safeName": "schema1" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA1", + "safeName": "SCHEMA1" + }, + "pascalCase": { + "unsafeName": "Schema1", + "safeName": "Schema1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } }, - "snakeCase": { - "unsafeName": "error_instance_id", - "safeName": "error_instance_id" + "properties": [ + { + "name": { + "name": { + "originalName": "id", + "camelCase": { + "unsafeName": "id", + "safeName": "id" + }, + "snakeCase": { + "unsafeName": "id", + "safeName": "id" + }, + "screamingSnakeCase": { + "unsafeName": "ID", + "safeName": "ID" + }, + "pascalCase": { + "unsafeName": "ID", + "safeName": "ID" + } + }, + "wireValue": "id" + }, + "typeReference": { + "_type": "optional", + "value": { + "_type": "primitive", + "value": "INTEGER" + } + } + }, + { + "name": { + "name": { + "originalName": "name", + "camelCase": { + "unsafeName": "name", + "safeName": "name" + }, + "snakeCase": { + "unsafeName": "name", + "safeName": "name" + }, + "screamingSnakeCase": { + "unsafeName": "NAME", + "safeName": "NAME" + }, + "pascalCase": { + "unsafeName": "Name", + "safeName": "Name" + } + }, + "wireValue": "name" + }, + "typeReference": { + "_type": "optional", + "value": { + "_type": "primitive", + "value": "STRING" + } + } + } + ] + }, + "type_:Schema2TestEnum": { + "type": "enum", + "declaration": { + "name": { + "originalName": "Schema2TestEnum", + "camelCase": { + "unsafeName": "schema2TestEnum", + "safeName": "schema2TestEnum" + }, + "snakeCase": { + "unsafeName": "schema2test_enum", + "safeName": "schema2test_enum" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA2TEST_ENUM", + "safeName": "SCHEMA2TEST_ENUM" + }, + "pascalCase": { + "unsafeName": "Schema2TestEnum", + "safeName": "Schema2TestEnum" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } }, - "screamingSnakeCase": { - "unsafeName": "ERROR_INSTANCE_ID", - "safeName": "ERROR_INSTANCE_ID" + "values": [ + { + "name": { + "originalName": "test1", + "camelCase": { + "unsafeName": "test1", + "safeName": "test1" + }, + "snakeCase": { + "unsafeName": "test1", + "safeName": "test1" + }, + "screamingSnakeCase": { + "unsafeName": "TEST1", + "safeName": "TEST1" + }, + "pascalCase": { + "unsafeName": "Test1", + "safeName": "Test1" + } + }, + "wireValue": "test1" + }, + { + "name": { + "originalName": "test2", + "camelCase": { + "unsafeName": "test2", + "safeName": "test2" + }, + "snakeCase": { + "unsafeName": "test2", + "safeName": "test2" + }, + "screamingSnakeCase": { + "unsafeName": "TEST2", + "safeName": "TEST2" + }, + "pascalCase": { + "unsafeName": "Test2", + "safeName": "Test2" + } + }, + "wireValue": "test2" + }, + { + "name": { + "originalName": "test3", + "camelCase": { + "unsafeName": "test3", + "safeName": "test3" + }, + "snakeCase": { + "unsafeName": "test3", + "safeName": "test3" + }, + "screamingSnakeCase": { + "unsafeName": "TEST3", + "safeName": "TEST3" + }, + "pascalCase": { + "unsafeName": "Test3", + "safeName": "Test3" + } + }, + "wireValue": "test3" + } + ] + }, + "type_:Schema2TestDiscriminatedUnionZero": { + "type": "object", + "declaration": { + "name": { + "originalName": "Schema2TestDiscriminatedUnionZero", + "camelCase": { + "unsafeName": "schema2TestDiscriminatedUnionZero", + "safeName": "schema2TestDiscriminatedUnionZero" + }, + "snakeCase": { + "unsafeName": "schema2test_discriminated_union_zero", + "safeName": "schema2test_discriminated_union_zero" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA2TEST_DISCRIMINATED_UNION_ZERO", + "safeName": "SCHEMA2TEST_DISCRIMINATED_UNION_ZERO" + }, + "pascalCase": { + "unsafeName": "Schema2TestDiscriminatedUnionZero", + "safeName": "Schema2TestDiscriminatedUnionZero" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } }, - "pascalCase": { - "unsafeName": "ErrorInstanceID", - "safeName": "ErrorInstanceID" - } + "properties": [ + { + "name": { + "name": { + "originalName": "objectType", + "camelCase": { + "unsafeName": "objectType", + "safeName": "objectType" + }, + "snakeCase": { + "unsafeName": "object_type", + "safeName": "object_type" + }, + "screamingSnakeCase": { + "unsafeName": "OBJECT_TYPE", + "safeName": "OBJECT_TYPE" + }, + "pascalCase": { + "unsafeName": "ObjectType", + "safeName": "ObjectType" + } + }, + "wireValue": "objectType" + }, + "typeReference": { + "_type": "optional", + "value": { + "_type": "primitive", + "value": "STRING" + } + } + } + ] }, - "wireValue": "errorInstanceId" - } - }, - "environments": null, - "errorDiscriminationStrategy": { - "type": "statusCode" - }, - "basePath": null, - "pathParameters": [], - "variables": [], - "serviceTypeReferenceInfo": { - "typesReferencedOnlyByService": { - "service_": [ - "type_:NotFound", - "type_:GetExampleResponse", - "type_:Schema1", - "type_:Schema2" - ] - }, - "sharedTypes": [] - }, - "webhookGroups": {}, - "websocketChannels": {}, - "readmeConfig": null, - "sourceConfig": null, - "publishConfig": null, - "dynamic": { - "version": "1.0.0", - "types": { - "type_:NotFound": { + "type_:Schema2TestDiscriminatedUnionOne": { "type": "object", "declaration": { "name": { - "originalName": "NotFound", + "originalName": "Schema2TestDiscriminatedUnionOne", "camelCase": { - "unsafeName": "notFound", - "safeName": "notFound" + "unsafeName": "schema2TestDiscriminatedUnionOne", + "safeName": "schema2TestDiscriminatedUnionOne" }, "snakeCase": { - "unsafeName": "not_found", - "safeName": "not_found" + "unsafeName": "schema2test_discriminated_union_one", + "safeName": "schema2test_discriminated_union_one" }, "screamingSnakeCase": { - "unsafeName": "NOT_FOUND", - "safeName": "NOT_FOUND" + "unsafeName": "SCHEMA2TEST_DISCRIMINATED_UNION_ONE", + "safeName": "SCHEMA2TEST_DISCRIMINATED_UNION_ONE" }, "pascalCase": { - "unsafeName": "NotFound", - "safeName": "NotFound" + "unsafeName": "Schema2TestDiscriminatedUnionOne", + "safeName": "Schema2TestDiscriminatedUnionOne" } }, "fernFilepath": { @@ -1107,25 +5321,25 @@ { "name": { "name": { - "originalName": "message", + "originalName": "objectType", "camelCase": { - "unsafeName": "message", - "safeName": "message" + "unsafeName": "objectType", + "safeName": "objectType" }, "snakeCase": { - "unsafeName": "message", - "safeName": "message" + "unsafeName": "object_type", + "safeName": "object_type" }, "screamingSnakeCase": { - "unsafeName": "MESSAGE", - "safeName": "MESSAGE" + "unsafeName": "OBJECT_TYPE", + "safeName": "OBJECT_TYPE" }, "pascalCase": { - "unsafeName": "Message", - "safeName": "Message" + "unsafeName": "ObjectType", + "safeName": "ObjectType" } }, - "wireValue": "message" + "wireValue": "objectType" }, "typeReference": { "_type": "optional", @@ -1137,26 +5351,26 @@ } ] }, - "type_:GetExampleResponse": { + "type_:Schema2TestDiscriminatedUnion": { "type": "undiscriminatedUnion", "declaration": { "name": { - "originalName": "GetExampleResponse", + "originalName": "Schema2TestDiscriminatedUnion", "camelCase": { - "unsafeName": "getExampleResponse", - "safeName": "getExampleResponse" + "unsafeName": "schema2TestDiscriminatedUnion", + "safeName": "schema2TestDiscriminatedUnion" }, "snakeCase": { - "unsafeName": "get_example_response", - "safeName": "get_example_response" + "unsafeName": "schema2test_discriminated_union", + "safeName": "schema2test_discriminated_union" }, "screamingSnakeCase": { - "unsafeName": "GET_EXAMPLE_RESPONSE", - "safeName": "GET_EXAMPLE_RESPONSE" + "unsafeName": "SCHEMA2TEST_DISCRIMINATED_UNION", + "safeName": "SCHEMA2TEST_DISCRIMINATED_UNION" }, "pascalCase": { - "unsafeName": "GetExampleResponse", - "safeName": "GetExampleResponse" + "unsafeName": "Schema2TestDiscriminatedUnion", + "safeName": "Schema2TestDiscriminatedUnion" } }, "fernFilepath": { @@ -1168,38 +5382,34 @@ "types": [ { "_type": "named", - "value": "type_:NotFound" - }, - { - "_type": "named", - "value": "type_:Schema1" + "value": "type_:Schema2TestDiscriminatedUnionZero" }, { "_type": "named", - "value": "type_:Schema2" + "value": "type_:Schema2TestDiscriminatedUnionOne" } ] }, - "type_:Schema1": { + "type_:Schema2TestUnionA": { "type": "object", "declaration": { "name": { - "originalName": "Schema1", + "originalName": "Schema2TestUnionA", "camelCase": { - "unsafeName": "schema1", - "safeName": "schema1" + "unsafeName": "schema2TestUnionA", + "safeName": "schema2TestUnionA" }, "snakeCase": { - "unsafeName": "schema1", - "safeName": "schema1" + "unsafeName": "schema2test_union_a", + "safeName": "schema2test_union_a" }, "screamingSnakeCase": { - "unsafeName": "SCHEMA1", - "safeName": "SCHEMA1" + "unsafeName": "SCHEMA2TEST_UNION_A", + "safeName": "SCHEMA2TEST_UNION_A" }, "pascalCase": { - "unsafeName": "Schema1", - "safeName": "Schema1" + "unsafeName": "Schema2TestUnionA", + "safeName": "Schema2TestUnionA" } }, "fernFilepath": { @@ -1212,56 +5422,87 @@ { "name": { "name": { - "originalName": "id", + "originalName": "a", "camelCase": { - "unsafeName": "id", - "safeName": "id" + "unsafeName": "a", + "safeName": "a" }, "snakeCase": { - "unsafeName": "id", - "safeName": "id" + "unsafeName": "a", + "safeName": "a" }, "screamingSnakeCase": { - "unsafeName": "ID", - "safeName": "ID" + "unsafeName": "A", + "safeName": "A" }, "pascalCase": { - "unsafeName": "ID", - "safeName": "ID" + "unsafeName": "A", + "safeName": "A" } }, - "wireValue": "id" + "wireValue": "a" }, "typeReference": { "_type": "optional", "value": { "_type": "primitive", - "value": "INTEGER" + "value": "STRING" } } + } + ] + }, + "type_:Schema2TestUnionB": { + "type": "object", + "declaration": { + "name": { + "originalName": "Schema2TestUnionB", + "camelCase": { + "unsafeName": "schema2TestUnionB", + "safeName": "schema2TestUnionB" + }, + "snakeCase": { + "unsafeName": "schema2test_union_b", + "safeName": "schema2test_union_b" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA2TEST_UNION_B", + "safeName": "SCHEMA2TEST_UNION_B" + }, + "pascalCase": { + "unsafeName": "Schema2TestUnionB", + "safeName": "Schema2TestUnionB" + } }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "properties": [ { "name": { "name": { - "originalName": "name", + "originalName": "b", "camelCase": { - "unsafeName": "name", - "safeName": "name" + "unsafeName": "b", + "safeName": "b" }, "snakeCase": { - "unsafeName": "name", - "safeName": "name" + "unsafeName": "b", + "safeName": "b" }, "screamingSnakeCase": { - "unsafeName": "NAME", - "safeName": "NAME" + "unsafeName": "B", + "safeName": "B" }, "pascalCase": { - "unsafeName": "Name", - "safeName": "Name" + "unsafeName": "B", + "safeName": "B" } }, - "wireValue": "name" + "wireValue": "b" }, "typeReference": { "_type": "optional", @@ -1273,6 +5514,45 @@ } ] }, + "type_:Schema2TestUnion": { + "type": "undiscriminatedUnion", + "declaration": { + "name": { + "originalName": "Schema2TestUnion", + "camelCase": { + "unsafeName": "schema2TestUnion", + "safeName": "schema2TestUnion" + }, + "snakeCase": { + "unsafeName": "schema2test_union", + "safeName": "schema2test_union" + }, + "screamingSnakeCase": { + "unsafeName": "SCHEMA2TEST_UNION", + "safeName": "SCHEMA2TEST_UNION" + }, + "pascalCase": { + "unsafeName": "Schema2TestUnion", + "safeName": "Schema2TestUnion" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "types": [ + { + "_type": "named", + "value": "type_:Schema2TestUnionA" + }, + { + "_type": "named", + "value": "type_:Schema2TestUnionB" + } + ] + }, "type_:Schema2": { "type": "object", "declaration": { @@ -1363,6 +5643,99 @@ "value": "INTEGER" } } + }, + { + "name": { + "name": { + "originalName": "testEnum", + "camelCase": { + "unsafeName": "testEnum", + "safeName": "testEnum" + }, + "snakeCase": { + "unsafeName": "test_enum", + "safeName": "test_enum" + }, + "screamingSnakeCase": { + "unsafeName": "TEST_ENUM", + "safeName": "TEST_ENUM" + }, + "pascalCase": { + "unsafeName": "TestEnum", + "safeName": "TestEnum" + } + }, + "wireValue": "testEnum" + }, + "typeReference": { + "_type": "optional", + "value": { + "_type": "named", + "value": "type_:Schema2TestEnum" + } + } + }, + { + "name": { + "name": { + "originalName": "testDiscriminatedUnion", + "camelCase": { + "unsafeName": "testDiscriminatedUnion", + "safeName": "testDiscriminatedUnion" + }, + "snakeCase": { + "unsafeName": "test_discriminated_union", + "safeName": "test_discriminated_union" + }, + "screamingSnakeCase": { + "unsafeName": "TEST_DISCRIMINATED_UNION", + "safeName": "TEST_DISCRIMINATED_UNION" + }, + "pascalCase": { + "unsafeName": "TestDiscriminatedUnion", + "safeName": "TestDiscriminatedUnion" + } + }, + "wireValue": "testDiscriminatedUnion" + }, + "typeReference": { + "_type": "optional", + "value": { + "_type": "named", + "value": "type_:Schema2TestDiscriminatedUnion" + } + } + }, + { + "name": { + "name": { + "originalName": "testUnion", + "camelCase": { + "unsafeName": "testUnion", + "safeName": "testUnion" + }, + "snakeCase": { + "unsafeName": "test_union", + "safeName": "test_union" + }, + "screamingSnakeCase": { + "unsafeName": "TEST_UNION", + "safeName": "TEST_UNION" + }, + "pascalCase": { + "unsafeName": "TestUnion", + "safeName": "TestUnion" + } + }, + "wireValue": "testUnion" + }, + "typeReference": { + "_type": "optional", + "value": { + "_type": "named", + "value": "type_:Schema2TestUnion" + } + } } ] } @@ -1409,6 +5782,145 @@ "response": { "type": "json" } + }, + "endpoint_.postRoot": { + "auth": null, + "declaration": { + "name": { + "originalName": "postRoot", + "camelCase": { + "unsafeName": "postRoot", + "safeName": "postRoot" + }, + "snakeCase": { + "unsafeName": "post_root", + "safeName": "post_root" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT", + "safeName": "POST_ROOT" + }, + "pascalCase": { + "unsafeName": "PostRoot", + "safeName": "PostRoot" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "location": { + "method": "POST", + "path": "/root" + }, + "request": { + "type": "inlined", + "declaration": { + "name": { + "originalName": "PostRootRequest", + "camelCase": { + "unsafeName": "postRootRequest", + "safeName": "postRootRequest" + }, + "snakeCase": { + "unsafeName": "post_root_request", + "safeName": "post_root_request" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_REQUEST", + "safeName": "POST_ROOT_REQUEST" + }, + "pascalCase": { + "unsafeName": "PostRootRequest", + "safeName": "PostRootRequest" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "pathParameters": [], + "queryParameters": [], + "headers": [], + "body": { + "type": "properties", + "value": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "typeReference": { + "_type": "optional", + "value": { + "_type": "primitive", + "value": "STRING" + } + } + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "typeReference": { + "_type": "optional", + "value": { + "_type": "named", + "value": "type_:PostRootRequestBar" + } + } + } + ] + }, + "metadata": { + "includePathParameters": false, + "onlyPathParameters": false + } + }, + "response": { + "type": "json" + } } } }, @@ -1422,9 +5934,20 @@ "websocket": null, "service": "service_", "types": [ - "type_:NotFound", "type_:GetExampleResponse", + "type_:PostRootRequestBarInnerBar", + "type_:PostRootRequestBar", + "type_:PostRootResponseBarInnerBar", + "type_:PostRootResponseBar", + "type_:PostRootResponse", "type_:Schema1", + "type_:Schema2TestEnum", + "type_:Schema2TestDiscriminatedUnionZero", + "type_:Schema2TestDiscriminatedUnionOne", + "type_:Schema2TestDiscriminatedUnion", + "type_:Schema2TestUnionA", + "type_:Schema2TestUnionB", + "type_:Schema2TestUnion", "type_:Schema2" ], "errors": [], diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions-openapi/names.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions-openapi/names.json index 8d035134f06..d1908fd9347 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions-openapi/names.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions-openapi/names.json @@ -56,7 +56,7 @@ "idempotencyHeaders": [], "types": { "type_telemetry:TelemetryGetTelemetryDataResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TelemetryGetTelemetryDataResponse", @@ -365,7 +365,7 @@ "docs": null }, "type_infra/telemetry:TelemetryData": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TelemetryData", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/alias-extends.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/alias-extends.json index 6a72470de91..ac9a636d466 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/alias-extends.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/alias-extends.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_:AliasType": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "AliasType", @@ -269,7 +269,7 @@ "docs": null }, "type_:Parent": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Parent", @@ -448,7 +448,7 @@ "docs": null }, "type_:Child": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Child", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/alias.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/alias.json index 6825a31adbd..63204f69cd9 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/alias.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/alias.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_:TypeId": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TypeId", @@ -135,7 +135,7 @@ "docs": "An alias for type IDs." }, "type_:Type": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Type", @@ -472,7 +472,7 @@ "docs": "A simple type with just a name." }, "type_:Object": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Object", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/any-auth.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/any-auth.json index 14e2d074123..f0be426650c 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/any-auth.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/any-auth.json @@ -283,7 +283,7 @@ "idempotencyHeaders": [], "types": { "type_auth:TokenResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TokenResponse", @@ -486,7 +486,7 @@ "docs": "An OAuth token response." }, "type_user:User": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "User", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/audiences.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/audiences.json index f50326b5bcb..4f4fa266ad9 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/audiences.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/audiences.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_commons:Imported": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Imported", @@ -134,7 +134,7 @@ "docs": null }, "type_folder-a/service:Response": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Response", @@ -401,7 +401,7 @@ "docs": null }, "type_folder-b/common:Foo": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Foo", @@ -667,7 +667,7 @@ "docs": null }, "type_folder-c/common:FolderCFoo": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "FolderCFoo", @@ -825,7 +825,7 @@ "docs": null }, "type_folder-d/service:Response": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Response", @@ -987,7 +987,7 @@ "docs": null }, "type_foo:ImportingType": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ImportingType", @@ -1169,7 +1169,7 @@ "docs": null }, "type_foo:OptionalString": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "OptionalString", @@ -1284,7 +1284,7 @@ "docs": null }, "type_foo:FilteredType": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "FilteredType", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/basic-auth-environment-variables.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/basic-auth-environment-variables.json index 66f389523b4..3fc28894a15 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/basic-auth-environment-variables.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/basic-auth-environment-variables.json @@ -76,7 +76,7 @@ "idempotencyHeaders": [], "types": { "type_errors:UnauthorizedRequestErrorBody": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UnauthorizedRequestErrorBody", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/basic-auth.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/basic-auth.json index 4ef6230dab3..c77776bbc36 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/basic-auth.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/basic-auth.json @@ -76,7 +76,7 @@ "idempotencyHeaders": [], "types": { "type_errors:UnauthorizedRequestErrorBody": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UnauthorizedRequestErrorBody", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/circular-references-advanced.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/circular-references-advanced.json index 4033c78dbb3..e5d6f46e8d4 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/circular-references-advanced.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/circular-references-advanced.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_:ImportingA": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ImportingA", @@ -182,7 +182,7 @@ "docs": null }, "type_:RootType": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "RootType", @@ -267,7 +267,7 @@ "docs": null }, "type_a:A": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "A", @@ -420,7 +420,7 @@ "docs": null }, "type_ast:ContainerValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ContainerValue", @@ -784,7 +784,7 @@ "docs": null }, "type_ast:PrimitiveValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "PrimitiveValue", @@ -920,7 +920,7 @@ "docs": null }, "type_ast:ObjectValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ObjectValue", @@ -1005,7 +1005,7 @@ "docs": null }, "type_ast:FieldName": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "FieldName", @@ -1108,7 +1108,7 @@ "docs": null }, "type_ast:FieldValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "FieldValue", @@ -1553,7 +1553,7 @@ "docs": null }, "type_ast:ObjectFieldValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ObjectFieldValue", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/circular-references.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/circular-references.json index f6f4edb360f..2f0fbfa7e55 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/circular-references.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/circular-references.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_:ImportingA": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ImportingA", @@ -182,7 +182,7 @@ "docs": null }, "type_:RootType": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "RootType", @@ -267,7 +267,7 @@ "docs": null }, "type_a:A": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "A", @@ -420,7 +420,7 @@ "docs": null }, "type_ast:FieldValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "FieldValue", @@ -865,7 +865,7 @@ "docs": null }, "type_ast:ContainerValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ContainerValue", @@ -1229,7 +1229,7 @@ "docs": null }, "type_ast:PrimitiveValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "PrimitiveValue", @@ -1365,7 +1365,7 @@ "docs": null }, "type_ast:ObjectValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ObjectValue", @@ -1450,7 +1450,7 @@ "docs": null }, "type_ast:JsonLike": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "JsonLike", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/cross-package-type-names.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/cross-package-type-names.json index bf8ebc905e8..c8a90889563 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/cross-package-type-names.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/cross-package-type-names.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_commons:Imported": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Imported", @@ -134,7 +134,7 @@ "docs": null }, "type_folder-a/service:Response": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Response", @@ -401,7 +401,7 @@ "docs": null }, "type_folder-b/common:Foo": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Foo", @@ -667,7 +667,7 @@ "docs": null }, "type_folder-c/common:Foo": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Foo", @@ -825,7 +825,7 @@ "docs": null }, "type_folder-d/service:Response": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Response", @@ -1092,7 +1092,7 @@ "docs": null }, "type_foo:ImportingType": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ImportingType", @@ -1274,7 +1274,7 @@ "docs": null }, "type_foo:OptionalString": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "OptionalString", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/csharp-grpc-proto-exhaustive.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/csharp-grpc-proto-exhaustive.json index 10c071de540..17df1ffeb4a 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/csharp-grpc-proto-exhaustive.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/csharp-grpc-proto-exhaustive.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_:Column": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Column", @@ -316,7 +316,7 @@ "docs": null }, "type_:DeleteResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "DeleteResponse", @@ -396,7 +396,7 @@ "docs": null }, "type_:DescribeResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "DescribeResponse", @@ -675,7 +675,7 @@ "docs": null }, "type_:FetchResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "FetchResponse", @@ -946,7 +946,7 @@ "docs": null }, "type_:IndexedData": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "IndexedData", @@ -1105,7 +1105,7 @@ "docs": null }, "type_:ListElement": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ListElement", @@ -1229,7 +1229,7 @@ "docs": null }, "type_:ListResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ListResponse", @@ -1549,7 +1549,7 @@ "docs": null }, "type_:NamespaceSummary": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "NamespaceSummary", @@ -1669,7 +1669,7 @@ "docs": null }, "type_:Pagination": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Pagination", @@ -1793,7 +1793,7 @@ "docs": null }, "type_:QueryColumn": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "QueryColumn", @@ -2123,7 +2123,7 @@ "docs": null }, "type_:QueryResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "QueryResponse", @@ -2452,7 +2452,7 @@ "docs": null }, "type_:QueryResult": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "QueryResult", @@ -2649,7 +2649,7 @@ "docs": null }, "type_:ScoredColumn": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ScoredColumn", @@ -2979,7 +2979,7 @@ "docs": null }, "type_:UpdateResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UpdateResponse", @@ -3059,7 +3059,7 @@ "docs": null }, "type_:UploadResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UploadResponse", @@ -3179,7 +3179,7 @@ "docs": null }, "type_:Usage": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Usage", @@ -3299,7 +3299,7 @@ "docs": null }, "type_:Metadata": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Metadata", @@ -3427,7 +3427,7 @@ "docs": null }, "type_:MetadataValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "MetadataValue", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/csharp-grpc-proto.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/csharp-grpc-proto.json index bca94419a0b..4ec60b980a0 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/csharp-grpc-proto.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/csharp-grpc-proto.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_:CreateResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "CreateResponse", @@ -178,7 +178,7 @@ "docs": null }, "type_:UserModel": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UserModel", @@ -488,7 +488,7 @@ "docs": null }, "type_:Metadata": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Metadata", @@ -616,7 +616,7 @@ "docs": null }, "type_:MetadataValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "MetadataValue", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/csharp-namespace-conflict.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/csharp-namespace-conflict.json index 1d88767c190..145b6b4b047 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/csharp-namespace-conflict.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/csharp-namespace-conflict.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_a/aa:A": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "A", @@ -156,7 +156,7 @@ "docs": null }, "type_a/aa:B": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "B", @@ -281,7 +281,7 @@ "docs": null }, "type_a/aa:SubTestType": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "SubTestType", @@ -678,7 +678,7 @@ "docs": null }, "type_b:TestType": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestType", @@ -1037,7 +1037,7 @@ "docs": null }, "type_tasktest:Task": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Task", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/custom-auth.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/custom-auth.json index d2968375152..9b03b6f5b3b 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/custom-auth.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/custom-auth.json @@ -71,7 +71,7 @@ "idempotencyHeaders": [], "types": { "type_errors:UnauthorizedRequestErrorBody": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UnauthorizedRequestErrorBody", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/enum.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/enum.json index 4916da181fd..50fb9b41efb 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/enum.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/enum.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_:Operand": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Operand", @@ -252,7 +252,7 @@ "docs": "Tests enum name and value can be\ndifferent." }, "type_:Color": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Color", @@ -399,7 +399,7 @@ "docs": null }, "type_:ColorOrOperand": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ColorOrOperand", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/error-property.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/error-property.json index 4356fdecc08..d1d94cd4563 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/error-property.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/error-property.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_errors:PropertyBasedErrorTestBody": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "PropertyBasedErrorTestBody", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/examples.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/examples.json index 725401050e7..ba151a76422 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/examples.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/examples.json @@ -56,7 +56,7 @@ "idempotencyHeaders": [], "types": { "type_:Type": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Type", @@ -170,7 +170,7 @@ "docs": null }, "type_:Identifier": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Identifier", @@ -352,7 +352,7 @@ "docs": null }, "type_:BasicType": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "BasicType", @@ -450,7 +450,7 @@ "docs": null }, "type_:ComplexType": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ComplexType", @@ -574,7 +574,7 @@ "docs": null }, "type_commons/types:Tag": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Tag", @@ -755,7 +755,7 @@ "docs": null }, "type_commons/types:Metadata": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Metadata", @@ -1612,7 +1612,7 @@ "docs": null }, "type_commons/types:EventInfo": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "EventInfo", @@ -2668,7 +2668,7 @@ "docs": null }, "type_commons/types:Data": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Data", @@ -3025,7 +3025,7 @@ "docs": null }, "type_file/service:Filename": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Filename", @@ -3206,7 +3206,7 @@ "docs": null }, "type_types:MovieId": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "MovieId", @@ -3348,7 +3348,7 @@ "docs": null }, "type_types:Movie": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Movie", @@ -5430,7 +5430,7 @@ "docs": null }, "type_types:CastMember": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "CastMember", @@ -6353,7 +6353,7 @@ "docs": null }, "type_types:Actor": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Actor", @@ -6513,7 +6513,7 @@ "docs": null }, "type_types:Actress": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Actress", @@ -6907,7 +6907,7 @@ "docs": null }, "type_types:StuntDouble": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "StuntDouble", @@ -7067,7 +7067,7 @@ "docs": null }, "type_types:ExtendedMovie": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ExtendedMovie", @@ -9143,7 +9143,7 @@ "docs": null }, "type_types:Moment": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Moment", @@ -9641,7 +9641,7 @@ "docs": null }, "type_types:File": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "File", @@ -10268,7 +10268,7 @@ "docs": null }, "type_types:Directory": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Directory", @@ -12295,7 +12295,7 @@ "docs": null }, "type_types:Node": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Node", @@ -14651,7 +14651,7 @@ "docs": null }, "type_types:Tree": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Tree", @@ -15507,7 +15507,7 @@ "docs": null }, "type_types:Metadata": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Metadata", @@ -15935,7 +15935,7 @@ "docs": null }, "type_types:Exception": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Exception", @@ -16556,7 +16556,7 @@ "docs": null }, "type_types:ExceptionInfo": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ExceptionInfo", @@ -17089,7 +17089,7 @@ "docs": null }, "type_types:MigrationStatus": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "MigrationStatus", @@ -17348,7 +17348,7 @@ "docs": null }, "type_types:Migration": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Migration", @@ -17867,7 +17867,7 @@ "docs": null }, "type_types:Request": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Request", @@ -18109,7 +18109,7 @@ "docs": null }, "type_types:Response": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Response", @@ -19199,7 +19199,7 @@ "docs": null }, "type_types:ResponseType": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ResponseType", @@ -19345,7 +19345,7 @@ "docs": null }, "type_types:Test": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Test", @@ -19743,7 +19743,7 @@ "docs": null }, "type_types:Entity": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Entity", @@ -20243,7 +20243,7 @@ "docs": null }, "type_types:BigEntity": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "BigEntity", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/exhaustive.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/exhaustive.json index 67aae6ca367..6665c6ccad3 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/exhaustive.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/exhaustive.json @@ -56,7 +56,7 @@ "idempotencyHeaders": [], "types": { "type_general-errors:BadObjectRequestInfo": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "BadObjectRequestInfo", @@ -179,7 +179,7 @@ "docs": null }, "type_types/enum:WeatherReport": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "WeatherReport", @@ -406,7 +406,7 @@ "docs": null }, "type_types/object:ObjectWithOptionalField": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ObjectWithOptionalField", @@ -1091,7 +1091,7 @@ "docs": null }, "type_types/object:ObjectWithRequiredField": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ObjectWithRequiredField", @@ -1253,7 +1253,7 @@ "docs": null }, "type_types/object:ObjectWithMapOfMap": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ObjectWithMapOfMap", @@ -1449,7 +1449,7 @@ "docs": null }, "type_types/object:NestedObjectWithOptionalField": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "NestedObjectWithOptionalField", @@ -1758,7 +1758,7 @@ "docs": null }, "type_types/object:NestedObjectWithRequiredField": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "NestedObjectWithRequiredField", @@ -2055,7 +2055,7 @@ "docs": null }, "type_types/object:DoubleOptional": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "DoubleOptional", @@ -2321,7 +2321,7 @@ "docs": null }, "type_types/object:OptionalAlias": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "OptionalAlias", @@ -2475,7 +2475,7 @@ "docs": null }, "type_types/union:Animal": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Animal", @@ -2888,7 +2888,7 @@ "docs": null }, "type_types/union:Dog": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Dog", @@ -3083,7 +3083,7 @@ "docs": null }, "type_types/union:Cat": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Cat", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/extends.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/extends.json index 9ed08aa8208..25768aa2aaf 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/extends.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/extends.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_:ExampleType": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ExampleType", @@ -342,7 +342,7 @@ "docs": null }, "type_:NestedType": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "NestedType", @@ -755,7 +755,7 @@ "docs": null }, "type_:Docs": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Docs", @@ -934,7 +934,7 @@ "docs": null }, "type_:JSON": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "JSON", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/extra-properties.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/extra-properties.json index 33b7a218680..c1f525e44ff 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/extra-properties.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/extra-properties.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_:Failure": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Failure", @@ -115,7 +115,7 @@ "docs": null }, "type_user:User": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "User", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/file-upload.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/file-upload.json index 0b92cb3d5d7..1d40ee2c3a3 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/file-upload.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/file-upload.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_service:Id": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Id", @@ -134,7 +134,7 @@ "docs": null }, "type_service:MyObject": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "MyObject", @@ -257,7 +257,7 @@ "docs": null }, "type_service:ObjectType": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ObjectType", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/folders.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/folders.json index 4e2a50b407f..a603d12c68a 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/folders.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/folders.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_a/d/types:Foo": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Foo", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/go-content-type.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/go-content-type.json index 1a3a23f1e69..d11d4ace6f9 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/go-content-type.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/go-content-type.json @@ -56,7 +56,7 @@ "idempotencyHeaders": [], "types": { "type_imdb:CreateMovieRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "CreateMovieRequest", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/idempotency-headers.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/idempotency-headers.json index 4af0ff377c8..79b08c02edf 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/idempotency-headers.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/idempotency-headers.json @@ -133,7 +133,7 @@ ], "types": { "type_payment:Currency": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Currency", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/imdb.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/imdb.json index 4e8797731df..dc1c1a4ec2e 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/imdb.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/imdb.json @@ -56,7 +56,7 @@ "idempotencyHeaders": [], "types": { "type_imdb:MovieId": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "MovieId", @@ -159,7 +159,7 @@ "docs": null }, "type_imdb:Movie": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Movie", @@ -415,7 +415,7 @@ "docs": null }, "type_imdb:CreateMovieRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "CreateMovieRequest", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/inline-types.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/inline-types.json new file mode 100644 index 00000000000..47a24189178 --- /dev/null +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/inline-types.json @@ -0,0 +1,3316 @@ +{ + "fdrApiDefinitionId": null, + "apiVersion": null, + "apiName": { + "originalName": "object", + "camelCase": { + "unsafeName": "object", + "safeName": "object" + }, + "snakeCase": { + "unsafeName": "object", + "safeName": "object" + }, + "screamingSnakeCase": { + "unsafeName": "OBJECT", + "safeName": "OBJECT" + }, + "pascalCase": { + "unsafeName": "Object", + "safeName": "Object" + } + }, + "apiDisplayName": null, + "apiDocs": null, + "auth": { + "requirement": "ALL", + "schemes": [], + "docs": null + }, + "headers": [], + "idempotencyHeaders": [], + "types": { + "type_:RootType1": { + "inline": null, + "name": { + "name": { + "originalName": "RootType1", + "camelCase": { + "unsafeName": "rootType1", + "safeName": "rootType1" + }, + "snakeCase": { + "unsafeName": "root_type1", + "safeName": "root_type1" + }, + "screamingSnakeCase": { + "unsafeName": "ROOT_TYPE1", + "safeName": "ROOT_TYPE1" + }, + "pascalCase": { + "unsafeName": "RootType1", + "safeName": "RootType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:RootType1" + }, + "shape": { + "_type": "object", + "extends": [], + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "valueType": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + }, + "availability": null, + "docs": null + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "valueType": { + "_type": "named", + "name": { + "originalName": "InlineType1", + "camelCase": { + "unsafeName": "inlineType1", + "safeName": "inlineType1" + }, + "snakeCase": { + "unsafeName": "inline_type1", + "safeName": "inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_TYPE1", + "safeName": "INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "InlineType1", + "safeName": "InlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:InlineType1", + "default": null, + "inline": null + }, + "availability": null, + "docs": null + } + ], + "extra-properties": false, + "extendedProperties": [] + }, + "referencedTypes": [ + "type_:InlineType1", + "type_:NestedInlineType1", + "type_:InlineEnum" + ], + "encoding": { + "json": {}, + "proto": null + }, + "source": null, + "userProvidedExamples": [], + "autogeneratedExamples": [], + "availability": null, + "docs": null + }, + "type_:InlineType1": { + "inline": true, + "name": { + "name": { + "originalName": "InlineType1", + "camelCase": { + "unsafeName": "inlineType1", + "safeName": "inlineType1" + }, + "snakeCase": { + "unsafeName": "inline_type1", + "safeName": "inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_TYPE1", + "safeName": "INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "InlineType1", + "safeName": "InlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:InlineType1" + }, + "shape": { + "_type": "object", + "extends": [], + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "valueType": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + }, + "availability": null, + "docs": null + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "valueType": { + "_type": "named", + "name": { + "originalName": "NestedInlineType1", + "camelCase": { + "unsafeName": "nestedInlineType1", + "safeName": "nestedInlineType1" + }, + "snakeCase": { + "unsafeName": "nested_inline_type1", + "safeName": "nested_inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "NESTED_INLINE_TYPE1", + "safeName": "NESTED_INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "NestedInlineType1", + "safeName": "NestedInlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:NestedInlineType1", + "default": null, + "inline": null + }, + "availability": null, + "docs": null + } + ], + "extra-properties": false, + "extendedProperties": [] + }, + "referencedTypes": [ + "type_:NestedInlineType1", + "type_:InlineEnum" + ], + "encoding": { + "json": {}, + "proto": null + }, + "source": null, + "userProvidedExamples": [], + "autogeneratedExamples": [], + "availability": null, + "docs": null + }, + "type_:InlineType2": { + "inline": true, + "name": { + "name": { + "originalName": "InlineType2", + "camelCase": { + "unsafeName": "inlineType2", + "safeName": "inlineType2" + }, + "snakeCase": { + "unsafeName": "inline_type2", + "safeName": "inline_type2" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_TYPE2", + "safeName": "INLINE_TYPE2" + }, + "pascalCase": { + "unsafeName": "InlineType2", + "safeName": "InlineType2" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:InlineType2" + }, + "shape": { + "_type": "object", + "extends": [], + "properties": [ + { + "name": { + "name": { + "originalName": "baz", + "camelCase": { + "unsafeName": "baz", + "safeName": "baz" + }, + "snakeCase": { + "unsafeName": "baz", + "safeName": "baz" + }, + "screamingSnakeCase": { + "unsafeName": "BAZ", + "safeName": "BAZ" + }, + "pascalCase": { + "unsafeName": "Baz", + "safeName": "Baz" + } + }, + "wireValue": "baz" + }, + "valueType": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + }, + "availability": null, + "docs": null + } + ], + "extra-properties": false, + "extendedProperties": [] + }, + "referencedTypes": [], + "encoding": { + "json": {}, + "proto": null + }, + "source": null, + "userProvidedExamples": [], + "autogeneratedExamples": [], + "availability": null, + "docs": null + }, + "type_:NestedInlineType1": { + "inline": true, + "name": { + "name": { + "originalName": "NestedInlineType1", + "camelCase": { + "unsafeName": "nestedInlineType1", + "safeName": "nestedInlineType1" + }, + "snakeCase": { + "unsafeName": "nested_inline_type1", + "safeName": "nested_inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "NESTED_INLINE_TYPE1", + "safeName": "NESTED_INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "NestedInlineType1", + "safeName": "NestedInlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:NestedInlineType1" + }, + "shape": { + "_type": "object", + "extends": [], + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "valueType": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + }, + "availability": null, + "docs": null + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "valueType": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + }, + "availability": null, + "docs": null + }, + { + "name": { + "name": { + "originalName": "myEnum", + "camelCase": { + "unsafeName": "myEnum", + "safeName": "myEnum" + }, + "snakeCase": { + "unsafeName": "my_enum", + "safeName": "my_enum" + }, + "screamingSnakeCase": { + "unsafeName": "MY_ENUM", + "safeName": "MY_ENUM" + }, + "pascalCase": { + "unsafeName": "MyEnum", + "safeName": "MyEnum" + } + }, + "wireValue": "myEnum" + }, + "valueType": { + "_type": "named", + "name": { + "originalName": "InlineEnum", + "camelCase": { + "unsafeName": "inlineEnum", + "safeName": "inlineEnum" + }, + "snakeCase": { + "unsafeName": "inline_enum", + "safeName": "inline_enum" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_ENUM", + "safeName": "INLINE_ENUM" + }, + "pascalCase": { + "unsafeName": "InlineEnum", + "safeName": "InlineEnum" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:InlineEnum", + "default": null, + "inline": null + }, + "availability": null, + "docs": null + } + ], + "extra-properties": false, + "extendedProperties": [] + }, + "referencedTypes": [ + "type_:InlineEnum" + ], + "encoding": { + "json": {}, + "proto": null + }, + "source": null, + "userProvidedExamples": [], + "autogeneratedExamples": [], + "availability": null, + "docs": null + }, + "type_:InlinedDiscriminatedUnion1": { + "inline": true, + "name": { + "name": { + "originalName": "InlinedDiscriminatedUnion1", + "camelCase": { + "unsafeName": "inlinedDiscriminatedUnion1", + "safeName": "inlinedDiscriminatedUnion1" + }, + "snakeCase": { + "unsafeName": "inlined_discriminated_union1", + "safeName": "inlined_discriminated_union1" + }, + "screamingSnakeCase": { + "unsafeName": "INLINED_DISCRIMINATED_UNION1", + "safeName": "INLINED_DISCRIMINATED_UNION1" + }, + "pascalCase": { + "unsafeName": "InlinedDiscriminatedUnion1", + "safeName": "InlinedDiscriminatedUnion1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:InlinedDiscriminatedUnion1" + }, + "shape": { + "_type": "union", + "discriminant": { + "name": { + "originalName": "type", + "camelCase": { + "unsafeName": "type", + "safeName": "type" + }, + "snakeCase": { + "unsafeName": "type", + "safeName": "type" + }, + "screamingSnakeCase": { + "unsafeName": "TYPE", + "safeName": "TYPE" + }, + "pascalCase": { + "unsafeName": "Type", + "safeName": "Type" + } + }, + "wireValue": "type" + }, + "extends": [], + "baseProperties": [], + "types": [ + { + "discriminantValue": { + "name": { + "originalName": "type1", + "camelCase": { + "unsafeName": "type1", + "safeName": "type1" + }, + "snakeCase": { + "unsafeName": "type1", + "safeName": "type1" + }, + "screamingSnakeCase": { + "unsafeName": "TYPE1", + "safeName": "TYPE1" + }, + "pascalCase": { + "unsafeName": "Type1", + "safeName": "Type1" + } + }, + "wireValue": "type1" + }, + "shape": { + "_type": "samePropertiesAsObject", + "name": { + "originalName": "InlineType1", + "camelCase": { + "unsafeName": "inlineType1", + "safeName": "inlineType1" + }, + "snakeCase": { + "unsafeName": "inline_type1", + "safeName": "inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_TYPE1", + "safeName": "INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "InlineType1", + "safeName": "InlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:InlineType1" + }, + "displayName": null, + "availability": null, + "docs": null + }, + { + "discriminantValue": { + "name": { + "originalName": "type2", + "camelCase": { + "unsafeName": "type2", + "safeName": "type2" + }, + "snakeCase": { + "unsafeName": "type2", + "safeName": "type2" + }, + "screamingSnakeCase": { + "unsafeName": "TYPE2", + "safeName": "TYPE2" + }, + "pascalCase": { + "unsafeName": "Type2", + "safeName": "Type2" + } + }, + "wireValue": "type2" + }, + "shape": { + "_type": "samePropertiesAsObject", + "name": { + "originalName": "InlineType2", + "camelCase": { + "unsafeName": "inlineType2", + "safeName": "inlineType2" + }, + "snakeCase": { + "unsafeName": "inline_type2", + "safeName": "inline_type2" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_TYPE2", + "safeName": "INLINE_TYPE2" + }, + "pascalCase": { + "unsafeName": "InlineType2", + "safeName": "InlineType2" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:InlineType2" + }, + "displayName": null, + "availability": null, + "docs": null + } + ] + }, + "referencedTypes": [ + "type_:InlineType1", + "type_:NestedInlineType1", + "type_:InlineEnum", + "type_:InlineType2" + ], + "encoding": { + "json": {}, + "proto": null + }, + "source": null, + "userProvidedExamples": [], + "autogeneratedExamples": [], + "availability": null, + "docs": null + }, + "type_:InlinedUndiscriminatedUnion1": { + "inline": true, + "name": { + "name": { + "originalName": "InlinedUndiscriminatedUnion1", + "camelCase": { + "unsafeName": "inlinedUndiscriminatedUnion1", + "safeName": "inlinedUndiscriminatedUnion1" + }, + "snakeCase": { + "unsafeName": "inlined_undiscriminated_union1", + "safeName": "inlined_undiscriminated_union1" + }, + "screamingSnakeCase": { + "unsafeName": "INLINED_UNDISCRIMINATED_UNION1", + "safeName": "INLINED_UNDISCRIMINATED_UNION1" + }, + "pascalCase": { + "unsafeName": "InlinedUndiscriminatedUnion1", + "safeName": "InlinedUndiscriminatedUnion1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:InlinedUndiscriminatedUnion1" + }, + "shape": { + "_type": "undiscriminatedUnion", + "members": [ + { + "type": { + "_type": "named", + "name": { + "originalName": "InlineType1", + "camelCase": { + "unsafeName": "inlineType1", + "safeName": "inlineType1" + }, + "snakeCase": { + "unsafeName": "inline_type1", + "safeName": "inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_TYPE1", + "safeName": "INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "InlineType1", + "safeName": "InlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:InlineType1", + "default": null, + "inline": null + }, + "docs": null + }, + { + "type": { + "_type": "named", + "name": { + "originalName": "InlineType2", + "camelCase": { + "unsafeName": "inlineType2", + "safeName": "inlineType2" + }, + "snakeCase": { + "unsafeName": "inline_type2", + "safeName": "inline_type2" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_TYPE2", + "safeName": "INLINE_TYPE2" + }, + "pascalCase": { + "unsafeName": "InlineType2", + "safeName": "InlineType2" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:InlineType2", + "default": null, + "inline": null + }, + "docs": null + } + ] + }, + "referencedTypes": [ + "type_:InlineType1", + "type_:NestedInlineType1", + "type_:InlineEnum", + "type_:InlineType2" + ], + "encoding": { + "json": {}, + "proto": null + }, + "source": null, + "userProvidedExamples": [], + "autogeneratedExamples": [], + "availability": null, + "docs": null + }, + "type_:InlineEnum": { + "inline": true, + "name": { + "name": { + "originalName": "InlineEnum", + "camelCase": { + "unsafeName": "inlineEnum", + "safeName": "inlineEnum" + }, + "snakeCase": { + "unsafeName": "inline_enum", + "safeName": "inline_enum" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_ENUM", + "safeName": "INLINE_ENUM" + }, + "pascalCase": { + "unsafeName": "InlineEnum", + "safeName": "InlineEnum" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:InlineEnum" + }, + "shape": { + "_type": "enum", + "default": null, + "values": [ + { + "name": { + "name": { + "originalName": "SUNNY", + "camelCase": { + "unsafeName": "sunny", + "safeName": "sunny" + }, + "snakeCase": { + "unsafeName": "sunny", + "safeName": "sunny" + }, + "screamingSnakeCase": { + "unsafeName": "SUNNY", + "safeName": "SUNNY" + }, + "pascalCase": { + "unsafeName": "Sunny", + "safeName": "Sunny" + } + }, + "wireValue": "SUNNY" + }, + "availability": null, + "docs": null + }, + { + "name": { + "name": { + "originalName": "CLOUDY", + "camelCase": { + "unsafeName": "cloudy", + "safeName": "cloudy" + }, + "snakeCase": { + "unsafeName": "cloudy", + "safeName": "cloudy" + }, + "screamingSnakeCase": { + "unsafeName": "CLOUDY", + "safeName": "CLOUDY" + }, + "pascalCase": { + "unsafeName": "Cloudy", + "safeName": "Cloudy" + } + }, + "wireValue": "CLOUDY" + }, + "availability": null, + "docs": null + }, + { + "name": { + "name": { + "originalName": "RAINING", + "camelCase": { + "unsafeName": "raining", + "safeName": "raining" + }, + "snakeCase": { + "unsafeName": "raining", + "safeName": "raining" + }, + "screamingSnakeCase": { + "unsafeName": "RAINING", + "safeName": "RAINING" + }, + "pascalCase": { + "unsafeName": "Raining", + "safeName": "Raining" + } + }, + "wireValue": "RAINING" + }, + "availability": null, + "docs": null + }, + { + "name": { + "name": { + "originalName": "SNOWING", + "camelCase": { + "unsafeName": "snowing", + "safeName": "snowing" + }, + "snakeCase": { + "unsafeName": "snowing", + "safeName": "snowing" + }, + "screamingSnakeCase": { + "unsafeName": "SNOWING", + "safeName": "SNOWING" + }, + "pascalCase": { + "unsafeName": "Snowing", + "safeName": "Snowing" + } + }, + "wireValue": "SNOWING" + }, + "availability": null, + "docs": null + } + ] + }, + "referencedTypes": [], + "encoding": { + "json": {}, + "proto": null + }, + "source": null, + "userProvidedExamples": [], + "autogeneratedExamples": [], + "availability": null, + "docs": null + } + }, + "errors": {}, + "services": { + "service_": { + "availability": null, + "name": { + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "displayName": null, + "basePath": { + "head": "/root", + "parts": [] + }, + "headers": [], + "pathParameters": [], + "encoding": { + "json": {}, + "proto": null + }, + "transport": { + "type": "http" + }, + "endpoints": [ + { + "id": "endpoint_.getRoot", + "name": { + "originalName": "getRoot", + "camelCase": { + "unsafeName": "getRoot", + "safeName": "getRoot" + }, + "snakeCase": { + "unsafeName": "get_root", + "safeName": "get_root" + }, + "screamingSnakeCase": { + "unsafeName": "GET_ROOT", + "safeName": "GET_ROOT" + }, + "pascalCase": { + "unsafeName": "GetRoot", + "safeName": "GetRoot" + } + }, + "displayName": null, + "auth": false, + "idempotent": false, + "baseUrl": null, + "method": "POST", + "basePath": null, + "path": { + "head": "/root", + "parts": [] + }, + "fullPath": { + "head": "/root/root", + "parts": [] + }, + "pathParameters": [], + "allPathParameters": [], + "queryParameters": [], + "headers": [], + "requestBody": { + "type": "inlinedRequestBody", + "name": { + "originalName": "PostRootRequest", + "camelCase": { + "unsafeName": "postRootRequest", + "safeName": "postRootRequest" + }, + "snakeCase": { + "unsafeName": "post_root_request", + "safeName": "post_root_request" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_REQUEST", + "safeName": "POST_ROOT_REQUEST" + }, + "pascalCase": { + "unsafeName": "PostRootRequest", + "safeName": "PostRootRequest" + } + }, + "extends": [], + "contentType": "application/json", + "properties": [ + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "valueType": { + "_type": "named", + "name": { + "originalName": "InlineType1", + "camelCase": { + "unsafeName": "inlineType1", + "safeName": "inlineType1" + }, + "snakeCase": { + "unsafeName": "inline_type1", + "safeName": "inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_TYPE1", + "safeName": "INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "InlineType1", + "safeName": "InlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:InlineType1", + "default": null, + "inline": null + }, + "availability": null, + "docs": null + }, + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "valueType": { + "_type": "primitive", + "primitive": { + "v1": "STRING", + "v2": { + "type": "string", + "default": null, + "validation": null + } + } + }, + "availability": null, + "docs": null + } + ], + "extra-properties": false, + "extendedProperties": [], + "docs": null + }, + "sdkRequest": { + "shape": { + "type": "wrapper", + "wrapperName": { + "originalName": "PostRootRequest", + "camelCase": { + "unsafeName": "postRootRequest", + "safeName": "postRootRequest" + }, + "snakeCase": { + "unsafeName": "post_root_request", + "safeName": "post_root_request" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_REQUEST", + "safeName": "POST_ROOT_REQUEST" + }, + "pascalCase": { + "unsafeName": "PostRootRequest", + "safeName": "PostRootRequest" + } + }, + "bodyKey": { + "originalName": "body", + "camelCase": { + "unsafeName": "body", + "safeName": "body" + }, + "snakeCase": { + "unsafeName": "body", + "safeName": "body" + }, + "screamingSnakeCase": { + "unsafeName": "BODY", + "safeName": "BODY" + }, + "pascalCase": { + "unsafeName": "Body", + "safeName": "Body" + } + }, + "includePathParameters": false, + "onlyPathParameters": false + }, + "requestParameterName": { + "originalName": "request", + "camelCase": { + "unsafeName": "request", + "safeName": "request" + }, + "snakeCase": { + "unsafeName": "request", + "safeName": "request" + }, + "screamingSnakeCase": { + "unsafeName": "REQUEST", + "safeName": "REQUEST" + }, + "pascalCase": { + "unsafeName": "Request", + "safeName": "Request" + } + }, + "streamParameter": null + }, + "response": { + "body": { + "type": "json", + "value": { + "type": "response", + "responseBodyType": { + "_type": "named", + "name": { + "originalName": "RootType1", + "camelCase": { + "unsafeName": "rootType1", + "safeName": "rootType1" + }, + "snakeCase": { + "unsafeName": "root_type1", + "safeName": "root_type1" + }, + "screamingSnakeCase": { + "unsafeName": "ROOT_TYPE1", + "safeName": "ROOT_TYPE1" + }, + "pascalCase": { + "unsafeName": "RootType1", + "safeName": "RootType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:RootType1", + "default": null, + "inline": null + }, + "docs": null + } + }, + "status-code": null + }, + "errors": [], + "userSpecifiedExamples": [], + "autogeneratedExamples": [ + { + "example": { + "id": "9cd41e603ec7775a338b95cab82902d42d7df333", + "url": "/root/root", + "name": null, + "endpointHeaders": [], + "endpointPathParameters": [], + "queryParameters": [], + "servicePathParameters": [], + "serviceHeaders": [], + "rootPathParameters": [], + "request": { + "type": "inlinedRequestBody", + "properties": [ + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "originalTypeDeclaration": null, + "value": { + "shape": { + "type": "named", + "shape": { + "type": "object", + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "originalTypeDeclaration": { + "name": { + "originalName": "InlineType1", + "camelCase": { + "unsafeName": "inlineType1", + "safeName": "inlineType1" + }, + "snakeCase": { + "unsafeName": "inline_type1", + "safeName": "inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_TYPE1", + "safeName": "INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "InlineType1", + "safeName": "InlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:InlineType1" + }, + "value": { + "shape": { + "type": "primitive", + "primitive": { + "type": "string", + "string": { + "original": "foo" + } + } + }, + "jsonExample": "foo" + } + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "originalTypeDeclaration": { + "name": { + "originalName": "InlineType1", + "camelCase": { + "unsafeName": "inlineType1", + "safeName": "inlineType1" + }, + "snakeCase": { + "unsafeName": "inline_type1", + "safeName": "inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_TYPE1", + "safeName": "INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "InlineType1", + "safeName": "InlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:InlineType1" + }, + "value": { + "shape": { + "type": "named", + "shape": { + "type": "object", + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "originalTypeDeclaration": { + "name": { + "originalName": "NestedInlineType1", + "camelCase": { + "unsafeName": "nestedInlineType1", + "safeName": "nestedInlineType1" + }, + "snakeCase": { + "unsafeName": "nested_inline_type1", + "safeName": "nested_inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "NESTED_INLINE_TYPE1", + "safeName": "NESTED_INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "NestedInlineType1", + "safeName": "NestedInlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:NestedInlineType1" + }, + "value": { + "shape": { + "type": "primitive", + "primitive": { + "type": "string", + "string": { + "original": "foo" + } + } + }, + "jsonExample": "foo" + } + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "originalTypeDeclaration": { + "name": { + "originalName": "NestedInlineType1", + "camelCase": { + "unsafeName": "nestedInlineType1", + "safeName": "nestedInlineType1" + }, + "snakeCase": { + "unsafeName": "nested_inline_type1", + "safeName": "nested_inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "NESTED_INLINE_TYPE1", + "safeName": "NESTED_INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "NestedInlineType1", + "safeName": "NestedInlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:NestedInlineType1" + }, + "value": { + "shape": { + "type": "primitive", + "primitive": { + "type": "string", + "string": { + "original": "bar" + } + } + }, + "jsonExample": "bar" + } + }, + { + "name": { + "name": { + "originalName": "myEnum", + "camelCase": { + "unsafeName": "myEnum", + "safeName": "myEnum" + }, + "snakeCase": { + "unsafeName": "my_enum", + "safeName": "my_enum" + }, + "screamingSnakeCase": { + "unsafeName": "MY_ENUM", + "safeName": "MY_ENUM" + }, + "pascalCase": { + "unsafeName": "MyEnum", + "safeName": "MyEnum" + } + }, + "wireValue": "myEnum" + }, + "originalTypeDeclaration": { + "name": { + "originalName": "NestedInlineType1", + "camelCase": { + "unsafeName": "nestedInlineType1", + "safeName": "nestedInlineType1" + }, + "snakeCase": { + "unsafeName": "nested_inline_type1", + "safeName": "nested_inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "NESTED_INLINE_TYPE1", + "safeName": "NESTED_INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "NestedInlineType1", + "safeName": "NestedInlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:NestedInlineType1" + }, + "value": { + "shape": { + "type": "named", + "shape": { + "type": "enum", + "value": { + "name": { + "originalName": "SUNNY", + "camelCase": { + "unsafeName": "sunny", + "safeName": "sunny" + }, + "snakeCase": { + "unsafeName": "sunny", + "safeName": "sunny" + }, + "screamingSnakeCase": { + "unsafeName": "SUNNY", + "safeName": "SUNNY" + }, + "pascalCase": { + "unsafeName": "Sunny", + "safeName": "Sunny" + } + }, + "wireValue": "SUNNY" + } + }, + "typeName": { + "name": { + "originalName": "InlineEnum", + "camelCase": { + "unsafeName": "inlineEnum", + "safeName": "inlineEnum" + }, + "snakeCase": { + "unsafeName": "inline_enum", + "safeName": "inline_enum" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_ENUM", + "safeName": "INLINE_ENUM" + }, + "pascalCase": { + "unsafeName": "InlineEnum", + "safeName": "InlineEnum" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:InlineEnum" + } + }, + "jsonExample": "SUNNY" + } + } + ] + }, + "typeName": { + "name": { + "originalName": "NestedInlineType1", + "camelCase": { + "unsafeName": "nestedInlineType1", + "safeName": "nestedInlineType1" + }, + "snakeCase": { + "unsafeName": "nested_inline_type1", + "safeName": "nested_inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "NESTED_INLINE_TYPE1", + "safeName": "NESTED_INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "NestedInlineType1", + "safeName": "NestedInlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:NestedInlineType1" + } + }, + "jsonExample": { + "foo": "foo", + "bar": "bar", + "myEnum": "SUNNY" + } + } + } + ] + }, + "typeName": { + "name": { + "originalName": "InlineType1", + "camelCase": { + "unsafeName": "inlineType1", + "safeName": "inlineType1" + }, + "snakeCase": { + "unsafeName": "inline_type1", + "safeName": "inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_TYPE1", + "safeName": "INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "InlineType1", + "safeName": "InlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:InlineType1" + } + }, + "jsonExample": { + "foo": "foo", + "bar": { + "foo": "foo", + "bar": "bar", + "myEnum": "SUNNY" + } + } + } + }, + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "originalTypeDeclaration": null, + "value": { + "shape": { + "type": "primitive", + "primitive": { + "type": "string", + "string": { + "original": "foo" + } + } + }, + "jsonExample": "foo" + } + } + ], + "jsonExample": { + "bar": { + "foo": "foo", + "bar": { + "foo": "foo", + "bar": "bar", + "myEnum": "SUNNY" + } + }, + "foo": "foo" + } + }, + "response": { + "type": "ok", + "value": { + "type": "body", + "value": { + "shape": { + "type": "named", + "shape": { + "type": "object", + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "originalTypeDeclaration": { + "name": { + "originalName": "RootType1", + "camelCase": { + "unsafeName": "rootType1", + "safeName": "rootType1" + }, + "snakeCase": { + "unsafeName": "root_type1", + "safeName": "root_type1" + }, + "screamingSnakeCase": { + "unsafeName": "ROOT_TYPE1", + "safeName": "ROOT_TYPE1" + }, + "pascalCase": { + "unsafeName": "RootType1", + "safeName": "RootType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:RootType1" + }, + "value": { + "shape": { + "type": "primitive", + "primitive": { + "type": "string", + "string": { + "original": "foo" + } + } + }, + "jsonExample": "foo" + } + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "originalTypeDeclaration": { + "name": { + "originalName": "RootType1", + "camelCase": { + "unsafeName": "rootType1", + "safeName": "rootType1" + }, + "snakeCase": { + "unsafeName": "root_type1", + "safeName": "root_type1" + }, + "screamingSnakeCase": { + "unsafeName": "ROOT_TYPE1", + "safeName": "ROOT_TYPE1" + }, + "pascalCase": { + "unsafeName": "RootType1", + "safeName": "RootType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:RootType1" + }, + "value": { + "shape": { + "type": "named", + "shape": { + "type": "object", + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "originalTypeDeclaration": { + "name": { + "originalName": "InlineType1", + "camelCase": { + "unsafeName": "inlineType1", + "safeName": "inlineType1" + }, + "snakeCase": { + "unsafeName": "inline_type1", + "safeName": "inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_TYPE1", + "safeName": "INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "InlineType1", + "safeName": "InlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:InlineType1" + }, + "value": { + "shape": { + "type": "primitive", + "primitive": { + "type": "string", + "string": { + "original": "foo" + } + } + }, + "jsonExample": "foo" + } + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "originalTypeDeclaration": { + "name": { + "originalName": "InlineType1", + "camelCase": { + "unsafeName": "inlineType1", + "safeName": "inlineType1" + }, + "snakeCase": { + "unsafeName": "inline_type1", + "safeName": "inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_TYPE1", + "safeName": "INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "InlineType1", + "safeName": "InlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:InlineType1" + }, + "value": { + "shape": { + "type": "named", + "shape": { + "type": "object", + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "originalTypeDeclaration": { + "name": { + "originalName": "NestedInlineType1", + "camelCase": { + "unsafeName": "nestedInlineType1", + "safeName": "nestedInlineType1" + }, + "snakeCase": { + "unsafeName": "nested_inline_type1", + "safeName": "nested_inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "NESTED_INLINE_TYPE1", + "safeName": "NESTED_INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "NestedInlineType1", + "safeName": "NestedInlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:NestedInlineType1" + }, + "value": { + "shape": { + "type": "primitive", + "primitive": { + "type": "string", + "string": { + "original": "foo" + } + } + }, + "jsonExample": "foo" + } + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "originalTypeDeclaration": { + "name": { + "originalName": "NestedInlineType1", + "camelCase": { + "unsafeName": "nestedInlineType1", + "safeName": "nestedInlineType1" + }, + "snakeCase": { + "unsafeName": "nested_inline_type1", + "safeName": "nested_inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "NESTED_INLINE_TYPE1", + "safeName": "NESTED_INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "NestedInlineType1", + "safeName": "NestedInlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:NestedInlineType1" + }, + "value": { + "shape": { + "type": "primitive", + "primitive": { + "type": "string", + "string": { + "original": "bar" + } + } + }, + "jsonExample": "bar" + } + }, + { + "name": { + "name": { + "originalName": "myEnum", + "camelCase": { + "unsafeName": "myEnum", + "safeName": "myEnum" + }, + "snakeCase": { + "unsafeName": "my_enum", + "safeName": "my_enum" + }, + "screamingSnakeCase": { + "unsafeName": "MY_ENUM", + "safeName": "MY_ENUM" + }, + "pascalCase": { + "unsafeName": "MyEnum", + "safeName": "MyEnum" + } + }, + "wireValue": "myEnum" + }, + "originalTypeDeclaration": { + "name": { + "originalName": "NestedInlineType1", + "camelCase": { + "unsafeName": "nestedInlineType1", + "safeName": "nestedInlineType1" + }, + "snakeCase": { + "unsafeName": "nested_inline_type1", + "safeName": "nested_inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "NESTED_INLINE_TYPE1", + "safeName": "NESTED_INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "NestedInlineType1", + "safeName": "NestedInlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:NestedInlineType1" + }, + "value": { + "shape": { + "type": "named", + "shape": { + "type": "enum", + "value": { + "name": { + "originalName": "SUNNY", + "camelCase": { + "unsafeName": "sunny", + "safeName": "sunny" + }, + "snakeCase": { + "unsafeName": "sunny", + "safeName": "sunny" + }, + "screamingSnakeCase": { + "unsafeName": "SUNNY", + "safeName": "SUNNY" + }, + "pascalCase": { + "unsafeName": "Sunny", + "safeName": "Sunny" + } + }, + "wireValue": "SUNNY" + } + }, + "typeName": { + "name": { + "originalName": "InlineEnum", + "camelCase": { + "unsafeName": "inlineEnum", + "safeName": "inlineEnum" + }, + "snakeCase": { + "unsafeName": "inline_enum", + "safeName": "inline_enum" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_ENUM", + "safeName": "INLINE_ENUM" + }, + "pascalCase": { + "unsafeName": "InlineEnum", + "safeName": "InlineEnum" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:InlineEnum" + } + }, + "jsonExample": "SUNNY" + } + } + ] + }, + "typeName": { + "name": { + "originalName": "NestedInlineType1", + "camelCase": { + "unsafeName": "nestedInlineType1", + "safeName": "nestedInlineType1" + }, + "snakeCase": { + "unsafeName": "nested_inline_type1", + "safeName": "nested_inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "NESTED_INLINE_TYPE1", + "safeName": "NESTED_INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "NestedInlineType1", + "safeName": "NestedInlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:NestedInlineType1" + } + }, + "jsonExample": { + "foo": "foo", + "bar": "bar", + "myEnum": "SUNNY" + } + } + } + ] + }, + "typeName": { + "name": { + "originalName": "InlineType1", + "camelCase": { + "unsafeName": "inlineType1", + "safeName": "inlineType1" + }, + "snakeCase": { + "unsafeName": "inline_type1", + "safeName": "inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_TYPE1", + "safeName": "INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "InlineType1", + "safeName": "InlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:InlineType1" + } + }, + "jsonExample": { + "foo": "foo", + "bar": { + "foo": "foo", + "bar": "bar", + "myEnum": "SUNNY" + } + } + } + } + ] + }, + "typeName": { + "name": { + "originalName": "RootType1", + "camelCase": { + "unsafeName": "rootType1", + "safeName": "rootType1" + }, + "snakeCase": { + "unsafeName": "root_type1", + "safeName": "root_type1" + }, + "screamingSnakeCase": { + "unsafeName": "ROOT_TYPE1", + "safeName": "ROOT_TYPE1" + }, + "pascalCase": { + "unsafeName": "RootType1", + "safeName": "RootType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "typeId": "type_:RootType1" + } + }, + "jsonExample": { + "foo": "foo", + "bar": { + "foo": "foo", + "bar": { + "foo": "foo", + "bar": "bar", + "myEnum": "SUNNY" + } + } + } + } + } + }, + "docs": null + } + } + ], + "pagination": null, + "transport": null, + "availability": null, + "docs": null + } + ] + } + }, + "constants": { + "errorInstanceIdKey": { + "name": { + "originalName": "errorInstanceId", + "camelCase": { + "unsafeName": "errorInstanceID", + "safeName": "errorInstanceID" + }, + "snakeCase": { + "unsafeName": "error_instance_id", + "safeName": "error_instance_id" + }, + "screamingSnakeCase": { + "unsafeName": "ERROR_INSTANCE_ID", + "safeName": "ERROR_INSTANCE_ID" + }, + "pascalCase": { + "unsafeName": "ErrorInstanceID", + "safeName": "ErrorInstanceID" + } + }, + "wireValue": "errorInstanceId" + } + }, + "environments": null, + "errorDiscriminationStrategy": { + "type": "statusCode" + }, + "basePath": null, + "pathParameters": [], + "variables": [], + "serviceTypeReferenceInfo": { + "typesReferencedOnlyByService": { + "service_": [ + "type_:RootType1", + "type_:InlineType1", + "type_:NestedInlineType1", + "type_:InlineEnum" + ] + }, + "sharedTypes": [ + "type_:InlineType2", + "type_:InlinedDiscriminatedUnion1", + "type_:InlinedUndiscriminatedUnion1" + ] + }, + "webhookGroups": {}, + "websocketChannels": {}, + "readmeConfig": null, + "sourceConfig": null, + "publishConfig": null, + "dynamic": { + "version": "1.0.0", + "types": { + "type_:RootType1": { + "type": "object", + "declaration": { + "name": { + "originalName": "RootType1", + "camelCase": { + "unsafeName": "rootType1", + "safeName": "rootType1" + }, + "snakeCase": { + "unsafeName": "root_type1", + "safeName": "root_type1" + }, + "screamingSnakeCase": { + "unsafeName": "ROOT_TYPE1", + "safeName": "ROOT_TYPE1" + }, + "pascalCase": { + "unsafeName": "RootType1", + "safeName": "RootType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "typeReference": { + "_type": "primitive", + "value": "STRING" + } + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "typeReference": { + "_type": "named", + "value": "type_:InlineType1" + } + } + ] + }, + "type_:InlineType1": { + "type": "object", + "declaration": { + "name": { + "originalName": "InlineType1", + "camelCase": { + "unsafeName": "inlineType1", + "safeName": "inlineType1" + }, + "snakeCase": { + "unsafeName": "inline_type1", + "safeName": "inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_TYPE1", + "safeName": "INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "InlineType1", + "safeName": "InlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "typeReference": { + "_type": "primitive", + "value": "STRING" + } + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "typeReference": { + "_type": "named", + "value": "type_:NestedInlineType1" + } + } + ] + }, + "type_:InlineType2": { + "type": "object", + "declaration": { + "name": { + "originalName": "InlineType2", + "camelCase": { + "unsafeName": "inlineType2", + "safeName": "inlineType2" + }, + "snakeCase": { + "unsafeName": "inline_type2", + "safeName": "inline_type2" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_TYPE2", + "safeName": "INLINE_TYPE2" + }, + "pascalCase": { + "unsafeName": "InlineType2", + "safeName": "InlineType2" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "properties": [ + { + "name": { + "name": { + "originalName": "baz", + "camelCase": { + "unsafeName": "baz", + "safeName": "baz" + }, + "snakeCase": { + "unsafeName": "baz", + "safeName": "baz" + }, + "screamingSnakeCase": { + "unsafeName": "BAZ", + "safeName": "BAZ" + }, + "pascalCase": { + "unsafeName": "Baz", + "safeName": "Baz" + } + }, + "wireValue": "baz" + }, + "typeReference": { + "_type": "primitive", + "value": "STRING" + } + } + ] + }, + "type_:NestedInlineType1": { + "type": "object", + "declaration": { + "name": { + "originalName": "NestedInlineType1", + "camelCase": { + "unsafeName": "nestedInlineType1", + "safeName": "nestedInlineType1" + }, + "snakeCase": { + "unsafeName": "nested_inline_type1", + "safeName": "nested_inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "NESTED_INLINE_TYPE1", + "safeName": "NESTED_INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "NestedInlineType1", + "safeName": "NestedInlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "typeReference": { + "_type": "primitive", + "value": "STRING" + } + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "typeReference": { + "_type": "primitive", + "value": "STRING" + } + }, + { + "name": { + "name": { + "originalName": "myEnum", + "camelCase": { + "unsafeName": "myEnum", + "safeName": "myEnum" + }, + "snakeCase": { + "unsafeName": "my_enum", + "safeName": "my_enum" + }, + "screamingSnakeCase": { + "unsafeName": "MY_ENUM", + "safeName": "MY_ENUM" + }, + "pascalCase": { + "unsafeName": "MyEnum", + "safeName": "MyEnum" + } + }, + "wireValue": "myEnum" + }, + "typeReference": { + "_type": "named", + "value": "type_:InlineEnum" + } + } + ] + }, + "type_:InlinedDiscriminatedUnion1": { + "type": "discriminatedUnion", + "declaration": { + "name": { + "originalName": "InlinedDiscriminatedUnion1", + "camelCase": { + "unsafeName": "inlinedDiscriminatedUnion1", + "safeName": "inlinedDiscriminatedUnion1" + }, + "snakeCase": { + "unsafeName": "inlined_discriminated_union1", + "safeName": "inlined_discriminated_union1" + }, + "screamingSnakeCase": { + "unsafeName": "INLINED_DISCRIMINATED_UNION1", + "safeName": "INLINED_DISCRIMINATED_UNION1" + }, + "pascalCase": { + "unsafeName": "InlinedDiscriminatedUnion1", + "safeName": "InlinedDiscriminatedUnion1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "discriminant": { + "name": { + "originalName": "type", + "camelCase": { + "unsafeName": "type", + "safeName": "type" + }, + "snakeCase": { + "unsafeName": "type", + "safeName": "type" + }, + "screamingSnakeCase": { + "unsafeName": "TYPE", + "safeName": "TYPE" + }, + "pascalCase": { + "unsafeName": "Type", + "safeName": "Type" + } + }, + "wireValue": "type" + }, + "types": { + "type1": { + "type": "samePropertiesAsObject", + "typeId": "type_:InlineType1", + "discriminantValue": { + "name": { + "originalName": "type1", + "camelCase": { + "unsafeName": "type1", + "safeName": "type1" + }, + "snakeCase": { + "unsafeName": "type1", + "safeName": "type1" + }, + "screamingSnakeCase": { + "unsafeName": "TYPE1", + "safeName": "TYPE1" + }, + "pascalCase": { + "unsafeName": "Type1", + "safeName": "Type1" + } + }, + "wireValue": "type1" + }, + "properties": [] + }, + "type2": { + "type": "samePropertiesAsObject", + "typeId": "type_:InlineType2", + "discriminantValue": { + "name": { + "originalName": "type2", + "camelCase": { + "unsafeName": "type2", + "safeName": "type2" + }, + "snakeCase": { + "unsafeName": "type2", + "safeName": "type2" + }, + "screamingSnakeCase": { + "unsafeName": "TYPE2", + "safeName": "TYPE2" + }, + "pascalCase": { + "unsafeName": "Type2", + "safeName": "Type2" + } + }, + "wireValue": "type2" + }, + "properties": [] + } + } + }, + "type_:InlinedUndiscriminatedUnion1": { + "type": "undiscriminatedUnion", + "declaration": { + "name": { + "originalName": "InlinedUndiscriminatedUnion1", + "camelCase": { + "unsafeName": "inlinedUndiscriminatedUnion1", + "safeName": "inlinedUndiscriminatedUnion1" + }, + "snakeCase": { + "unsafeName": "inlined_undiscriminated_union1", + "safeName": "inlined_undiscriminated_union1" + }, + "screamingSnakeCase": { + "unsafeName": "INLINED_UNDISCRIMINATED_UNION1", + "safeName": "INLINED_UNDISCRIMINATED_UNION1" + }, + "pascalCase": { + "unsafeName": "InlinedUndiscriminatedUnion1", + "safeName": "InlinedUndiscriminatedUnion1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "types": [ + { + "_type": "named", + "value": "type_:InlineType1" + }, + { + "_type": "named", + "value": "type_:InlineType2" + } + ] + }, + "type_:InlineEnum": { + "type": "enum", + "declaration": { + "name": { + "originalName": "InlineEnum", + "camelCase": { + "unsafeName": "inlineEnum", + "safeName": "inlineEnum" + }, + "snakeCase": { + "unsafeName": "inline_enum", + "safeName": "inline_enum" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_ENUM", + "safeName": "INLINE_ENUM" + }, + "pascalCase": { + "unsafeName": "InlineEnum", + "safeName": "InlineEnum" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "values": [ + { + "name": { + "originalName": "SUNNY", + "camelCase": { + "unsafeName": "sunny", + "safeName": "sunny" + }, + "snakeCase": { + "unsafeName": "sunny", + "safeName": "sunny" + }, + "screamingSnakeCase": { + "unsafeName": "SUNNY", + "safeName": "SUNNY" + }, + "pascalCase": { + "unsafeName": "Sunny", + "safeName": "Sunny" + } + }, + "wireValue": "SUNNY" + }, + { + "name": { + "originalName": "CLOUDY", + "camelCase": { + "unsafeName": "cloudy", + "safeName": "cloudy" + }, + "snakeCase": { + "unsafeName": "cloudy", + "safeName": "cloudy" + }, + "screamingSnakeCase": { + "unsafeName": "CLOUDY", + "safeName": "CLOUDY" + }, + "pascalCase": { + "unsafeName": "Cloudy", + "safeName": "Cloudy" + } + }, + "wireValue": "CLOUDY" + }, + { + "name": { + "originalName": "RAINING", + "camelCase": { + "unsafeName": "raining", + "safeName": "raining" + }, + "snakeCase": { + "unsafeName": "raining", + "safeName": "raining" + }, + "screamingSnakeCase": { + "unsafeName": "RAINING", + "safeName": "RAINING" + }, + "pascalCase": { + "unsafeName": "Raining", + "safeName": "Raining" + } + }, + "wireValue": "RAINING" + }, + { + "name": { + "originalName": "SNOWING", + "camelCase": { + "unsafeName": "snowing", + "safeName": "snowing" + }, + "snakeCase": { + "unsafeName": "snowing", + "safeName": "snowing" + }, + "screamingSnakeCase": { + "unsafeName": "SNOWING", + "safeName": "SNOWING" + }, + "pascalCase": { + "unsafeName": "Snowing", + "safeName": "Snowing" + } + }, + "wireValue": "SNOWING" + } + ] + } + }, + "headers": [], + "endpoints": { + "endpoint_.getRoot": { + "auth": null, + "declaration": { + "name": { + "originalName": "getRoot", + "camelCase": { + "unsafeName": "getRoot", + "safeName": "getRoot" + }, + "snakeCase": { + "unsafeName": "get_root", + "safeName": "get_root" + }, + "screamingSnakeCase": { + "unsafeName": "GET_ROOT", + "safeName": "GET_ROOT" + }, + "pascalCase": { + "unsafeName": "GetRoot", + "safeName": "GetRoot" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "location": { + "method": "POST", + "path": "/root/root" + }, + "request": { + "type": "inlined", + "declaration": { + "name": { + "originalName": "PostRootRequest", + "camelCase": { + "unsafeName": "postRootRequest", + "safeName": "postRootRequest" + }, + "snakeCase": { + "unsafeName": "post_root_request", + "safeName": "post_root_request" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_REQUEST", + "safeName": "POST_ROOT_REQUEST" + }, + "pascalCase": { + "unsafeName": "PostRootRequest", + "safeName": "PostRootRequest" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "pathParameters": [], + "queryParameters": [], + "headers": [], + "body": { + "type": "properties", + "value": [ + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "typeReference": { + "_type": "named", + "value": "type_:InlineType1" + } + }, + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "typeReference": { + "_type": "primitive", + "value": "STRING" + } + } + ] + }, + "metadata": { + "includePathParameters": false, + "onlyPathParameters": false + } + }, + "response": { + "type": "json" + } + } + } + }, + "subpackages": {}, + "rootPackage": { + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + }, + "websocket": null, + "service": "service_", + "types": [ + "type_:RootType1", + "type_:InlineType1", + "type_:InlineType2", + "type_:NestedInlineType1", + "type_:InlinedDiscriminatedUnion1", + "type_:InlinedUndiscriminatedUnion1", + "type_:InlineEnum" + ], + "errors": [], + "subpackages": [], + "webhooks": null, + "navigationConfig": null, + "hasEndpointsInTree": true, + "docs": null + }, + "sdkConfig": { + "isAuthMandatory": false, + "hasStreamingEndpoints": false, + "hasPaginatedEndpoints": false, + "hasFileDownloadEndpoints": false, + "platformHeaders": { + "language": "X-Fern-Language", + "sdkName": "X-Fern-SDK-Name", + "sdkVersion": "X-Fern-SDK-Version", + "userAgent": null + } + } +} \ No newline at end of file diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/license.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/license.json index ba60ed96c7e..5cfa147791e 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/license.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/license.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_:Type": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Type", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/literal.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/literal.json index 0ccff03596a..8db631c5054 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/literal.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/literal.json @@ -106,7 +106,7 @@ "idempotencyHeaders": [], "types": { "type_:SendResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "SendResponse", @@ -264,7 +264,7 @@ "docs": null }, "type_inlined:SomeAliasedLiteral": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "SomeAliasedLiteral", @@ -365,7 +365,7 @@ "docs": null }, "type_inlined:ATopLevelLiteral": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ATopLevelLiteral", @@ -547,7 +547,7 @@ "docs": null }, "type_inlined:ANestedLiteral": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ANestedLiteral", @@ -669,7 +669,7 @@ "docs": null }, "type_reference:SendRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "SendRequest", @@ -1156,7 +1156,7 @@ "docs": null }, "type_reference:ContainerObject": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ContainerObject", @@ -1344,7 +1344,7 @@ "docs": null }, "type_reference:NestedObjectWithLiterals": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "NestedObjectWithLiterals", @@ -1539,7 +1539,7 @@ "docs": null }, "type_reference:SomeLiteral": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "SomeLiteral", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/mixed-case.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/mixed-case.json index 6002e3d0c61..210a471fd08 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/mixed-case.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/mixed-case.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_service:Organization": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Organization", @@ -286,7 +286,7 @@ "docs": null }, "type_service:User": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "User", @@ -961,7 +961,7 @@ "docs": null }, "type_service:NestedUser": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "NestedUser", @@ -1914,7 +1914,7 @@ "docs": null }, "type_service:ResourceStatus": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ResourceStatus", @@ -2050,7 +2050,7 @@ "docs": null }, "type_service:Resource": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Resource", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/mixed-file-directory.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/mixed-file-directory.json index c109710d66b..f80ce8284e8 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/mixed-file-directory.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/mixed-file-directory.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_:Id": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Id", @@ -96,7 +96,7 @@ "docs": null }, "type_organization:Organization": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Organization", @@ -378,7 +378,7 @@ "docs": null }, "type_organization:CreateOrganizationRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "CreateOrganizationRequest", @@ -501,7 +501,7 @@ "docs": null }, "type_user:User": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "User", @@ -719,7 +719,7 @@ "docs": null }, "type_user/events:Event": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Event", @@ -939,7 +939,7 @@ "docs": null }, "type_user/events/metadata:Metadata": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Metadata", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/multi-line-docs.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/multi-line-docs.json index 7e8be7b4a2f..5445f7bffcb 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/multi-line-docs.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/multi-line-docs.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_:Operand": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Operand", @@ -252,7 +252,7 @@ "docs": "Tests enum name and value can be\ndifferent." }, "type_user:User": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "User", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/oauth-client-credentials-default.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/oauth-client-credentials-default.json index 77f75831d67..53954c287a8 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/oauth-client-credentials-default.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/oauth-client-credentials-default.json @@ -181,7 +181,7 @@ "idempotencyHeaders": [], "types": { "type_auth:TokenResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TokenResponse", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/oauth-client-credentials-environment-variables.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/oauth-client-credentials-environment-variables.json index d2d9969616b..aa57bcf4593 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/oauth-client-credentials-environment-variables.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/oauth-client-credentials-environment-variables.json @@ -220,7 +220,7 @@ "idempotencyHeaders": [], "types": { "type_auth:TokenResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TokenResponse", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/oauth-client-credentials-nested-root.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/oauth-client-credentials-nested-root.json index ea4ac62aef5..73b74051f5b 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/oauth-client-credentials-nested-root.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/oauth-client-credentials-nested-root.json @@ -220,7 +220,7 @@ "idempotencyHeaders": [], "types": { "type_auth:TokenResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TokenResponse", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/oauth-client-credentials.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/oauth-client-credentials.json index 11f7d8a8485..84530181c37 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/oauth-client-credentials.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/oauth-client-credentials.json @@ -220,7 +220,7 @@ "idempotencyHeaders": [], "types": { "type_auth:TokenResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TokenResponse", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/object.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/object.json index 6f248429f41..aa514a75091 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/object.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/object.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_:Type": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Type", @@ -3071,7 +3071,7 @@ "docs": "Exercises all of the built-in types." }, "type_:Name": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Name", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/objects-with-imports.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/objects-with-imports.json index aec7b34959d..430b1e25fe1 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/objects-with-imports.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/objects-with-imports.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_:Node": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Node", @@ -2049,7 +2049,7 @@ "docs": null }, "type_:Tree": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Tree", @@ -4173,7 +4173,7 @@ "docs": null }, "type_commons/metadata:Metadata": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Metadata", @@ -4826,7 +4826,7 @@ "docs": null }, "type_file:File": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "File", @@ -5921,7 +5921,7 @@ "docs": null }, "type_file:FileInfo": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "FileInfo", @@ -6154,7 +6154,7 @@ "docs": null }, "type_file/directory:Directory": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Directory", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/package-yml.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/package-yml.json index 0d96034641f..1cbca51b2a9 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/package-yml.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/package-yml.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_:EchoRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "EchoRequest", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/pagination.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/pagination.json index 51b059d6b03..ddb96be1ede 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/pagination.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/pagination.json @@ -56,7 +56,7 @@ "idempotencyHeaders": [], "types": { "type_:UsernameCursor": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UsernameCursor", @@ -162,7 +162,7 @@ "docs": null }, "type_:UsernamePage": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UsernamePage", @@ -296,7 +296,7 @@ "docs": null }, "type_users:Order": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Order", @@ -432,7 +432,7 @@ "docs": null }, "type_users:WithPage": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "WithPage", @@ -561,7 +561,7 @@ "docs": null }, "type_users:WithCursor": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "WithCursor", @@ -690,7 +690,7 @@ "docs": null }, "type_users:UserListContainer": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UserListContainer", @@ -878,7 +878,7 @@ "docs": null }, "type_users:UserPage": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UserPage", @@ -1100,7 +1100,7 @@ "docs": null }, "type_users:UserOptionalListContainer": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UserOptionalListContainer", @@ -1294,7 +1294,7 @@ "docs": null }, "type_users:UserOptionalListPage": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UserOptionalListPage", @@ -1516,7 +1516,7 @@ "docs": null }, "type_users:UsernameContainer": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UsernameContainer", @@ -1645,7 +1645,7 @@ "docs": null }, "type_users:ListUsersExtendedResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ListUsersExtendedResponse", @@ -1972,7 +1972,7 @@ "docs": null }, "type_users:ListUsersExtendedOptionalListResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ListUsersExtendedOptionalListResponse", @@ -2299,7 +2299,7 @@ "docs": null }, "type_users:ListUsersPaginationResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ListUsersPaginationResponse", @@ -2665,7 +2665,7 @@ "docs": null }, "type_users:Page": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Page", @@ -2964,7 +2964,7 @@ "docs": null }, "type_users:NextPage": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "NextPage", @@ -3124,7 +3124,7 @@ "docs": null }, "type_users:User": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "User", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/path-parameters.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/path-parameters.json index 148d64a849b..7f087449097 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/path-parameters.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/path-parameters.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_user:Organization": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Organization", @@ -197,7 +197,7 @@ "docs": null }, "type_user:User": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "User", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/query-parameters.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/query-parameters.json index 10035e75167..ff7080abf05 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/query-parameters.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/query-parameters.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_user:User": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "User", @@ -197,7 +197,7 @@ "docs": null }, "type_user:NestedUser": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "NestedUser", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/reserved-keywords.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/reserved-keywords.json index 00c41a8ad84..0788cf6e198 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/reserved-keywords.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/reserved-keywords.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_package:Package": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Package", @@ -154,7 +154,7 @@ "docs": null }, "type_package:Record": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Record", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/response-property.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/response-property.json index 4503b91d81a..b7b255841ca 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/response-property.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/response-property.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_:StringResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "StringResponse", @@ -116,7 +116,7 @@ "docs": null }, "type_:OptionalStringResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "OptionalStringResponse", @@ -233,7 +233,7 @@ "docs": null }, "type_:WithMetadata": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "WithMetadata", @@ -335,7 +335,7 @@ "docs": null }, "type_service:WithDocs": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "WithDocs", @@ -458,7 +458,7 @@ "docs": null }, "type_service:OptionalWithDocs": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "OptionalWithDocs", @@ -689,7 +689,7 @@ "docs": null }, "type_service:Movie": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Movie", @@ -849,7 +849,7 @@ "docs": null }, "type_service:Response": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Response", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/server-sent-event-examples.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/server-sent-event-examples.json index 8d7650b9db4..9182f1c6197 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/server-sent-event-examples.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/server-sent-event-examples.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_completions:StreamedCompletion": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "StreamedCompletion", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/server-sent-events.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/server-sent-events.json index a90f876fd54..237a0172c62 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/server-sent-events.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/server-sent-events.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_completions:StreamedCompletion": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "StreamedCompletion", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/simple-fhir.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/simple-fhir.json index 2fd2d4dbd6a..3fcf4863a0a 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/simple-fhir.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/simple-fhir.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_:Memo": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Memo", @@ -186,7 +186,7 @@ "docs": null }, "type_:BaseResource": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "BaseResource", @@ -397,7 +397,7 @@ "docs": null }, "type_:ResourceList": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ResourceList", @@ -582,7 +582,7 @@ "docs": null }, "type_:Account": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Account", @@ -1019,7 +1019,7 @@ "docs": null }, "type_:Patient": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Patient", @@ -1394,7 +1394,7 @@ "docs": null }, "type_:Practitioner": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Practitioner", @@ -1707,7 +1707,7 @@ "docs": null }, "type_:Script": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Script", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/streaming-parameter.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/streaming-parameter.json index 10633d5389d..a3c56f51696 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/streaming-parameter.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/streaming-parameter.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_dummy:RegularResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "RegularResponse", @@ -197,7 +197,7 @@ "docs": null }, "type_dummy:StreamResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "StreamResponse", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/streaming.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/streaming.json index 7cf13e41bc6..deb1485ce6d 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/streaming.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/streaming.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_dummy:StreamResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "StreamResponse", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/trace.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/trace.json index b3bf477fe1d..f98afe34752 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/trace.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/trace.json @@ -101,7 +101,7 @@ "idempotencyHeaders": [], "types": { "type_admin:Test": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Test", @@ -326,7 +326,7 @@ "docs": null }, "type_commons:UserId": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UserId", @@ -429,7 +429,7 @@ "docs": null }, "type_commons:ProblemId": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ProblemId", @@ -532,7 +532,7 @@ "docs": null }, "type_commons:NodeId": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "NodeId", @@ -635,7 +635,7 @@ "docs": null }, "type_commons:VariableType": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "VariableType", @@ -1172,7 +1172,7 @@ "docs": null }, "type_commons:ListType": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ListType", @@ -1395,7 +1395,7 @@ "docs": null }, "type_commons:MapType": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "MapType", @@ -1673,7 +1673,7 @@ "docs": null }, "type_commons:VariableValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "VariableValue", @@ -2630,7 +2630,7 @@ "docs": null }, "type_commons:DebugVariableValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "DebugVariableValue", @@ -3714,7 +3714,7 @@ "docs": null }, "type_commons:GenericValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GenericValue", @@ -3880,7 +3880,7 @@ "docs": null }, "type_commons:MapValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "MapValue", @@ -4077,7 +4077,7 @@ "docs": null }, "type_commons:KeyValuePair": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "KeyValuePair", @@ -4362,7 +4362,7 @@ "docs": null }, "type_commons:BinaryTreeValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "BinaryTreeValue", @@ -4719,7 +4719,7 @@ "docs": null }, "type_commons:BinaryTreeNodeValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "BinaryTreeNodeValue", @@ -5138,7 +5138,7 @@ "docs": null }, "type_commons:BinaryTreeNodeAndTreeValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "BinaryTreeNodeAndTreeValue", @@ -5416,7 +5416,7 @@ "docs": null }, "type_commons:SinglyLinkedListValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "SinglyLinkedListValue", @@ -5773,7 +5773,7 @@ "docs": null }, "type_commons:SinglyLinkedListNodeValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "SinglyLinkedListNodeValue", @@ -6092,7 +6092,7 @@ "docs": null }, "type_commons:SinglyLinkedListNodeAndListValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "SinglyLinkedListNodeAndListValue", @@ -6370,7 +6370,7 @@ "docs": null }, "type_commons:DoublyLinkedListValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "DoublyLinkedListValue", @@ -6727,7 +6727,7 @@ "docs": null }, "type_commons:DoublyLinkedListNodeValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "DoublyLinkedListNodeValue", @@ -7146,7 +7146,7 @@ "docs": null }, "type_commons:DoublyLinkedListNodeAndListValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "DoublyLinkedListNodeAndListValue", @@ -7424,7 +7424,7 @@ "docs": null }, "type_commons:DebugMapValue": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "DebugMapValue", @@ -7625,7 +7625,7 @@ "docs": null }, "type_commons:DebugKeyValuePairs": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "DebugKeyValuePairs", @@ -7914,7 +7914,7 @@ "docs": null }, "type_commons:TestCase": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCase", @@ -8148,7 +8148,7 @@ "docs": null }, "type_commons:TestCaseWithExpectedResult": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseWithExpectedResult", @@ -8434,7 +8434,7 @@ "docs": null }, "type_commons:FileInfo": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "FileInfo", @@ -8594,7 +8594,7 @@ "docs": null }, "type_commons:Language": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Language", @@ -8756,7 +8756,7 @@ "docs": null }, "type_lang-server:LangServerRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "LangServerRequest", @@ -8871,7 +8871,7 @@ "docs": null }, "type_lang-server:LangServerResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "LangServerResponse", @@ -8986,7 +8986,7 @@ "docs": null }, "type_migration:MigrationStatus": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "MigrationStatus", @@ -9148,7 +9148,7 @@ "docs": null }, "type_migration:Migration": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Migration", @@ -9367,7 +9367,7 @@ "docs": null }, "type_playlist:PlaylistId": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "PlaylistId", @@ -9470,7 +9470,7 @@ "docs": null }, "type_playlist:Playlist": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Playlist", @@ -9953,7 +9953,7 @@ "docs": null }, "type_playlist:PlaylistCreateRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "PlaylistCreateRequest", @@ -10178,7 +10178,7 @@ "docs": null }, "type_playlist:UpdatePlaylistRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UpdatePlaylistRequest", @@ -10403,7 +10403,7 @@ "docs": null }, "type_playlist:PlaylistIdNotFoundErrorBody": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "PlaylistIdNotFoundErrorBody", @@ -10632,7 +10632,7 @@ "docs": null }, "type_playlist:ReservedKeywordEnum": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ReservedKeywordEnum", @@ -10768,7 +10768,7 @@ "docs": null }, "type_problem:ProblemInfo": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ProblemInfo", @@ -11671,7 +11671,7 @@ "docs": null }, "type_problem:ProblemDescription": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ProblemDescription", @@ -11869,7 +11869,7 @@ "docs": null }, "type_problem:ProblemDescriptionBoard": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ProblemDescriptionBoard", @@ -12233,7 +12233,7 @@ "docs": null }, "type_problem:ProblemFiles": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ProblemFiles", @@ -12515,7 +12515,7 @@ "docs": null }, "type_problem:VariableTypeAndName": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "VariableTypeAndName", @@ -12736,7 +12736,7 @@ "docs": null }, "type_problem:CreateProblemRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "CreateProblemRequest", @@ -13474,7 +13474,7 @@ "docs": null }, "type_problem:CreateProblemResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "CreateProblemResponse", @@ -13825,7 +13825,7 @@ "docs": null }, "type_problem:UpdateProblemResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UpdateProblemResponse", @@ -13948,7 +13948,7 @@ "docs": null }, "type_problem:CreateProblemError": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "CreateProblemError", @@ -14150,7 +14150,7 @@ "docs": null }, "type_problem:GenericCreateProblemError": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GenericCreateProblemError", @@ -14347,7 +14347,7 @@ "docs": null }, "type_problem:GetDefaultStarterFilesResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GetDefaultStarterFilesResponse", @@ -14605,7 +14605,7 @@ "docs": null }, "type_submission:SubmissionId": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "SubmissionId", @@ -14700,7 +14700,7 @@ "docs": null }, "type_submission:ShareId": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ShareId", @@ -14803,7 +14803,7 @@ "docs": null }, "type_submission:SubmissionRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "SubmissionRequest", @@ -15321,7 +15321,7 @@ "docs": null }, "type_submission:InitializeProblemRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "InitializeProblemRequest", @@ -15546,7 +15546,7 @@ "docs": null }, "type_submission:SubmitRequestV2": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "SubmitRequestV2", @@ -16105,7 +16105,7 @@ "docs": null }, "type_submission:WorkspaceSubmitRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "WorkspaceSubmitRequest", @@ -16526,7 +16526,7 @@ "docs": null }, "type_submission:SubmissionFileInfo": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "SubmissionFileInfo", @@ -16723,7 +16723,7 @@ "docs": null }, "type_submission:SubmissionTypeEnum": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "SubmissionTypeEnum", @@ -16833,7 +16833,7 @@ "docs": "Keep in sync with SubmissionType." }, "type_submission:StopRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "StopRequest", @@ -17015,7 +17015,7 @@ "docs": null }, "type_submission:SubmissionResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "SubmissionResponse", @@ -17663,7 +17663,7 @@ "docs": null }, "type_submission:CodeExecutionUpdate": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "CodeExecutionUpdate", @@ -18846,7 +18846,7 @@ "docs": null }, "type_submission:BuildingExecutorResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "BuildingExecutorResponse", @@ -19123,7 +19123,7 @@ "docs": null }, "type_submission:RunningResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "RunningResponse", @@ -19400,7 +19400,7 @@ "docs": null }, "type_submission:RunningSubmissionState": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "RunningSubmissionState", @@ -19614,7 +19614,7 @@ "docs": null }, "type_submission:ErroredResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ErroredResponse", @@ -19895,7 +19895,7 @@ "docs": null }, "type_submission:ErrorInfo": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ErrorInfo", @@ -20286,7 +20286,7 @@ "docs": null }, "type_submission:CompileError": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "CompileError", @@ -20409,7 +20409,7 @@ "docs": null }, "type_submission:RuntimeError": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "RuntimeError", @@ -20532,7 +20532,7 @@ "docs": null }, "type_submission:InternalError": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "InternalError", @@ -20714,7 +20714,7 @@ "docs": null }, "type_submission:StoppedResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "StoppedResponse", @@ -20896,7 +20896,7 @@ "docs": null }, "type_submission:WorkspaceRanResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "WorkspaceRanResponse", @@ -21175,7 +21175,7 @@ "docs": null }, "type_submission:WorkspaceRunDetails": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "WorkspaceRunDetails", @@ -21501,7 +21501,7 @@ "docs": null }, "type_submission:GradedResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GradedResponse", @@ -21809,7 +21809,7 @@ "docs": null }, "type_submission:GradedResponseV2": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GradedResponseV2", @@ -22214,7 +22214,7 @@ "docs": null }, "type_submission:TestCaseGrade": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseGrade", @@ -22522,7 +22522,7 @@ "docs": null }, "type_submission:TestCaseHiddenGrade": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseHiddenGrade", @@ -22641,7 +22641,7 @@ "docs": null }, "type_submission:TestCaseNonHiddenGrade": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseNonHiddenGrade", @@ -23010,7 +23010,7 @@ "docs": null }, "type_submission:RecordedResponseNotification": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "RecordedResponseNotification", @@ -23272,7 +23272,7 @@ "docs": null }, "type_submission:RecordingResponseNotification": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "RecordingResponseNotification", @@ -23730,7 +23730,7 @@ "docs": null }, "type_submission:LightweightStackframeInformation": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "LightweightStackframeInformation", @@ -23890,7 +23890,7 @@ "docs": null }, "type_submission:TestCaseResultWithStdout": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseResultWithStdout", @@ -24122,7 +24122,7 @@ "docs": null }, "type_submission:TestCaseResult": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseResult", @@ -24443,7 +24443,7 @@ "docs": null }, "type_submission:ActualResult": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ActualResult", @@ -24896,7 +24896,7 @@ "docs": null }, "type_submission:ExceptionV2": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ExceptionV2", @@ -25128,7 +25128,7 @@ "docs": null }, "type_submission:ExceptionInfo": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ExceptionInfo", @@ -25325,7 +25325,7 @@ "docs": null }, "type_submission:InvalidRequestResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "InvalidRequestResponse", @@ -25613,7 +25613,7 @@ "docs": null }, "type_submission:InvalidRequestCause": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "InvalidRequestCause", @@ -26006,7 +26006,7 @@ "docs": null }, "type_submission:ExistingSubmissionExecuting": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ExistingSubmissionExecuting", @@ -26188,7 +26188,7 @@ "docs": null }, "type_submission:SubmissionIdNotFound": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "SubmissionIdNotFound", @@ -26370,7 +26370,7 @@ "docs": null }, "type_submission:CustomTestCasesUnsupported": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "CustomTestCasesUnsupported", @@ -26647,7 +26647,7 @@ "docs": null }, "type_submission:UnexpectedLanguageError": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UnexpectedLanguageError", @@ -26923,7 +26923,7 @@ "docs": null }, "type_submission:TerminatedResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TerminatedResponse", @@ -27008,7 +27008,7 @@ "docs": null }, "type_submission:FinishedResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "FinishedResponse", @@ -27190,7 +27190,7 @@ "docs": null }, "type_submission:StdoutResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "StdoutResponse", @@ -27409,7 +27409,7 @@ "docs": null }, "type_submission:StderrResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "StderrResponse", @@ -27628,7 +27628,7 @@ "docs": null }, "type_submission:TraceResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TraceResponse", @@ -28202,7 +28202,7 @@ "docs": null }, "type_submission:TraceResponseV2": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TraceResponseV2", @@ -28871,7 +28871,7 @@ "docs": null }, "type_submission:TracedFile": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TracedFile", @@ -29031,7 +29031,7 @@ "docs": null }, "type_submission:ExpressionLocation": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ExpressionLocation", @@ -29191,7 +29191,7 @@ "docs": null }, "type_submission:StackInformation": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "StackInformation", @@ -29431,7 +29431,7 @@ "docs": null }, "type_submission:StackFrame": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "StackFrame", @@ -29707,7 +29707,7 @@ "docs": null }, "type_submission:Scope": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Scope", @@ -29919,7 +29919,7 @@ "docs": null }, "type_submission:ExecutionSessionResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ExecutionSessionResponse", @@ -30276,7 +30276,7 @@ "docs": null }, "type_submission:ExecutionSessionStatus": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ExecutionSessionStatus", @@ -30516,7 +30516,7 @@ "docs": null }, "type_submission:SubmissionStatusV2": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "SubmissionStatusV2", @@ -30876,7 +30876,7 @@ "docs": null }, "type_submission:TestSubmissionStatusV2": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestSubmissionStatusV2", @@ -31387,7 +31387,7 @@ "docs": null }, "type_submission:WorkspaceSubmissionStatusV2": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "WorkspaceSubmissionStatusV2", @@ -31585,7 +31585,7 @@ "docs": null }, "type_submission:TestSubmissionUpdate": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestSubmissionUpdate", @@ -31823,7 +31823,7 @@ "docs": null }, "type_submission:TestSubmissionUpdateInfo": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestSubmissionUpdateInfo", @@ -32440,7 +32440,7 @@ "docs": null }, "type_submission:WorkspaceSubmissionUpdate": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "WorkspaceSubmissionUpdate", @@ -32664,7 +32664,7 @@ "docs": null }, "type_submission:WorkspaceSubmissionUpdateInfo": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "WorkspaceSubmissionUpdateInfo", @@ -33297,7 +33297,7 @@ "docs": null }, "type_submission:GradedTestCaseUpdate": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GradedTestCaseUpdate", @@ -33627,7 +33627,7 @@ "docs": null }, "type_submission:RecordedTestCaseUpdate": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "RecordedTestCaseUpdate", @@ -33885,7 +33885,7 @@ "docs": null }, "type_submission:WorkspaceTracedUpdate": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "WorkspaceTracedUpdate", @@ -34008,7 +34008,7 @@ "docs": null }, "type_submission:SubmissionTypeState": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "SubmissionTypeState", @@ -34334,7 +34334,7 @@ "docs": null }, "type_submission:WorkspaceSubmissionState": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "WorkspaceSubmissionState", @@ -34524,7 +34524,7 @@ "docs": null }, "type_submission:WorkspaceSubmissionStatus": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "WorkspaceSubmissionStatus", @@ -35096,7 +35096,7 @@ "docs": null }, "type_submission:TestSubmissionState": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestSubmissionState", @@ -35599,7 +35599,7 @@ "docs": null }, "type_submission:TestSubmissionStatus": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestSubmissionStatus", @@ -36139,7 +36139,7 @@ "docs": null }, "type_submission:SubmissionStatusForTestCase": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "SubmissionStatusForTestCase", @@ -36572,7 +36572,7 @@ "docs": null }, "type_submission:TracedTestCase": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TracedTestCase", @@ -36805,7 +36805,7 @@ "docs": null }, "type_submission:TraceResponsesPage": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TraceResponsesPage", @@ -37055,7 +37055,7 @@ "docs": null }, "type_submission:TraceResponsesPageV2": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TraceResponsesPageV2", @@ -37306,7 +37306,7 @@ "docs": null }, "type_submission:GetTraceResponsesPageRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GetTraceResponsesPageRequest", @@ -37435,7 +37435,7 @@ "docs": null }, "type_submission:WorkspaceStarterFilesResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "WorkspaceStarterFilesResponse", @@ -37693,7 +37693,7 @@ "docs": null }, "type_submission:WorkspaceStarterFilesResponseV2": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "WorkspaceStarterFilesResponseV2", @@ -37990,7 +37990,7 @@ "docs": null }, "type_submission:WorkspaceFiles": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "WorkspaceFiles", @@ -38272,7 +38272,7 @@ "docs": null }, "type_submission:ExecutionSessionState": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ExecutionSessionState", @@ -38705,7 +38705,7 @@ "docs": null }, "type_submission:GetExecutionSessionStateResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GetExecutionSessionStateResponse", @@ -38992,7 +38992,7 @@ "docs": null }, "type_submission:GetSubmissionStateResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GetSubmissionStateResponse", @@ -39377,7 +39377,7 @@ "docs": null }, "type_v2/problem:TestCaseTemplateId": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseTemplateId", @@ -39519,7 +39519,7 @@ "docs": null }, "type_v2/problem:TestCaseId": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseId", @@ -39661,7 +39661,7 @@ "docs": null }, "type_v2/problem:ParameterId": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ParameterId", @@ -39803,7 +39803,7 @@ "docs": null }, "type_v2/problem:ProblemInfoV2": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ProblemInfoV2", @@ -40913,7 +40913,7 @@ "docs": null }, "type_v2/problem:LightweightProblemInfoV2": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "LightweightProblemInfoV2", @@ -41311,7 +41311,7 @@ "docs": null }, "type_v2/problem:CreateProblemRequestV2": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "CreateProblemRequestV2", @@ -42155,7 +42155,7 @@ "docs": null }, "type_v2/problem:TestCaseV2": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseV2", @@ -42927,7 +42927,7 @@ "docs": null }, "type_v2/problem:TestCaseExpects": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseExpects", @@ -43095,7 +43095,7 @@ "docs": null }, "type_v2/problem:TestCaseImplementationReference": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseImplementationReference", @@ -43553,7 +43553,7 @@ "docs": null }, "type_v2/problem:BasicTestCaseTemplate": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "BasicTestCaseTemplate", @@ -44119,7 +44119,7 @@ "docs": null }, "type_v2/problem:TestCaseTemplate": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseTemplate", @@ -44568,7 +44568,7 @@ "docs": null }, "type_v2/problem:TestCaseImplementation": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseImplementation", @@ -44978,7 +44978,7 @@ "docs": null }, "type_v2/problem:TestCaseFunction": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseFunction", @@ -45404,7 +45404,7 @@ "docs": null }, "type_v2/problem:TestCaseWithActualResultImplementation": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseWithActualResultImplementation", @@ -45809,7 +45809,7 @@ "docs": null }, "type_v2/problem:VoidFunctionDefinition": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "VoidFunctionDefinition", @@ -46215,7 +46215,7 @@ "docs": null }, "type_v2/problem:Parameter": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Parameter", @@ -46609,7 +46609,7 @@ "docs": null }, "type_v2/problem:NonVoidFunctionDefinition": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "NonVoidFunctionDefinition", @@ -47010,7 +47010,7 @@ "docs": null }, "type_v2/problem:VoidFunctionSignature": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "VoidFunctionSignature", @@ -47280,7 +47280,7 @@ "docs": null }, "type_v2/problem:NonVoidFunctionSignature": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "NonVoidFunctionSignature", @@ -47644,7 +47644,7 @@ "docs": null }, "type_v2/problem:VoidFunctionSignatureThatTakesActualResult": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "VoidFunctionSignatureThatTakesActualResult", @@ -48008,7 +48008,7 @@ "docs": null }, "type_v2/problem:AssertCorrectnessCheck": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "AssertCorrectnessCheck", @@ -48429,7 +48429,7 @@ "docs": null }, "type_v2/problem:DeepEqualityCorrectnessCheck": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "DeepEqualityCorrectnessCheck", @@ -48689,7 +48689,7 @@ "docs": null }, "type_v2/problem:VoidFunctionDefinitionThatTakesActualResult": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "VoidFunctionDefinitionThatTakesActualResult", @@ -49095,7 +49095,7 @@ "docs": "The generated signature will include an additional param, actualResult" }, "type_v2/problem:TestCaseImplementationDescription": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseImplementationDescription", @@ -49362,7 +49362,7 @@ "docs": null }, "type_v2/problem:TestCaseImplementationDescriptionBoard": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseImplementationDescriptionBoard", @@ -49732,7 +49732,7 @@ "docs": null }, "type_v2/problem:TestCaseMetadata": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseMetadata", @@ -50062,7 +50062,7 @@ "docs": null }, "type_v2/problem:FunctionImplementationForMultipleLanguages": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "FunctionImplementationForMultipleLanguages", @@ -50397,7 +50397,7 @@ "docs": null }, "type_v2/problem:FunctionImplementation": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "FunctionImplementation", @@ -50602,7 +50602,7 @@ "docs": null }, "type_v2/problem:GeneratedFiles": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GeneratedFiles", @@ -51352,7 +51352,7 @@ "docs": null }, "type_v2/problem:CustomFiles": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "CustomFiles", @@ -51878,7 +51878,7 @@ "docs": null }, "type_v2/problem:BasicCustomFiles": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "BasicCustomFiles", @@ -52527,7 +52527,7 @@ "docs": null }, "type_v2/problem:Files": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Files", @@ -52793,7 +52793,7 @@ "docs": null }, "type_v2/problem:FileInfoV2": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "FileInfoV2", @@ -53062,7 +53062,7 @@ "docs": null }, "type_v2/problem:DefaultProvidedFile": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "DefaultProvidedFile", @@ -53425,7 +53425,7 @@ "docs": null }, "type_v2/problem:FunctionSignature": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "FunctionSignature", @@ -53976,7 +53976,7 @@ "docs": null }, "type_v2/problem:GetFunctionSignatureRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GetFunctionSignatureRequest", @@ -54244,7 +54244,7 @@ "docs": null }, "type_v2/problem:GetFunctionSignatureResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GetFunctionSignatureResponse", @@ -54482,7 +54482,7 @@ "docs": null }, "type_v2/problem:GetBasicSolutionFileRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GetBasicSolutionFileRequest", @@ -54784,7 +54784,7 @@ "docs": null }, "type_v2/problem:GetBasicSolutionFileResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GetBasicSolutionFileResponse", @@ -55119,7 +55119,7 @@ "docs": null }, "type_v2/problem:GetGeneratedTestCaseFileRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GetGeneratedTestCaseFileRequest", @@ -55553,7 +55553,7 @@ "docs": null }, "type_v2/problem:GetGeneratedTestCaseTemplateFileRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GetGeneratedTestCaseTemplateFileRequest", @@ -55833,7 +55833,7 @@ "docs": null }, "type_v2/v3/problem:TestCaseTemplateId": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseTemplateId", @@ -56013,7 +56013,7 @@ "docs": null }, "type_v2/v3/problem:TestCaseId": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseId", @@ -56193,7 +56193,7 @@ "docs": null }, "type_v2/v3/problem:ParameterId": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ParameterId", @@ -56373,7 +56373,7 @@ "docs": null }, "type_v2/v3/problem:ProblemInfoV2": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "ProblemInfoV2", @@ -57673,7 +57673,7 @@ "docs": null }, "type_v2/v3/problem:LightweightProblemInfoV2": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "LightweightProblemInfoV2", @@ -58109,7 +58109,7 @@ "docs": null }, "type_v2/v3/problem:CreateProblemRequestV2": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "CreateProblemRequestV2", @@ -59105,7 +59105,7 @@ "docs": null }, "type_v2/v3/problem:TestCaseV2": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseV2", @@ -60067,7 +60067,7 @@ "docs": null }, "type_v2/v3/problem:TestCaseExpects": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseExpects", @@ -60273,7 +60273,7 @@ "docs": null }, "type_v2/v3/problem:TestCaseImplementationReference": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseImplementationReference", @@ -60845,7 +60845,7 @@ "docs": null }, "type_v2/v3/problem:BasicTestCaseTemplate": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "BasicTestCaseTemplate", @@ -61563,7 +61563,7 @@ "docs": null }, "type_v2/v3/problem:TestCaseTemplate": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseTemplate", @@ -62126,7 +62126,7 @@ "docs": null }, "type_v2/v3/problem:TestCaseImplementation": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseImplementation", @@ -62650,7 +62650,7 @@ "docs": null }, "type_v2/v3/problem:TestCaseFunction": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseFunction", @@ -63190,7 +63190,7 @@ "docs": null }, "type_v2/v3/problem:TestCaseWithActualResultImplementation": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseWithActualResultImplementation", @@ -63709,7 +63709,7 @@ "docs": null }, "type_v2/v3/problem:VoidFunctionDefinition": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "VoidFunctionDefinition", @@ -64229,7 +64229,7 @@ "docs": null }, "type_v2/v3/problem:Parameter": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Parameter", @@ -64699,7 +64699,7 @@ "docs": null }, "type_v2/v3/problem:NonVoidFunctionDefinition": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "NonVoidFunctionDefinition", @@ -65214,7 +65214,7 @@ "docs": null }, "type_v2/v3/problem:VoidFunctionSignature": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "VoidFunctionSignature", @@ -65560,7 +65560,7 @@ "docs": null }, "type_v2/v3/problem:NonVoidFunctionSignature": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "NonVoidFunctionSignature", @@ -66000,7 +66000,7 @@ "docs": null }, "type_v2/v3/problem:VoidFunctionSignatureThatTakesActualResult": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "VoidFunctionSignatureThatTakesActualResult", @@ -66440,7 +66440,7 @@ "docs": null }, "type_v2/v3/problem:AssertCorrectnessCheck": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "AssertCorrectnessCheck", @@ -66975,7 +66975,7 @@ "docs": null }, "type_v2/v3/problem:DeepEqualityCorrectnessCheck": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "DeepEqualityCorrectnessCheck", @@ -67311,7 +67311,7 @@ "docs": null }, "type_v2/v3/problem:VoidFunctionDefinitionThatTakesActualResult": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "VoidFunctionDefinitionThatTakesActualResult", @@ -67831,7 +67831,7 @@ "docs": "The generated signature will include an additional param, actualResult" }, "type_v2/v3/problem:TestCaseImplementationDescription": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseImplementationDescription", @@ -68174,7 +68174,7 @@ "docs": null }, "type_v2/v3/problem:TestCaseImplementationDescriptionBoard": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseImplementationDescriptionBoard", @@ -68620,7 +68620,7 @@ "docs": null }, "type_v2/v3/problem:TestCaseMetadata": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TestCaseMetadata", @@ -69026,7 +69026,7 @@ "docs": null }, "type_v2/v3/problem:FunctionImplementationForMultipleLanguages": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "FunctionImplementationForMultipleLanguages", @@ -69437,7 +69437,7 @@ "docs": null }, "type_v2/v3/problem:FunctionImplementation": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "FunctionImplementation", @@ -69680,7 +69680,7 @@ "docs": null }, "type_v2/v3/problem:GeneratedFiles": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GeneratedFiles", @@ -70582,7 +70582,7 @@ "docs": null }, "type_v2/v3/problem:CustomFiles": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "CustomFiles", @@ -71222,7 +71222,7 @@ "docs": null }, "type_v2/v3/problem:BasicCustomFiles": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "BasicCustomFiles", @@ -72023,7 +72023,7 @@ "docs": null }, "type_v2/v3/problem:Files": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Files", @@ -72365,7 +72365,7 @@ "docs": null }, "type_v2/v3/problem:FileInfoV2": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "FileInfoV2", @@ -72672,7 +72672,7 @@ "docs": null }, "type_v2/v3/problem:DefaultProvidedFile": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "DefaultProvidedFile", @@ -73111,7 +73111,7 @@ "docs": null }, "type_v2/v3/problem:FunctionSignature": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "FunctionSignature", @@ -73814,7 +73814,7 @@ "docs": null }, "type_v2/v3/problem:GetFunctionSignatureRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GetFunctionSignatureRequest", @@ -74158,7 +74158,7 @@ "docs": null }, "type_v2/v3/problem:GetFunctionSignatureResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GetFunctionSignatureResponse", @@ -74434,7 +74434,7 @@ "docs": null }, "type_v2/v3/problem:GetBasicSolutionFileRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GetBasicSolutionFileRequest", @@ -74812,7 +74812,7 @@ "docs": null }, "type_v2/v3/problem:GetBasicSolutionFileResponse": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GetBasicSolutionFileResponse", @@ -75223,7 +75223,7 @@ "docs": null }, "type_v2/v3/problem:GetGeneratedTestCaseFileRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GetGeneratedTestCaseFileRequest", @@ -75771,7 +75771,7 @@ "docs": null }, "type_v2/v3/problem:GetGeneratedTestCaseTemplateFileRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GetGeneratedTestCaseTemplateFileRequest", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/ts-express-casing.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/ts-express-casing.json index 84249d24636..1767e33af02 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/ts-express-casing.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/ts-express-casing.json @@ -56,7 +56,7 @@ "idempotencyHeaders": [], "types": { "type_imdb:MovieId": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "MovieId", @@ -159,7 +159,7 @@ "docs": null }, "type_imdb:Movie": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Movie", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/undiscriminated-unions.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/undiscriminated-unions.json index 5054aa86dac..59a84b63a20 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/undiscriminated-unions.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/undiscriminated-unions.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_union:TypeWithOptionalUnion": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "TypeWithOptionalUnion", @@ -219,7 +219,7 @@ "docs": null }, "type_union:MyUnion": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "MyUnion", @@ -416,7 +416,7 @@ "docs": "Several different types are accepted." }, "type_union:Metadata": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Metadata", @@ -1251,7 +1251,7 @@ "docs": "Undiscriminated unions can act as a map key\nas long as all of their values are valid keys\n(i.e. do they have a valid string representation)." }, "type_union:Key": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Key", @@ -1420,7 +1420,7 @@ "docs": null }, "type_union:KeyType": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "KeyType", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/unions.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/unions.json index ecef2cce319..566e027c85a 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/unions.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/unions.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_types:Union": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Union", @@ -381,7 +381,7 @@ "docs": "This is a simple union." }, "type_types:UnionWithDiscriminant": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UnionWithDiscriminant", @@ -731,7 +731,7 @@ "docs": null }, "type_types:UnionWithPrimitive": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UnionWithPrimitive", @@ -964,7 +964,7 @@ "docs": null }, "type_types:UnionWithoutKey": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UnionWithoutKey", @@ -1260,7 +1260,7 @@ "docs": null }, "type_types:UnionWithUnknown": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UnionWithUnknown", @@ -1492,7 +1492,7 @@ "docs": null }, "type_types:UnionWithLiteral": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UnionWithLiteral", @@ -1698,7 +1698,7 @@ "docs": null }, "type_types:UnionWithBaseProperties": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UnionWithBaseProperties", @@ -2064,7 +2064,7 @@ "docs": null }, "type_types:UnionWithTime": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UnionWithTime", @@ -2352,7 +2352,7 @@ "docs": null }, "type_types:UnionWithOptionalTime": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UnionWithOptionalTime", @@ -2589,7 +2589,7 @@ "docs": null }, "type_types:UnionWithSingleElement": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UnionWithSingleElement", @@ -2791,7 +2791,7 @@ "docs": null }, "type_types:Foo": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Foo", @@ -2914,7 +2914,7 @@ "docs": null }, "type_types:Bar": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Bar", @@ -3037,7 +3037,7 @@ "docs": null }, "type_union:GetShapeRequest": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "GetShapeRequest", @@ -3160,7 +3160,7 @@ "docs": null }, "type_union:Shape": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Shape", @@ -3494,7 +3494,7 @@ "docs": null }, "type_union:Circle": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Circle", @@ -3617,7 +3617,7 @@ "docs": null }, "type_union:Square": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Square", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/unknown.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/unknown.json index 5d51200a7d9..b9ec8c53d29 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/unknown.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/unknown.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_unknown:MyAlias": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "MyAlias", @@ -118,7 +118,7 @@ "docs": null }, "type_unknown:MyObject": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "MyObject", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/validation.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/validation.json index f227096944d..69b0b5b18f1 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/validation.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/validation.json @@ -31,7 +31,7 @@ "idempotencyHeaders": [], "types": { "type_:SmallInteger": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "SmallInteger", @@ -102,7 +102,7 @@ "docs": null }, "type_:LargeInteger": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "LargeInteger", @@ -173,7 +173,7 @@ "docs": null }, "type_:Double": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Double", @@ -244,7 +244,7 @@ "docs": null }, "type_:Word": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Word", @@ -314,7 +314,7 @@ "docs": null }, "type_:Sentence": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Sentence", @@ -384,7 +384,7 @@ "docs": null }, "type_:Shape": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Shape", @@ -533,7 +533,7 @@ "docs": null }, "type_:Type": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "Type", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/version-no-default.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/version-no-default.json index d6dc195d2d2..3fd6277f417 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/version-no-default.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/version-no-default.json @@ -154,7 +154,7 @@ "idempotencyHeaders": [], "types": { "type_user:UserId": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UserId", @@ -257,7 +257,7 @@ "docs": null }, "type_user:User": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "User", diff --git a/packages/cli/generation/ir-generator/src/__test__/test-definitions/version.json b/packages/cli/generation/ir-generator/src/__test__/test-definitions/version.json index 1ddd610bcc3..6eafb7c626d 100644 --- a/packages/cli/generation/ir-generator/src/__test__/test-definitions/version.json +++ b/packages/cli/generation/ir-generator/src/__test__/test-definitions/version.json @@ -179,7 +179,7 @@ "idempotencyHeaders": [], "types": { "type_user:UserId": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "UserId", @@ -282,7 +282,7 @@ "docs": null }, "type_user:User": { - "inline": false, + "inline": null, "name": { "name": { "originalName": "User", diff --git a/packages/cli/generation/ir-generator/src/converters/type-declarations/convertTypeDeclaration.ts b/packages/cli/generation/ir-generator/src/converters/type-declarations/convertTypeDeclaration.ts index 09ae58a9532..1b8191dc11f 100644 --- a/packages/cli/generation/ir-generator/src/converters/type-declarations/convertTypeDeclaration.ts +++ b/packages/cli/generation/ir-generator/src/converters/type-declarations/convertTypeDeclaration.ts @@ -66,7 +66,7 @@ export async function convertTypeDeclaration({ propertiesByAudience, typeDeclaration: { ...declaration, - inline: false, + inline: getInline(typeDeclaration), name: declaredTypeName, shape: await convertType({ typeDeclaration, file, typeResolver }), referencedTypes: new Set(referencedTypes.map((referencedType) => referencedType.typeId)), @@ -195,3 +195,12 @@ function convertSourceToEncoding(source: Source | undefined): Encoding { proto: undefined }; } +function getInline(typeDeclaration: RawSchemas.TypeDeclarationSchema): boolean | undefined { + if (typeof typeDeclaration === "string") { + return undefined; + } + if ("inline" in typeDeclaration) { + return typeDeclaration.inline; + } + return undefined; +} diff --git a/packages/cli/generation/ir-generator/src/dynamic-snippets/__test__/test-definitions/inline-types.json b/packages/cli/generation/ir-generator/src/dynamic-snippets/__test__/test-definitions/inline-types.json new file mode 100644 index 00000000000..23dd9812125 --- /dev/null +++ b/packages/cli/generation/ir-generator/src/dynamic-snippets/__test__/test-definitions/inline-types.json @@ -0,0 +1,754 @@ +{ + "version": "1.0.0", + "types": { + "type_:RootType1": { + "type": "object", + "declaration": { + "name": { + "originalName": "RootType1", + "camelCase": { + "unsafeName": "rootType1", + "safeName": "rootType1" + }, + "snakeCase": { + "unsafeName": "root_type1", + "safeName": "root_type1" + }, + "screamingSnakeCase": { + "unsafeName": "ROOT_TYPE1", + "safeName": "ROOT_TYPE1" + }, + "pascalCase": { + "unsafeName": "RootType1", + "safeName": "RootType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "typeReference": { + "_type": "primitive", + "value": "STRING" + } + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "typeReference": { + "_type": "named", + "value": "type_:InlineType1" + } + } + ] + }, + "type_:InlineType1": { + "type": "object", + "declaration": { + "name": { + "originalName": "InlineType1", + "camelCase": { + "unsafeName": "inlineType1", + "safeName": "inlineType1" + }, + "snakeCase": { + "unsafeName": "inline_type1", + "safeName": "inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_TYPE1", + "safeName": "INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "InlineType1", + "safeName": "InlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "typeReference": { + "_type": "primitive", + "value": "STRING" + } + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "typeReference": { + "_type": "named", + "value": "type_:NestedInlineType1" + } + } + ] + }, + "type_:InlineType2": { + "type": "object", + "declaration": { + "name": { + "originalName": "InlineType2", + "camelCase": { + "unsafeName": "inlineType2", + "safeName": "inlineType2" + }, + "snakeCase": { + "unsafeName": "inline_type2", + "safeName": "inline_type2" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_TYPE2", + "safeName": "INLINE_TYPE2" + }, + "pascalCase": { + "unsafeName": "InlineType2", + "safeName": "InlineType2" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "properties": [ + { + "name": { + "name": { + "originalName": "baz", + "camelCase": { + "unsafeName": "baz", + "safeName": "baz" + }, + "snakeCase": { + "unsafeName": "baz", + "safeName": "baz" + }, + "screamingSnakeCase": { + "unsafeName": "BAZ", + "safeName": "BAZ" + }, + "pascalCase": { + "unsafeName": "Baz", + "safeName": "Baz" + } + }, + "wireValue": "baz" + }, + "typeReference": { + "_type": "primitive", + "value": "STRING" + } + } + ] + }, + "type_:NestedInlineType1": { + "type": "object", + "declaration": { + "name": { + "originalName": "NestedInlineType1", + "camelCase": { + "unsafeName": "nestedInlineType1", + "safeName": "nestedInlineType1" + }, + "snakeCase": { + "unsafeName": "nested_inline_type1", + "safeName": "nested_inline_type1" + }, + "screamingSnakeCase": { + "unsafeName": "NESTED_INLINE_TYPE1", + "safeName": "NESTED_INLINE_TYPE1" + }, + "pascalCase": { + "unsafeName": "NestedInlineType1", + "safeName": "NestedInlineType1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "properties": [ + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "typeReference": { + "_type": "primitive", + "value": "STRING" + } + }, + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "typeReference": { + "_type": "primitive", + "value": "STRING" + } + }, + { + "name": { + "name": { + "originalName": "myEnum", + "camelCase": { + "unsafeName": "myEnum", + "safeName": "myEnum" + }, + "snakeCase": { + "unsafeName": "my_enum", + "safeName": "my_enum" + }, + "screamingSnakeCase": { + "unsafeName": "MY_ENUM", + "safeName": "MY_ENUM" + }, + "pascalCase": { + "unsafeName": "MyEnum", + "safeName": "MyEnum" + } + }, + "wireValue": "myEnum" + }, + "typeReference": { + "_type": "named", + "value": "type_:InlineEnum" + } + } + ] + }, + "type_:InlinedDiscriminatedUnion1": { + "type": "discriminatedUnion", + "declaration": { + "name": { + "originalName": "InlinedDiscriminatedUnion1", + "camelCase": { + "unsafeName": "inlinedDiscriminatedUnion1", + "safeName": "inlinedDiscriminatedUnion1" + }, + "snakeCase": { + "unsafeName": "inlined_discriminated_union1", + "safeName": "inlined_discriminated_union1" + }, + "screamingSnakeCase": { + "unsafeName": "INLINED_DISCRIMINATED_UNION1", + "safeName": "INLINED_DISCRIMINATED_UNION1" + }, + "pascalCase": { + "unsafeName": "InlinedDiscriminatedUnion1", + "safeName": "InlinedDiscriminatedUnion1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "discriminant": { + "name": { + "originalName": "type", + "camelCase": { + "unsafeName": "type", + "safeName": "type" + }, + "snakeCase": { + "unsafeName": "type", + "safeName": "type" + }, + "screamingSnakeCase": { + "unsafeName": "TYPE", + "safeName": "TYPE" + }, + "pascalCase": { + "unsafeName": "Type", + "safeName": "Type" + } + }, + "wireValue": "type" + }, + "types": { + "type1": { + "type": "samePropertiesAsObject", + "typeId": "type_:InlineType1", + "discriminantValue": { + "name": { + "originalName": "type1", + "camelCase": { + "unsafeName": "type1", + "safeName": "type1" + }, + "snakeCase": { + "unsafeName": "type1", + "safeName": "type1" + }, + "screamingSnakeCase": { + "unsafeName": "TYPE1", + "safeName": "TYPE1" + }, + "pascalCase": { + "unsafeName": "Type1", + "safeName": "Type1" + } + }, + "wireValue": "type1" + }, + "properties": [] + }, + "type2": { + "type": "samePropertiesAsObject", + "typeId": "type_:InlineType2", + "discriminantValue": { + "name": { + "originalName": "type2", + "camelCase": { + "unsafeName": "type2", + "safeName": "type2" + }, + "snakeCase": { + "unsafeName": "type2", + "safeName": "type2" + }, + "screamingSnakeCase": { + "unsafeName": "TYPE2", + "safeName": "TYPE2" + }, + "pascalCase": { + "unsafeName": "Type2", + "safeName": "Type2" + } + }, + "wireValue": "type2" + }, + "properties": [] + } + } + }, + "type_:InlinedUndiscriminatedUnion1": { + "type": "undiscriminatedUnion", + "declaration": { + "name": { + "originalName": "InlinedUndiscriminatedUnion1", + "camelCase": { + "unsafeName": "inlinedUndiscriminatedUnion1", + "safeName": "inlinedUndiscriminatedUnion1" + }, + "snakeCase": { + "unsafeName": "inlined_undiscriminated_union1", + "safeName": "inlined_undiscriminated_union1" + }, + "screamingSnakeCase": { + "unsafeName": "INLINED_UNDISCRIMINATED_UNION1", + "safeName": "INLINED_UNDISCRIMINATED_UNION1" + }, + "pascalCase": { + "unsafeName": "InlinedUndiscriminatedUnion1", + "safeName": "InlinedUndiscriminatedUnion1" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "types": [ + { + "_type": "named", + "value": "type_:InlineType1" + }, + { + "_type": "named", + "value": "type_:InlineType2" + } + ] + }, + "type_:InlineEnum": { + "type": "enum", + "declaration": { + "name": { + "originalName": "InlineEnum", + "camelCase": { + "unsafeName": "inlineEnum", + "safeName": "inlineEnum" + }, + "snakeCase": { + "unsafeName": "inline_enum", + "safeName": "inline_enum" + }, + "screamingSnakeCase": { + "unsafeName": "INLINE_ENUM", + "safeName": "INLINE_ENUM" + }, + "pascalCase": { + "unsafeName": "InlineEnum", + "safeName": "InlineEnum" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "values": [ + { + "name": { + "originalName": "SUNNY", + "camelCase": { + "unsafeName": "sunny", + "safeName": "sunny" + }, + "snakeCase": { + "unsafeName": "sunny", + "safeName": "sunny" + }, + "screamingSnakeCase": { + "unsafeName": "SUNNY", + "safeName": "SUNNY" + }, + "pascalCase": { + "unsafeName": "Sunny", + "safeName": "Sunny" + } + }, + "wireValue": "SUNNY" + }, + { + "name": { + "originalName": "CLOUDY", + "camelCase": { + "unsafeName": "cloudy", + "safeName": "cloudy" + }, + "snakeCase": { + "unsafeName": "cloudy", + "safeName": "cloudy" + }, + "screamingSnakeCase": { + "unsafeName": "CLOUDY", + "safeName": "CLOUDY" + }, + "pascalCase": { + "unsafeName": "Cloudy", + "safeName": "Cloudy" + } + }, + "wireValue": "CLOUDY" + }, + { + "name": { + "originalName": "RAINING", + "camelCase": { + "unsafeName": "raining", + "safeName": "raining" + }, + "snakeCase": { + "unsafeName": "raining", + "safeName": "raining" + }, + "screamingSnakeCase": { + "unsafeName": "RAINING", + "safeName": "RAINING" + }, + "pascalCase": { + "unsafeName": "Raining", + "safeName": "Raining" + } + }, + "wireValue": "RAINING" + }, + { + "name": { + "originalName": "SNOWING", + "camelCase": { + "unsafeName": "snowing", + "safeName": "snowing" + }, + "snakeCase": { + "unsafeName": "snowing", + "safeName": "snowing" + }, + "screamingSnakeCase": { + "unsafeName": "SNOWING", + "safeName": "SNOWING" + }, + "pascalCase": { + "unsafeName": "Snowing", + "safeName": "Snowing" + } + }, + "wireValue": "SNOWING" + } + ] + } + }, + "headers": [], + "endpoints": { + "endpoint_.getRoot": { + "auth": null, + "declaration": { + "name": { + "originalName": "getRoot", + "camelCase": { + "unsafeName": "getRoot", + "safeName": "getRoot" + }, + "snakeCase": { + "unsafeName": "get_root", + "safeName": "get_root" + }, + "screamingSnakeCase": { + "unsafeName": "GET_ROOT", + "safeName": "GET_ROOT" + }, + "pascalCase": { + "unsafeName": "GetRoot", + "safeName": "GetRoot" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "location": { + "method": "POST", + "path": "/root/root" + }, + "request": { + "type": "inlined", + "declaration": { + "name": { + "originalName": "PostRootRequest", + "camelCase": { + "unsafeName": "postRootRequest", + "safeName": "postRootRequest" + }, + "snakeCase": { + "unsafeName": "post_root_request", + "safeName": "post_root_request" + }, + "screamingSnakeCase": { + "unsafeName": "POST_ROOT_REQUEST", + "safeName": "POST_ROOT_REQUEST" + }, + "pascalCase": { + "unsafeName": "PostRootRequest", + "safeName": "PostRootRequest" + } + }, + "fernFilepath": { + "allParts": [], + "packagePath": [], + "file": null + } + }, + "pathParameters": [], + "queryParameters": [], + "headers": [], + "body": { + "type": "properties", + "value": [ + { + "name": { + "name": { + "originalName": "bar", + "camelCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "snakeCase": { + "unsafeName": "bar", + "safeName": "bar" + }, + "screamingSnakeCase": { + "unsafeName": "BAR", + "safeName": "BAR" + }, + "pascalCase": { + "unsafeName": "Bar", + "safeName": "Bar" + } + }, + "wireValue": "bar" + }, + "typeReference": { + "_type": "named", + "value": "type_:InlineType1" + } + }, + { + "name": { + "name": { + "originalName": "foo", + "camelCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "snakeCase": { + "unsafeName": "foo", + "safeName": "foo" + }, + "screamingSnakeCase": { + "unsafeName": "FOO", + "safeName": "FOO" + }, + "pascalCase": { + "unsafeName": "Foo", + "safeName": "Foo" + } + }, + "wireValue": "foo" + }, + "typeReference": { + "_type": "primitive", + "value": "STRING" + } + } + ] + }, + "metadata": { + "includePathParameters": false, + "onlyPathParameters": false + } + }, + "response": { + "type": "json" + } + } + } +} \ No newline at end of file diff --git a/packages/cli/generation/ir-generator/src/utils/parseInlineType.ts b/packages/cli/generation/ir-generator/src/utils/parseInlineType.ts index 6751be0210e..e49c830fa3f 100644 --- a/packages/cli/generation/ir-generator/src/utils/parseInlineType.ts +++ b/packages/cli/generation/ir-generator/src/utils/parseInlineType.ts @@ -42,9 +42,14 @@ export type TypeReferenceParser = (type: RawSchemas.TypeReferenceSchema) => Type export function createTypeReferenceParser(file: FernFileContext): TypeReferenceParser { return (type) => { - const typeAsString = typeof type === "string" ? type : type.type; - const _default = typeof type === "string" ? undefined : type.default; - const validation = typeof type === "string" ? undefined : type.validation; - return parseInlineType({ type: typeAsString, _default, validation, file }); + if (typeof type === "string") { + return parseInlineType({ type, _default: undefined, validation: undefined, file }); + } + return parseInlineType({ + type: type.type, + _default: type.default, + validation: type.validation, + file + }); }; } diff --git a/packages/cli/lazy-fern-workspace/src/fern.schema.json b/packages/cli/lazy-fern-workspace/src/fern.schema.json index 349f5983914..e5cc6843dc6 100644 --- a/packages/cli/lazy-fern-workspace/src/fern.schema.json +++ b/packages/cli/lazy-fern-workspace/src/fern.schema.json @@ -497,6 +497,16 @@ } ] }, + "inline": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, "docs": { "oneOf": [ { @@ -700,6 +710,16 @@ } ] }, + "inline": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, "docs": { "oneOf": [ { @@ -1033,6 +1053,16 @@ } ] }, + "inline": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, "docs": { "oneOf": [ { @@ -1189,6 +1219,16 @@ } ] }, + "inline": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, "docs": { "oneOf": [ { @@ -1274,6 +1314,16 @@ } ] }, + "inline": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, "docs": { "oneOf": [ { diff --git a/packages/cli/lazy-fern-workspace/src/package-yml.schema.json b/packages/cli/lazy-fern-workspace/src/package-yml.schema.json index ea25e26f1c9..066469c46ac 100644 --- a/packages/cli/lazy-fern-workspace/src/package-yml.schema.json +++ b/packages/cli/lazy-fern-workspace/src/package-yml.schema.json @@ -517,6 +517,16 @@ } ] }, + "inline": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, "docs": { "oneOf": [ { @@ -720,6 +730,16 @@ } ] }, + "inline": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, "docs": { "oneOf": [ { @@ -1053,6 +1073,16 @@ } ] }, + "inline": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, "docs": { "oneOf": [ { @@ -1209,6 +1239,16 @@ } ] }, + "inline": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, "docs": { "oneOf": [ { @@ -1294,6 +1334,16 @@ } ] }, + "inline": { + "oneOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ] + }, "docs": { "oneOf": [ { diff --git a/packages/cli/register/src/ir-to-fdr-converter/__test__/__snapshots__/inline-types.json b/packages/cli/register/src/ir-to-fdr-converter/__test__/__snapshots__/inline-types.json new file mode 100644 index 00000000000..bcdd5f5231b --- /dev/null +++ b/packages/cli/register/src/ir-to-fdr-converter/__test__/__snapshots__/inline-types.json @@ -0,0 +1,326 @@ +{ + "types": { + "type_:RootType1": { + "name": "RootType1", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "foo", + "valueType": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "bar", + "valueType": { + "type": "id", + "value": "type_:InlineType1" + } + } + ], + "extraProperties": { + "type": "unknown" + } + } + }, + "type_:InlineType1": { + "name": "InlineType1", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "foo", + "valueType": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "bar", + "valueType": { + "type": "id", + "value": "type_:NestedInlineType1" + } + } + ], + "extraProperties": { + "type": "unknown" + } + } + }, + "type_:InlineType2": { + "name": "InlineType2", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "baz", + "valueType": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ], + "extraProperties": { + "type": "unknown" + } + } + }, + "type_:NestedInlineType1": { + "name": "NestedInlineType1", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "foo", + "valueType": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "bar", + "valueType": { + "type": "primitive", + "value": { + "type": "string" + } + } + }, + { + "key": "myEnum", + "valueType": { + "type": "id", + "value": "type_:InlineEnum" + } + } + ], + "extraProperties": { + "type": "unknown" + } + } + }, + "type_:InlinedDiscriminatedUnion1": { + "name": "InlinedDiscriminatedUnion1", + "shape": { + "type": "discriminatedUnion", + "discriminant": "type", + "variants": [ + { + "discriminantValue": "type1", + "additionalProperties": { + "extends": [ + "type_:InlineType1" + ], + "properties": [] + } + }, + { + "discriminantValue": "type2", + "additionalProperties": { + "extends": [ + "type_:InlineType2" + ], + "properties": [] + } + } + ] + } + }, + "type_:InlinedUndiscriminatedUnion1": { + "name": "InlinedUndiscriminatedUnion1", + "shape": { + "type": "undiscriminatedUnion", + "variants": [ + { + "typeName": "InlineType1", + "type": { + "type": "id", + "value": "type_:InlineType1" + } + }, + { + "typeName": "InlineType2", + "type": { + "type": "id", + "value": "type_:InlineType2" + } + } + ] + } + }, + "type_:InlineEnum": { + "name": "InlineEnum", + "shape": { + "type": "enum", + "values": [ + { + "value": "SUNNY" + }, + { + "value": "CLOUDY" + }, + { + "value": "RAINING" + }, + { + "value": "SNOWING" + } + ] + } + } + }, + "subpackages": {}, + "rootPackage": { + "endpoints": [ + { + "auth": false, + "method": "POST", + "id": "getRoot", + "originalEndpointId": "endpoint_.getRoot", + "name": "Get Root", + "path": { + "pathParameters": [], + "parts": [ + { + "type": "literal", + "value": "/root" + }, + { + "type": "literal", + "value": "/root" + } + ] + }, + "queryParameters": [], + "headers": [], + "request": { + "type": { + "type": "json", + "contentType": "application/json", + "shape": { + "type": "object", + "extends": [], + "properties": [ + { + "key": "bar", + "valueType": { + "type": "id", + "value": "type_:InlineType1" + } + }, + { + "key": "foo", + "valueType": { + "type": "primitive", + "value": { + "type": "string" + } + } + } + ] + } + } + }, + "response": { + "type": { + "type": "reference", + "value": { + "type": "id", + "value": "type_:RootType1" + } + } + }, + "errorsV2": [], + "examples": [ + { + "path": "/root/root", + "pathParameters": {}, + "queryParameters": {}, + "headers": {}, + "requestBody": { + "bar": { + "foo": "foo", + "bar": { + "foo": "foo", + "bar": "bar", + "myEnum": "SUNNY" + } + }, + "foo": "foo" + }, + "requestBodyV3": { + "type": "json", + "value": { + "bar": { + "foo": "foo", + "bar": { + "foo": "foo", + "bar": "bar", + "myEnum": "SUNNY" + } + }, + "foo": "foo" + } + }, + "responseStatusCode": 200, + "responseBody": { + "foo": "foo", + "bar": { + "foo": "foo", + "bar": { + "foo": "foo", + "bar": "bar", + "myEnum": "SUNNY" + } + } + }, + "responseBodyV3": { + "type": "json", + "value": { + "foo": "foo", + "bar": { + "foo": "foo", + "bar": { + "foo": "foo", + "bar": "bar", + "myEnum": "SUNNY" + } + } + } + }, + "codeSamples": [] + } + ] + } + ], + "webhooks": [], + "websockets": [], + "types": [ + "type_:RootType1", + "type_:InlineType1", + "type_:InlineType2", + "type_:NestedInlineType1", + "type_:InlinedDiscriminatedUnion1", + "type_:InlinedUndiscriminatedUnion1", + "type_:InlineEnum" + ], + "subpackages": [] + }, + "snippetsConfiguration": {}, + "globalHeaders": [] +} \ No newline at end of file diff --git a/packages/commons/core-utils/src/validateAgainstJsonSchema.ts b/packages/commons/core-utils/src/validateAgainstJsonSchema.ts index 527707990a8..4009b172609 100644 --- a/packages/commons/core-utils/src/validateAgainstJsonSchema.ts +++ b/packages/commons/core-utils/src/validateAgainstJsonSchema.ts @@ -54,7 +54,7 @@ export function validateAgainstJsonSchema( return { success: false, error: { - message: "Failed to parse", + message: "Failed to parse because JSON schema validation failed", keyword: "unknown", instancePath: "", schemaPath: "", @@ -65,7 +65,7 @@ export function validateAgainstJsonSchema( return { success: false, error: { - message: "Failed to parse", + message: "Failed to parse because JSON schema validation failed", keyword: "unknown", instancePath: "", schemaPath: "", diff --git a/packages/ir-sdk/fern/apis/ir-types-latest/definition/commons.yml b/packages/ir-sdk/fern/apis/ir-types-latest/definition/commons.yml index bd77aeaa828..781c25fa1ce 100644 --- a/packages/ir-sdk/fern/apis/ir-types-latest/definition/commons.yml +++ b/packages/ir-sdk/fern/apis/ir-types-latest/definition/commons.yml @@ -90,4 +90,4 @@ types: type: optional docs: | The subpackage that defines the endpoint. If empty, the endpoint is - defined in the root package. \ No newline at end of file + defined in the root package. diff --git a/packages/ir-sdk/fern/apis/ir-types-latest/definition/types.yml b/packages/ir-sdk/fern/apis/ir-types-latest/definition/types.yml index 8187c08f1aa..48c0f173782 100644 --- a/packages/ir-sdk/fern/apis/ir-types-latest/definition/types.yml +++ b/packages/ir-sdk/fern/apis/ir-types-latest/definition/types.yml @@ -20,7 +20,7 @@ types: ProtoEncoding: properties: {} - + TypeDeclaration: docs: "A type, which is a name and a shape" extends: commons.Declaration @@ -34,7 +34,7 @@ types: type: set encoding: optional source: optional - inline: + inline: type: optional docs: Whether to try and inline the type declaration @@ -98,9 +98,9 @@ types: docs: A list of other types to inherit from type: list properties: list - extendedProperties: + extendedProperties: type: optional> - docs: A list of properties that all the parents of this object have. + docs: A list of properties that all the parents of this object have. extra-properties: docs: Whether to allow extra properties on the object. type: boolean @@ -169,7 +169,10 @@ types: fernFilepath: commons.FernFilepath name: commons.Name default: optional - inline: optional + inline: + type: optional + availability: deprecated + docs: Use the inline property on the TypeDeclaration instead. NamedTypeDefault: union: @@ -348,23 +351,23 @@ types: properties: discriminant: commons.NameAndWireValue singleUnionType: ExampleSingleUnionType - - ExampleUndiscriminatedUnionType: - properties: + + ExampleUndiscriminatedUnionType: + properties: index: type: integer - docs: | - The zero-based index of the undiscriminated union variant. - For the following undiscriminated union + docs: | + The zero-based index of the undiscriminated union variant. + For the following undiscriminated union ``` - MyUnion: + MyUnion: discriminated: false - union: + union: - string - integer ``` a string example would have an index 0 and an integer example - would have an index 1. + would have an index 1. singleUnionType: ExampleTypeReference ExampleSingleUnionType: @@ -473,9 +476,9 @@ types: bigInteger: type: bigint key: bigInteger - - ExampleDatetime: - properties: + + ExampleDatetime: + properties: datetime: datetime raw: optional diff --git a/packages/ir-sdk/fern/fern.config.json b/packages/ir-sdk/fern/fern.config.json index 74b19788a58..125c02d269f 100644 --- a/packages/ir-sdk/fern/fern.config.json +++ b/packages/ir-sdk/fern/fern.config.json @@ -1,4 +1,4 @@ { "organization": "fern", - "version": "0.44.11" + "version": "0.45.0" } \ No newline at end of file diff --git a/packages/ir-sdk/src/sdk/api/resources/types/types/ContainerType.ts b/packages/ir-sdk/src/sdk/api/resources/types/types/ContainerType.ts index d3186b007d0..98290dc280e 100644 --- a/packages/ir-sdk/src/sdk/api/resources/types/types/ContainerType.ts +++ b/packages/ir-sdk/src/sdk/api/resources/types/types/ContainerType.ts @@ -55,7 +55,7 @@ export const ContainerType = { return { list: value, type: "list", - _visit: function <_Result>( + _visit <_Result>( this: FernIr.ContainerType.List, visitor: FernIr.ContainerType._Visitor<_Result> ) { @@ -68,7 +68,7 @@ export const ContainerType = { return { ...value, type: "map", - _visit: function <_Result>( + _visit <_Result>( this: FernIr.ContainerType.Map, visitor: FernIr.ContainerType._Visitor<_Result> ) { @@ -81,7 +81,7 @@ export const ContainerType = { return { optional: value, type: "optional", - _visit: function <_Result>( + _visit <_Result>( this: FernIr.ContainerType.Optional, visitor: FernIr.ContainerType._Visitor<_Result> ) { @@ -94,7 +94,7 @@ export const ContainerType = { return { set: value, type: "set", - _visit: function <_Result>( + _visit <_Result>( this: FernIr.ContainerType.Set, visitor: FernIr.ContainerType._Visitor<_Result> ) { @@ -107,7 +107,7 @@ export const ContainerType = { return { literal: value, type: "literal", - _visit: function <_Result>( + _visit <_Result>( this: FernIr.ContainerType.Literal, visitor: FernIr.ContainerType._Visitor<_Result> ) { diff --git a/packages/ir-sdk/src/sdk/api/resources/types/types/NamedType.ts b/packages/ir-sdk/src/sdk/api/resources/types/types/NamedType.ts index c63cb429090..4ecdf65a8f9 100644 --- a/packages/ir-sdk/src/sdk/api/resources/types/types/NamedType.ts +++ b/packages/ir-sdk/src/sdk/api/resources/types/types/NamedType.ts @@ -13,5 +13,6 @@ export interface NamedType { fernFilepath: FernIr.FernFilepath; name: FernIr.Name; default: FernIr.NamedTypeDefault | undefined; + /** Use the inline property on the TypeDeclaration instead. */ inline: boolean | undefined; } diff --git a/test-definitions-openapi/fern/apis/inline-schema-reference/openapi.yml b/test-definitions-openapi/fern/apis/inline-schema-reference/openapi.yml index 1aed83d6cbb..6defb379eb1 100644 --- a/test-definitions-openapi/fern/apis/inline-schema-reference/openapi.yml +++ b/test-definitions-openapi/fern/apis/inline-schema-reference/openapi.yml @@ -7,15 +7,59 @@ paths: get: summary: Get Example responses: - '200': + "200": description: Successful response content: application/json: schema: oneOf: - - $ref: "#/components/responses/NotFound/content/application~1json/schema" - $ref: "#/components/schemas/Schema1" - $ref: "#/components/schemas/Schema2" + /root: + post: + requestBody: + content: + application/json: + schema: + type: object + properties: + foo: + type: string + bar: + type: object + properties: + foo: + type: string + inner_bar: + type: object + properties: + foo: + type: string + bar: + type: string + responses: + "200": + description: Successful response + content: + application/json: + schema: + type: object + properties: + foo: + type: string + bar: + type: object + properties: + foo: + type: string + inner_bar: + type: object + properties: + foo: + type: string + bar: + type: string + components: responses: NotFound: @@ -42,3 +86,31 @@ components: type: string age: type: integer + testEnum: + type: string + enum: + - test1 + - test2 + - test3 + testDiscriminatedUnion: + discriminator: + propertyName: objectType + oneOf: + - type: object + properties: + objectType: + type: string + - type: object + properties: + objectType: + type: string + testUnion: + oneOf: + - type: object + properties: + a: + type: string + - type: object + properties: + b: + type: string diff --git a/test-definitions/fern/apis/inline-types/definition/__package__.yml b/test-definitions/fern/apis/inline-types/definition/__package__.yml new file mode 100644 index 00000000000..a2a0cbfac7c --- /dev/null +++ b/test-definitions/fern/apis/inline-types/definition/__package__.yml @@ -0,0 +1,61 @@ +service: + base-path: /root + auth: false + endpoints: + getRoot: + path: /root + method: POST + request: + body: + properties: + bar: InlineType1 + foo: string + content-type: application/json + name: PostRootRequest + response: RootType1 + +types: + RootType1: + properties: + foo: string + bar: InlineType1 + + InlineType1: + inline: true + properties: + foo: string + bar: + type: NestedInlineType1 + + InlineType2: + inline: true + properties: + baz: string + + NestedInlineType1: + inline: true + properties: + foo: string + bar: string + myEnum: InlineEnum + + InlinedDiscriminatedUnion1: + inline: true + union: + type1: InlineType1 + type2: InlineType2 + + InlinedUndiscriminatedUnion1: + inline: true + discriminated: false + union: + - type: InlineType1 + - type: InlineType2 + + InlineEnum: + inline: true + enum: + - SUNNY + - CLOUDY + - RAINING + - SNOWING diff --git a/test-definitions/fern/apis/inline-types/definition/api.yml b/test-definitions/fern/apis/inline-types/definition/api.yml new file mode 100644 index 00000000000..a82930c145b --- /dev/null +++ b/test-definitions/fern/apis/inline-types/definition/api.yml @@ -0,0 +1 @@ +name: object diff --git a/test-definitions/fern/apis/inline-types/generators.yml b/test-definitions/fern/apis/inline-types/generators.yml new file mode 100644 index 00000000000..0967ef424bc --- /dev/null +++ b/test-definitions/fern/apis/inline-types/generators.yml @@ -0,0 +1 @@ +{}