diff --git a/aspida.config.js b/aspida.config.js index 8d41c3a5..5a5b654c 100644 --- a/aspida.config.js +++ b/aspida.config.js @@ -38,10 +38,10 @@ module.exports = [ input: 'samples/array-one-of', outputEachDir: true, openapi: { inputFile: 'samples/array-one-of.yml' } - }, - { - input: 'samples/path-at-mark', - outputEachDir: true, - openapi: { inputFile: 'samples/path-at-mark.yml', replaceLeadingAtMark: '' } } + // { + // input: 'samples/path-at-mark', + // outputEachDir: true, + // openapi: { inputFile: 'samples/path-at-mark.yml' } + // } ] diff --git a/samples/array-one-of/@types/index.ts b/samples/array-one-of/@types/index.ts index cb77d267..37632b4d 100644 --- a/samples/array-one-of/@types/index.ts +++ b/samples/array-one-of/@types/index.ts @@ -1,14 +1,14 @@ /* eslint-disable */ export type User = { - id?: string - roles?: (RoleA | RoleB)[] + id?: string | undefined + roles?: (RoleA | RoleB)[] | undefined } export type RoleA = { - name?: string + name?: string | undefined } export type RoleB = { - name?: string - authority?: string + name?: string | undefined + authority?: string | undefined } diff --git a/samples/externals/@types/index.ts b/samples/externals/@types/index.ts index 1729f476..20790fdd 100644 --- a/samples/externals/@types/index.ts +++ b/samples/externals/@types/index.ts @@ -14,7 +14,7 @@ export type PhoneNumber = { export type Identifier = { /** The user identifier (e.g. phone number) to filter the results */ - identifier?: string + identifier?: string | undefined } export type OfferId = { @@ -29,12 +29,12 @@ export type OrderId = { export type CategoriesId = { /** List of wanted category ids separated by commas */ - 'categories.id'?: string + 'categories.id'?: string | undefined } export type Status = { /** The status of the subscribed product used to filter the results */ - status?: string + status?: string | undefined } export type Offers = Offer[] @@ -46,15 +46,15 @@ export type Offer = { /** Name of the offer. User Friendly field. */ name: string /** List of user identifiers (e.g. phone_numbers) that can be used to subscribe to the offer */ - identifiers?: string[] + identifiers?: string[] | undefined /** Description of the offer. User Friendly field. */ description: string /** List of categories for which the offer applies */ categories: OfferCategory[] /** Time when the offer will be available to the user, in ISO-8601 extended local date format. Time-offset from UTC may be used to match local OB time. */ - start_date?: string + start_date?: string | undefined /** Time when the offer will expire for the user, in ISO-8601 extended local date format. Time-offset from UTC may be used to match local OB time. */ - end_date?: string + end_date?: string | undefined /** List of prices for this offer */ prices: Price[] product: OfferedProduct @@ -65,7 +65,7 @@ export type OfferCategory = { /** Name of the category. */ name: string /** short description of the category. User Friendly field. */ - description?: string + description?: string | undefined id: 'promotion' | 'bundle' | 'sms' | 'voice' | 'data' | 'value_added_service' | 'app' | 'iptv' | 'device' | 'recurring' | 'bolt-on' | 'dth' } @@ -74,13 +74,13 @@ export type Product = { /** Name to be displayed when referring to this product. User Friendly field. */ display_name: string product_type: ProductType - descriptions?: Descriptions - subscription_type?: SubscriptionType - quota?: Quotas - connection?: Connection - packages?: Packages + descriptions?: Descriptions | undefined + subscription_type?: SubscriptionType | undefined + quota?: Quotas | undefined + connection?: Connection | undefined + packages?: Packages | undefined /** list of freely defined strings that tag the product based on some criteria */ - tags?: string[] + tags?: string[] | undefined } /** Specifies how the service is paid (prepaid, postpaid, etc) */ @@ -92,7 +92,7 @@ export type ProductType = 'mobile' | 'landline' | 'internet' | 'iptv' | 'bundle' /** Object that models an offered product */ export type OfferedProduct = Product & { /** Array of products objects. Only applies for product bundle */ - sub_products?: OfferedProduct[] + sub_products?: OfferedProduct[] | undefined } /** Object that models a subscribed product */ @@ -106,28 +106,28 @@ export type SubscribedProduct = Product & { /** Time when the product was subscribed, in ISO-8601 extended local date format. Time-offset from UTC may be used to match local OB time. */ start_date: string /** Time when the product will finalize, in ISO-8601 extended local date format. Time-offset from UTC may be used to match local OB time. */ - end_date?: string + end_date?: string | undefined /** List of prices for this subscribed product */ - prices?: Price[] + prices?: Price[] | undefined /** Array of products objects. Only applies for product bundle */ - sub_products?: SubscribedProduct[] + sub_products?: SubscribedProduct[] | undefined } /** It applies for product_type mobile, value_added_service and bolt-on, and provides information on available data, voice and sms quota */ export type Quotas = { /** list of data quotas associated to this product */ - data?: DataQuota[] + data?: DataQuota[] | undefined /** list of voice quotas associated to this product */ - voice?: VoiceQuota[] + voice?: VoiceQuota[] | undefined /** list of SMS quotas associated to this product */ - sms?: SmsQuota[] + sms?: SmsQuota[] | undefined } export type CommonQuota = { /** max units allowed by current quota. -1 is interpreted as there is no limit */ max: number - time_bands?: TimeBand[] - origins?: Origin[] + time_bands?: TimeBand[] | undefined + origins?: Origin[] | undefined } /** Data quota information */ @@ -140,14 +140,14 @@ export type DataQuota = CommonQuota & { export type VoiceQuota = CommonQuota & { /** Unit used on the quota */ unit: 'second' | 'minute' | 'hour' - destinations?: Destination[] + destinations?: Destination[] | undefined } /** SMS quota information */ export type SmsQuota = CommonQuota & { /** Unit used on the quota */ unit: 'message' - destinations?: Destination[] + destinations?: Destination[] | undefined } /** Timebands when the quota applies */ @@ -185,14 +185,14 @@ export type Description = { /** Text with information about the product. User Friendly field. */ text: string /** HTTPS URL */ - url?: string + url?: string | undefined /** * Category of the description. This field is used to provide further info about displaying of the description text: * - 'general': Default value for any description without specific category. * - 'dates': Information about dates, related with the life-cycle of the product (e.g: contractual information about renowation conditions) * - 'promotion': Information about product acquisition conditions, such as if special price is being applied and for how long, or if data quota is duplicated during first three months. */ - category?: 'general' | 'dates' | 'promotion' + category?: 'general' | 'dates' | 'promotion' | undefined } export type Descriptions = Description[] @@ -207,12 +207,12 @@ export type Price = { * Period between charge of the price. Applies when type equals recurring. * Additional to pre-defined values of daily, weekly, monthly, yearly, any indication of number of days or hours is possible, with format {x}-days or {x}-hours (e.g.: 7-days or 24-hours). */ - recurring_period?: string + recurring_period?: string | undefined /** * Period for which the product will be subscribed. It does not mean that offer is available for indicated period, it means that the product will be acquired and will last for indicated period. Applies when type equals one-off or usage. For backwards compatibility, in case of recurring prices, recurring_period param is used instead. * Additional to pre-defined values of day, week, month, year, any indication of number of days or hours is possible, with format {x}-days or {x}-hours (e.g.: 7-days or 24-hours). */ - period_duration?: string + period_duration?: string | undefined amount: External1_MoneyAmount /** porcentage factor of the taxes applied */ tax: number @@ -226,17 +226,17 @@ export type Order = { /** Unique id of the order */ id: string /** Id of the purchased offer */ - offer_id?: string + offer_id?: string | undefined /** Id of the subscribed product this order relates to */ - product_id?: string + product_id?: string | undefined /** user identifer (e.g. phone number) associated to the order */ - identifier?: string + identifier?: string | undefined /** Time when the order was created, in ISO-8601 extended local date format. Time-offset from UTC may be used to match local OB time. */ creation_date: string /** type of the order */ type: 'purchase' | 'unsubscription' | 'update' status: OrderStatus - error?: OrderError + error?: OrderError | undefined } export type OrderStatus = 'pending' | 'confirmed' | 'rejected' @@ -254,7 +254,7 @@ export type CreatePurchaseOrderInvoice = { /** Id of the offer related to the new order */ offer_id: string /** user identifer (e.g. phone number) associated to the order */ - identifier?: string + identifier?: string | undefined } /** Information of what offer has to be used to create the order */ @@ -262,7 +262,7 @@ export type CreatePurchaseOrderWallet = { /** Id of the offer related to the new order */ offer_id: string /** user identifer (e.g. phone number) associated to the order */ - identifier?: string + identifier?: string | undefined wallet_type: WalletType } @@ -340,5 +340,5 @@ export type External1_MoneyAmount = { /** Currency code in which the amount is expressed. ISO 4217 */ currency: string /** true if the amount includes government taxes */ - tax_included?: boolean + tax_included?: boolean | undefined } diff --git a/samples/externals/users/_user_id@string/orders/index.ts b/samples/externals/users/_user_id@string/orders/index.ts index 140c14ba..907cc446 100644 --- a/samples/externals/users/_user_id@string/orders/index.ts +++ b/samples/externals/users/_user_id@string/orders/index.ts @@ -4,7 +4,7 @@ import type * as Types from '../../../@types' export type Methods = { /** List orders for a user */ get: { - query?: Types.Identifier + query?: Types.Identifier | undefined status: 200 /** Ok */ resBody: Types.Orders diff --git a/samples/freee/@types/index.ts b/samples/freee/@types/index.ts index 251436f1..90b63be1 100644 --- a/samples/freee/@types/index.ts +++ b/samples/freee/@types/index.ts @@ -22,38 +22,38 @@ export type DealCreateParams = { /** 事業所ID */ company_id: number /** 支払期日(yyyy-mm-dd) */ - due_date?: string + due_date?: string | undefined /** 取引先ID */ - partner_id?: number + partner_id?: number | undefined /** 取引先コード */ - partner_code?: string + partner_code?: string | undefined /** 管理番号 */ - ref_number?: string + ref_number?: string | undefined details: { /** 税区分コード */ - tax_code?: number + tax_code?: number | undefined /** 税区分ID（廃止予定。上記tax_codeを使用してください。tax_code, tax_idはどちらかの指定が必須です。） */ - tax_id?: number + tax_id?: number | undefined /** 勘定科目ID */ account_item_id: number /** 取引金額（税込で指定してください） */ amount: number /** 品目ID */ - item_id?: number + item_id?: number | undefined /** 部門ID */ - section_id?: number + section_id?: number | undefined /** メモタグID */ - tag_ids?: number[] + tag_ids?: number[] | undefined /** セグメント１ID */ - segment_1_tag_id?: number + segment_1_tag_id?: number | undefined /** セグメント２ID */ - segment_2_tag_id?: number + segment_2_tag_id?: number | undefined /** セグメント３ID */ - segment_3_tag_id?: number + segment_3_tag_id?: number | undefined /** 備考 */ - description?: string + description?: string | undefined /** 消費税額（指定しない場合は自動で計算されます） */ - vat?: number + vat?: number | undefined }[] /** 支払行一覧（配列）：未指定の場合、未決済の取引を作成します。 */ payments?: { @@ -65,9 +65,9 @@ export type DealCreateParams = { from_walletable_type: 'bank_account' | 'credit_card' | 'wallet' | 'private_account_item' /** 支払日：payments指定時は必須 */ date: string - }[] + }[] | undefined /** 証憑ファイルID（配列） */ - receipt_ids?: number[] + receipt_ids?: number[] | undefined } export type DealUpdateParams = { @@ -78,43 +78,43 @@ export type DealUpdateParams = { /** 事業所ID */ company_id: number /** 支払期日(yyyy-mm-dd) */ - due_date?: string + due_date?: string | undefined /** 取引先ID */ - partner_id?: number + partner_id?: number | undefined /** 取引先コード */ - partner_code?: string + partner_code?: string | undefined /** 管理番号 */ - ref_number?: string + ref_number?: string | undefined details: { /** 取引行ID: 既存取引行を更新する場合に指定します。IDを指定しない取引行は、新規行として扱われ追加されます。また、detailsに含まれない既存の取引行は削除されます。更新後も残したい行は、必ず取引行IDを指定してdetailsに含めてください。 */ - id?: number + id?: number | undefined /** 税区分コード */ - tax_code?: number + tax_code?: number | undefined /** 税区分ID（廃止予定。上記tax_codeを使用してください。tax_code, tax_idはどちらかの指定が必須です。） */ - tax_id?: number + tax_id?: number | undefined /** 勘定科目ID */ account_item_id: number /** 取引金額（税込で指定してください） */ amount: number /** 品目ID */ - item_id?: number + item_id?: number | undefined /** 部門ID */ - section_id?: number + section_id?: number | undefined /** メモタグID */ - tag_ids?: number[] + tag_ids?: number[] | undefined /** セグメント１ID */ - segment_1_tag_id?: number + segment_1_tag_id?: number | undefined /** セグメント２ID */ - segment_2_tag_id?: number + segment_2_tag_id?: number | undefined /** セグメント３ID */ - segment_3_tag_id?: number + segment_3_tag_id?: number | undefined /** 備考 */ - description?: string + description?: string | undefined /** 消費税額（指定しない場合は自動で計算されます） */ - vat?: number + vat?: number | undefined }[] /** 証憑ファイルID（配列） */ - receipt_ids?: number[] | null + receipt_ids?: number[] | null | undefined } export type ManualJournalCreateParams = { @@ -123,7 +123,7 @@ export type ManualJournalCreateParams = { /** 発生日 (yyyy-mm-dd) */ issue_date: string /** 決算整理仕訳フラグ（falseまたは未指定の場合: 日常仕訳） */ - adjustment?: boolean + adjustment?: boolean | undefined details: { /** 貸借（貸方: credit, 借方: debit） */ entry_side: 'debit' | 'credit' @@ -134,25 +134,25 @@ export type ManualJournalCreateParams = { /** 取引金額（税込で指定してください） */ amount: number /** 消費税額（指定しない場合は自動で計算されます） */ - vat?: number + vat?: number | undefined /** 取引先ID */ - partner_id?: number + partner_id?: number | undefined /** 取引先コード */ - partner_code?: string + partner_code?: string | undefined /** 品目ID */ - item_id?: number + item_id?: number | undefined /** 部門ID */ - section_id?: number + section_id?: number | undefined /** メモタグID */ - tag_ids?: number[] + tag_ids?: number[] | undefined /** セグメント１ID */ - segment_1_tag_id?: number + segment_1_tag_id?: number | undefined /** セグメント２ID */ - segment_2_tag_id?: number + segment_2_tag_id?: number | undefined /** セグメント３ID */ - segment_3_tag_id?: number + segment_3_tag_id?: number | undefined /** 備考 */ - description?: string + description?: string | undefined }[] } @@ -162,10 +162,10 @@ export type ManualJournalUpdateParams = { /** 発生日 (yyyy-mm-dd) */ issue_date: string /** 決算整理仕訳フラグ（falseまたは未指定の場合: 日常仕訳） */ - adjustment?: boolean + adjustment?: boolean | undefined details: { /** 貸借行ID: 既存貸借行を更新または削除する場合に指定します。IDを指定しない貸借行は、新規行として扱われ追加されます。 */ - id?: number + id?: number | undefined /** 貸借（貸方: credit, 借方: debit） */ entry_side: 'debit' | 'credit' /** 税区分コード */ @@ -175,100 +175,100 @@ export type ManualJournalUpdateParams = { /** 取引金額（税込で指定してください） */ amount: number /** 消費税額（指定しない場合は自動で計算されます） */ - vat?: number + vat?: number | undefined /** 取引先ID */ - partner_id?: number + partner_id?: number | undefined /** 取引先コード */ - partner_code?: string + partner_code?: string | undefined /** 品目ID */ - item_id?: number + item_id?: number | undefined /** 部門ID */ - section_id?: number + section_id?: number | undefined /** メモタグID */ - tag_ids?: number[] + tag_ids?: number[] | undefined /** セグメント１ID */ - segment_1_tag_id?: number + segment_1_tag_id?: number | undefined /** セグメント２ID */ - segment_2_tag_id?: number + segment_2_tag_id?: number | undefined /** セグメント３ID */ - segment_3_tag_id?: number + segment_3_tag_id?: number | undefined /** 備考 */ - description?: string + description?: string | undefined }[] } export type CompanyParams = { /** 事業所の正式名称 (100文字以内) */ - name?: string + name?: string | undefined /** 正式名称フリガナ (100文字以内) */ - name_kana?: string + name_kana?: string | undefined /** 担当者名 (50文字以内) */ - contact_name?: string + contact_name?: string | undefined address_attributes?: { /** 郵便番号 */ - zipcode?: string + zipcode?: string | undefined /** 都道府県コード（0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄 */ - prefecture_code?: number + prefecture_code?: number | undefined /** 市区町村・番地 */ - street_name1?: string + street_name1?: string | undefined /** 建物名・部屋番号など */ - street_name2?: string - } + street_name2?: string | undefined + } | undefined /** 電話番号１ */ - phone1?: string + phone1?: string | undefined /** 電話番号２ */ - phone2?: string + phone2?: string | undefined /** FAX */ - fax?: string + fax?: string | undefined sales_information_attributes?: { /** 種別（agriculture_forestry_fisheries_ore: 農林水産業/鉱業、construction: 建設、manufacturing_processing: 製造/加工、it: IT、transportation_logistics: 運輸/物流、retail_wholesale: 小売/卸売、finance_insurance: 金融/保険、real_estate_rental: 不動産/レンタル、profession: 士業/学術/専門技術サービス、design_production: デザイン/制作、food: 飲食、leisure_entertainment: レジャー/娯楽、lifestyle: 生活関連サービス、education: 教育/学習支援、medical_welfare: 医療/福祉、other_services: その他サービス、other: その他）Available values : agriculture_forestry_fisheries_ore, construction, manufacturing_processing, it, transportation_logistics, retail_wholesale, finance_insurance, real_estate_rental, profession, design_production, food, leisure_entertainment, lifestyle, education, medical_welfare, other_services, other */ - industry_class?: 'agriculture_forestry_fisheries_ore' | 'construction' | 'manufacturing_processing' | 'it' | 'transportation_logistics' | 'retail_wholesale' | 'finance_insurance' | 'real_estate_rental' | 'profession' | 'design_production' | 'food' | 'leisure_entertainment' | 'lifestyle' | 'education' | 'medical_welfare' | 'other_services' | 'other' + industry_class?: 'agriculture_forestry_fisheries_ore' | 'construction' | 'manufacturing_processing' | 'it' | 'transportation_logistics' | 'retail_wholesale' | 'finance_insurance' | 'real_estate_rental' | 'profession' | 'design_production' | 'food' | 'leisure_entertainment' | 'lifestyle' | 'education' | 'medical_welfare' | 'other_services' | 'other' | undefined /** 業種（agriculture: 農業, forestry: 林業, fishing_industry: 漁業、水産養殖業, mining: 鉱業、採石業、砂利採取業, civil_contractors: 土木工事業, pavement: 舗装工事業, carpenter: とび、大工、左官等の建設工事業, renovation: リフォーム工事業, electrical_plumbing: 電気、管工事等の設備工事業, grocery: 食料品の製造加工業, machinery_manufacturing: 機械器具の製造加工業, printing: 印刷業, other_manufacturing: その他の製造加工業, software_development: 受託：ソフトウェア、アプリ開発業, system_development: 受託：システム開発業, survey_analysis: 受託：調査、分析等の情報処理業, server_management: 受託：サーバー運営管理, website_production: 受託：ウェブサイト制作, online_service_management: オンラインサービス運営業, online_advertising_agency: オンライン広告代理店業, online_advertising_planning_production: オンライン広告企画・制作業, online_media_management: オンラインメディア運営業, portal_site_management: ポータルサイト運営業, other_it_services: その他、IT サービス業, transport_delivery: 輸送業、配送業, delivery: バイク便等の配達業, other_transportation_logistics: その他の運輸業、物流業, other_wholesale: 卸売業：その他, clothing_wholesale_fiber: 卸売業：衣類卸売／繊維, food_wholesale: 卸売業：飲食料品, entrusted_development_wholesale: 卸売業：機械器具, online_shop: 小売業：無店舗　オンラインショップ, fashion_grocery_store: 小売業：店舗あり　ファッション、雑貨, food_store: 小売業：店舗あり　生鮮食品、飲食料品, entrusted_store: 小売業：店舗あり　機械、器具, other_store: 小売業：店舗あり　その他, financial_instruments_exchange: 金融業：金融商品取引, commodity_futures_investment_advisor: 金融業：商品先物取引、商品投資顧問, other_financial: 金融業：その他, brokerage_insurance: 保険業：仲介、代理, other_insurance: 保険業：その他, real_estate_developer: 不動産業：ディベロッパー, real_estate_brokerage: 不動産業：売買、仲介, rent_coin_parking_management: 不動産業：賃貸、コインパーキング、管理, rental_office_co_working_space: 不動産業：レンタルオフィス、コワーキングスペース, rental_lease: レンタル業、リース業, cpa_tax_accountant: 士業：公認会計士事務所、税理士事務所, law_office: 士業：法律事務所, judicial_and_administrative_scrivener: 士業：司法書士事務所／行政書士事務所, labor_consultant: 士業：社会保険労務士事務所, other_profession: 士業：その他, business_consultant: 経営コンサルタント, academic_research_development: 学術・開発研究機関, advertising_agency: 広告代理店, advertising_planning_production: 広告企画／制作, design_development: ソフトウェア、アプリ開発業（受託）, apparel_industry_design: 服飾デザイン業、工業デザイン業, website_design: ウェブサイト制作（受託）, advertising_planning_design: 広告企画／制作業, other_design: その他、デザイン／制作, restaurants_coffee_shops: レストラン、喫茶店等の飲食店業, sale_of_lunch: 弁当の販売業, bread_confectionery_manufacture_sale: パン、菓子等の製造販売業, delivery_catering_mobile_catering: デリバリー業、ケータリング業、移動販売業, hotel_inn: 宿泊業：ホテル、旅館, homestay: 宿泊業：民泊, travel_agency: 旅行代理店業, leisure_sports_facility_management: レジャー、スポーツ等の施設運営業, show_event_management: ショー、イベント等の興行、イベント運営業, barber: ビューティ、ヘルスケア業：床屋、理容室, beauty_salon: ビューティ、ヘルスケア業：美容室, spa_sand_bath_sauna: ビューティ、ヘルスケア業：スパ、砂風呂、サウナ等, este_ail_salon: ビューティ、ヘルスケア業：その他、エステサロン、ネイルサロン等, bridal_planning_introduce_wedding: 冠婚葬祭業：ブライダルプランニング、結婚式場紹介等, memorial_ceremony_funeral: 冠婚葬祭業：メモリアルセレモニー、葬儀等, moving: 引っ越し業, courier_industry: 宅配業, house_maid_cleaning_agency: 家事代行サービス業：無店舗　ハウスメイド、掃除代行等, re_tailoring_clothes: 家事代行サービス業：店舗あり　衣類修理、衣類仕立て直し等, training_institute_management: 研修所等の施設運営業, tutoring_school: 学習塾、進学塾等の教育・学習支援業, music_calligraphy_abacus_classroom: 音楽教室、書道教室、そろばん教室等のの教育・学習支援業, english_school: 英会話スクール等の語学学習支援業, tennis_yoga_judo_school: テニススクール、ヨガ教室、柔道場等のスポーツ指導、支援業, culture_school: その他、カルチャースクール等の教育・学習支援業, seminar_planning_management: セミナー等の企画、運営業, hospital_clinic: 医療業：病院、一般診療所、クリニック等, dental_clinic: 医療業：歯科診療所, other_medical_services: 医療業：その他、医療サービス等, nursery: 福祉業：保育所等、児童向け施設型サービス, nursing_home: 福祉業：老人ホーム等、老人向け施設型サービス, rehabilitation_support_services: 福祉業：療育支援サービス等、障害者等向け施設型サービス, other_welfare: 福祉業：その他、施設型福祉サービス, visit_welfare_service: 福祉業：訪問型福祉サービス, recruitment_temporary_staffing: 人材紹介業、人材派遣業, life_related_recruitment_temporary_staffing: 生活関連サービスの人材紹介業、人材派遣業, car_maintenance_car_repair: 自動車整備業、自動車修理業, machinery_equipment_maintenance_repair: 機械機器類の整備業、修理業, cleaning_maintenance_building_management: 清掃業、メンテナンス業、建物管理業, security: 警備業, other_services: その他のサービス業, npo: NPO, general_incorporated_association: 一般社団法人, general_incorporated_foundation: 一般財団法人, other_association: その他組織) */ - industry_code?: 'agriculture' | 'forestry' | 'fishing_industry' | 'mining' | 'civil_contractors' | 'pavement' | 'carpenter' | 'renovation' | 'electrical_plumbing' | 'grocery' | 'machinery_manufacturing' | 'printing' | 'other_manufacturing' | 'software_development' | 'system_development' | 'survey_analysis' | 'server_management' | 'website_production' | 'online_service_management' | 'online_advertising_agency' | 'online_advertising_planning_production' | 'online_media_management' | 'portal_site_management' | 'other_it_services' | 'transport_delivery' | 'delivery' | 'other_transportation_logistics' | 'other_wholesale' | 'clothing_wholesale_fiber' | 'food_wholesale' | 'entrusted_development_wholesale' | 'online_shop' | 'fashion_grocery_store' | 'food_store' | 'entrusted_store' | 'other_store' | 'financial_instruments_exchange' | 'commodity_futures_investment_advisor' | 'other_financial' | 'brokerage_insurance' | 'other_insurance' | 'real_estate_developer' | 'real_estate_brokerage' | 'rent_coin_parking_management' | 'rental_office_co_working_space' | 'rental_lease' | 'cpa_tax_accountant' | 'law_office' | 'judicial_and_administrative_scrivener' | 'labor_consultant' | 'other_profession' | 'business_consultant' | 'academic_research_development' | 'advertising_agency' | 'advertising_planning_production' | 'design_development' | 'apparel_industry_design' | 'website_design' | 'advertising_planning_design' | 'other_design' | 'restaurants_coffee_shops' | 'sale_of_lunch' | 'bread_confectionery_manufacture_sale' | 'delivery_catering_mobile_catering' | 'hotel_inn' | 'homestay' | 'travel_agency' | 'leisure_sports_facility_management' | 'show_event_management' | 'barber' | 'beauty_salon' | 'spa_sand_bath_sauna' | 'este_ail_salon' | 'bridal_planning_introduce_wedding' | 'memorial_ceremony_funeral' | 'moving' | 'courier_industry' | 'house_maid_cleaning_agency' | 're_tailoring_clothes' | 'training_institute_management' | 'tutoring_school' | 'music_calligraphy_abacus_classroom' | 'english_school' | 'tennis_yoga_judo_school' | 'culture_school' | 'seminar_planning_management' | 'hospital_clinic' | 'dental_clinic' | 'other_medical_services' | 'nursery' | 'nursing_home' | 'rehabilitation_support_services' | 'other_welfare' | 'visit_welfare_service' | 'recruitment_temporary_staffing' | 'life_related_recruitment_temporary_staffing' | 'car_maintenance_car_repair' | 'machinery_equipment_maintenance_repair' | 'cleaning_maintenance_building_management' | 'security' | 'other_services' | 'npo' | 'general_incorporated_association' | 'general_incorporated_foundation' | 'other_association' - } + industry_code?: 'agriculture' | 'forestry' | 'fishing_industry' | 'mining' | 'civil_contractors' | 'pavement' | 'carpenter' | 'renovation' | 'electrical_plumbing' | 'grocery' | 'machinery_manufacturing' | 'printing' | 'other_manufacturing' | 'software_development' | 'system_development' | 'survey_analysis' | 'server_management' | 'website_production' | 'online_service_management' | 'online_advertising_agency' | 'online_advertising_planning_production' | 'online_media_management' | 'portal_site_management' | 'other_it_services' | 'transport_delivery' | 'delivery' | 'other_transportation_logistics' | 'other_wholesale' | 'clothing_wholesale_fiber' | 'food_wholesale' | 'entrusted_development_wholesale' | 'online_shop' | 'fashion_grocery_store' | 'food_store' | 'entrusted_store' | 'other_store' | 'financial_instruments_exchange' | 'commodity_futures_investment_advisor' | 'other_financial' | 'brokerage_insurance' | 'other_insurance' | 'real_estate_developer' | 'real_estate_brokerage' | 'rent_coin_parking_management' | 'rental_office_co_working_space' | 'rental_lease' | 'cpa_tax_accountant' | 'law_office' | 'judicial_and_administrative_scrivener' | 'labor_consultant' | 'other_profession' | 'business_consultant' | 'academic_research_development' | 'advertising_agency' | 'advertising_planning_production' | 'design_development' | 'apparel_industry_design' | 'website_design' | 'advertising_planning_design' | 'other_design' | 'restaurants_coffee_shops' | 'sale_of_lunch' | 'bread_confectionery_manufacture_sale' | 'delivery_catering_mobile_catering' | 'hotel_inn' | 'homestay' | 'travel_agency' | 'leisure_sports_facility_management' | 'show_event_management' | 'barber' | 'beauty_salon' | 'spa_sand_bath_sauna' | 'este_ail_salon' | 'bridal_planning_introduce_wedding' | 'memorial_ceremony_funeral' | 'moving' | 'courier_industry' | 'house_maid_cleaning_agency' | 're_tailoring_clothes' | 'training_institute_management' | 'tutoring_school' | 'music_calligraphy_abacus_classroom' | 'english_school' | 'tennis_yoga_judo_school' | 'culture_school' | 'seminar_planning_management' | 'hospital_clinic' | 'dental_clinic' | 'other_medical_services' | 'nursery' | 'nursing_home' | 'rehabilitation_support_services' | 'other_welfare' | 'visit_welfare_service' | 'recruitment_temporary_staffing' | 'life_related_recruitment_temporary_staffing' | 'car_maintenance_car_repair' | 'machinery_equipment_maintenance_repair' | 'cleaning_maintenance_building_management' | 'security' | 'other_services' | 'npo' | 'general_incorporated_association' | 'general_incorporated_foundation' | 'other_association' | undefined + } | undefined /** 従業員数（0: 経営者のみ、1: 2~5人、2: 6~10人、3: 11~20人、13: 21~50人、14: 51~100人、15: 101~300人、18: 301~500人、16: 501~1,000人、17: 1,001人以上 */ - head_count?: 0 | 1 | 2 | 3 | 13 | 14 | 15 | 18 | 16 | 17 + head_count?: 0 | 1 | 2 | 3 | 13 | 14 | 15 | 18 | 16 | 17 | undefined /** 法人番号 (半角数字13桁、法人のみ) */ - corporate_number?: string + corporate_number?: string | undefined fiscal_years_attributes?: { /** 製造業向け機能（0: 使用しない、1: 使用する） */ - use_industry_template?: number + use_industry_template?: number | undefined /** 固定資産の控除法（0: 直接控除法、1: 間接控除法） */ - indirect_write_off_method?: number + indirect_write_off_method?: number | undefined /** 間接控除時の累計額（0: 共通、1: 資産分類別） */ - indirect_write_off_method_type?: number + indirect_write_off_method_type?: number | undefined /** 期首日 */ - start_date?: string + start_date?: string | undefined /** 期末日（決算日�� */ - end_date?: string + end_date?: string | undefined /** 期 */ - accounting_period?: number + accounting_period?: number | undefined /** 減価償却端数処理法(法人のみ)(0: 切り捨て、1: 切り上げ) */ - depreciation_fraction?: number + depreciation_fraction?: number | undefined /** 不動産所得使用区分(個人事業主のみ)（0: 使用しない、3: 使用する） */ - return_code?: number + return_code?: number | undefined /** 消費税端数処理方法（0: 切り上げ、1: 切り捨て, 2: 四捨五入） */ - tax_fraction?: number - } + tax_fraction?: number | undefined + } | undefined doc_template?: { /** レイアウト(0: レイアウト1, 1:レイアウト2, 3:封筒1, 4:レイアウト3(繰越金額欄あり), 5: 封筒2(繰越金額欄あり)) */ - invoice_layout?: number + invoice_layout?: number | undefined /** スタイル(0: クラシック, 1: モダン) */ - invoice_style?: number + invoice_style?: number | undefined /** 金額端数処理方法（0: 切り上げ、1: 切り捨て, 2: 四捨五入） */ - amount_fraction?: number - } + amount_fraction?: number | undefined + } | undefined /** 仕訳番号形式（not_used: 使用しない、digits: 数字（例：5091824）、alnum: 英数字（例：59J0P））Available values : not_used, digits, alnum */ - txn_number_format?: 'not_used' | 'digits' | 'alnum' + txn_number_format?: 'not_used' | 'digits' | 'alnum' | undefined /** プライベート資金/役員資金（0: 使用しない、1: 使用する） */ - private_settlement?: number + private_settlement?: number | undefined } export type ItemParams = { @@ -277,9 +277,9 @@ export type ItemParams = { /** 品目名 (30文字以内) */ name: string /** ショートカット１ (20文字以内) */ - shortcut1?: string + shortcut1?: string | undefined /** ショートカット２ (20文字以内) */ - shortcut2?: string + shortcut2?: string | undefined } export type WalletableCreateParams = { @@ -290,9 +290,9 @@ export type WalletableCreateParams = { /** 事業所ID */ company_id: number /** サービスID */ - bank_id?: number + bank_id?: number | undefined /** 決算書表示名（小カテゴリー）　例：売掛金, 受取手形, 未収入金（法人のみ）, 買掛金, 支払手形, 未払金, 預り金, 前受金 */ - group_name?: string + group_name?: string | undefined } export type WalletableUpdateParams = { @@ -318,14 +318,14 @@ export type TransferParams = { /** 事業所ID */ company_id: number /** 備考 */ - description?: string + description?: string | undefined } export type WalletTxnParams = { /** 入金／出金 (入金: income, 出金: expense) */ entry_side: 'income' | 'expense' /** 取引内容 */ - description?: string + description?: string | undefined /** 取引金額 */ amount: number /** 口座ID */ @@ -337,7 +337,7 @@ export type WalletTxnParams = { /** 事業所ID */ company_id: number /** 残高 (銀行口座等) */ - balance?: number + balance?: number | undefined } export type ExpenseApplicationCreateParams = { @@ -348,24 +348,24 @@ export type ExpenseApplicationCreateParams = { /** 申請日 (yyyy-mm-dd) */ issue_date: string /** 備考 (10000文字以内) */ - description?: string + description?: string | undefined /** 会計freeeのWeb画面から申請内容を編集可能（デフォルト: false）：falseの場合、Web上からの項目行の追加／削除・金額の編集が出来なくなります。APIでの編集は可能です。 */ - editable_on_web?: boolean + editable_on_web?: boolean | undefined /** 部門ID */ - section_id?: number + section_id?: number | undefined /** メモタグID */ - tag_ids?: number[] + tag_ids?: number[] | undefined expense_application_lines: { /** 日付 (yyyy-mm-dd) */ - transaction_date?: string + transaction_date?: string | undefined /** 内容 (250文字以内) */ - description?: string + description?: string | undefined /** 金額 */ - amount?: number + amount?: number | undefined /** 経費科目ID */ - expense_application_line_template_id?: number + expense_application_line_template_id?: number | undefined /** 証憑ID */ - receipt_id?: number + receipt_id?: number | undefined }[] } @@ -377,26 +377,26 @@ export type ExpenseApplicationUpdateParams = { /** 申請日 (yyyy-mm-dd) */ issue_date: string /** 備考 (10000文字以内) */ - description?: string + description?: string | undefined /** 会計freeeのWeb画面から申請内容を編集可能：falseの場合、Web上からの項目行の追加／削除・金額の編集が出来なくなります。APIでの編集は可能です。 */ - editable_on_web?: boolean + editable_on_web?: boolean | undefined /** 部門ID */ - section_id?: number + section_id?: number | undefined /** メモタグID */ - tag_ids?: number[] + tag_ids?: number[] | undefined expense_application_lines: { /** 経費申請の項目行ID: 既存項目行を更新する場合に指定します。IDを指定しない項目行は、新規行として扱われ追加されます。また、expense_application_linesに含まれない既存の項目行は削除されます。更新後も残したい行は、必ず経費申請の項目行IDを指定してexpense_application_linesに含めてください。 */ - id?: number + id?: number | undefined /** 日付 (yyyy-mm-dd) */ - transaction_date?: string + transaction_date?: string | undefined /** 内容 (250文字以内) */ - description?: string + description?: string | undefined /** 金額 */ - amount?: number + amount?: number | undefined /** 経費科目ID */ - expense_application_line_template_id?: number + expense_application_line_template_id?: number | undefined /** 証憑ID */ - receipt_id?: number + receipt_id?: number | undefined }[] } @@ -406,84 +406,84 @@ export type PartnerCreateParams = { /** 取引先名 (255文字以内) */ name: string /** 取引先コード */ - code?: string + code?: string | undefined /** ショートカット１ (255文字以内) */ - shortcut1?: string + shortcut1?: string | undefined /** ショートカット２ (255文字以内) */ - shortcut2?: string + shortcut2?: string | undefined /** 正式名称（255文字以内） */ - long_name?: string + long_name?: string | undefined /** カナ名称（255文字以内） */ - name_kana?: string + name_kana?: string | undefined /** 敬称（御中、様、(空白)の3つから選択） */ - default_title?: string + default_title?: string | undefined /** 電話番号 */ - phone?: string + phone?: string | undefined /** 担当者 氏名 (255文字以内) */ - contact_name?: string + contact_name?: string | undefined /** 担当者 メールアドレス (255文字以内) */ - email?: string + email?: string | undefined /** 振込元口座ID（一括振込ファイル用）:（walletableのtypeが'bank_account'のidのみ指定できます。また、未設定にする場合は、nullを指定してください。） */ - payer_walletable_id?: number | null + payer_walletable_id?: number | null | undefined /** 振込手数料負担（一括振込ファイル用）: (振込元(当方): payer, 振込先(先方): payee) */ - transfer_fee_handling_side?: 'payer' | 'payee' + transfer_fee_handling_side?: 'payer' | 'payee' | undefined address_attributes?: { /** 郵便番号（8文字以内） */ - zipcode?: string + zipcode?: string | undefined /** 都道府県コード（0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄 */ - prefecture_code?: number + prefecture_code?: number | undefined /** 市区町村・番地（255文字以内） */ - street_name1?: string + street_name1?: string | undefined /** 建物名・部屋番号など（255文字以内） */ - street_name2?: string - } + street_name2?: string | undefined + } | undefined partner_doc_setting_attributes?: { /** 請求書送付方法(email:メール、posting:郵送、email_and_posting:メールと郵送) */ - sending_method?: 'email' | 'posting' | 'email_and_posting' - } + sending_method?: 'email' | 'posting' | 'email_and_posting' | undefined + } | undefined partner_bank_account_attributes?: { /** 銀行名 */ - bank_name?: string + bank_name?: string | undefined /** 銀行名（カナ） */ - bank_name_kana?: string + bank_name_kana?: string | undefined /** 銀行番号 */ - bank_code?: string + bank_code?: string | undefined /** 支店名 */ - branch_name?: string + branch_name?: string | undefined /** 支店名（カナ） */ - branch_kana?: string + branch_kana?: string | undefined /** 支店番号 */ - branch_code?: string + branch_code?: string | undefined /** 口座種別(ordinary:普通、checking：当座、earmarked：納税準備預金、savings：貯蓄、other:その他) */ - account_type?: string + account_type?: string | undefined /** 口座番号 */ - account_number?: string + account_number?: string | undefined /** 受取人名 */ - long_account_name?: string + long_account_name?: string | undefined /** 受取人名（カナ） */ - account_name?: string - } + account_name?: string | undefined + } | undefined payment_term_attributes?: { /** 締め日（29, 30, 31日の末日を指定する場合は、32を指定してください。） */ - cutoff_day?: number + cutoff_day?: number | undefined /** 支払月 */ - additional_months?: number + additional_months?: number | undefined /** 支払日（29, 30, 31日の末日を指定する場合は、32を指定してください。） */ - fixed_day?: number - } + fixed_day?: number | undefined + } | undefined invoice_payment_term_attributes?: { /** 締め日（29, 30, 31日の末日を指定する場合は、32を指定してください。） */ - cutoff_day?: number + cutoff_day?: number | undefined /** 支払月 */ - additional_months?: number + additional_months?: number | undefined /** 支払日（29, 30, 31日の末日を指定する場合は、32を指定してください。） */ - fixed_day?: number - } + fixed_day?: number | undefined + } | undefined } export type PartnerUpdateParams = { @@ -492,91 +492,91 @@ export type PartnerUpdateParams = { /** 取引先名 (255文字以内) */ name: string /** ショートカット１ (255文字以内) */ - shortcut1?: string + shortcut1?: string | undefined /** ショートカット２ (255文字以内) */ - shortcut2?: string + shortcut2?: string | undefined /** 正式名称（255文字以内） */ - long_name?: string + long_name?: string | undefined /** カナ名称（255文字以内） */ - name_kana?: string + name_kana?: string | undefined /** 敬称（御中、様、(空白)の3つから選択） */ - default_title?: string + default_title?: string | undefined /** 電話番号 */ - phone?: string + phone?: string | undefined /** 担当者 氏名 (255文字以内) */ - contact_name?: string + contact_name?: string | undefined /** 担当者 メールアドレス (255文字以内) */ - email?: string + email?: string | undefined /** 振込元口座ID（一括振込ファイル用）:（walletableのtypeが'bank_account'のidのみ指定できます。また、未設定にする場合は、nullを指定してください。） */ - payer_walletable_id?: number | null + payer_walletable_id?: number | null | undefined /** 振込手数料負担（一括振込ファイル用）: (振込元(当方): payer, 振込先(先方): payee) */ - transfer_fee_handling_side?: 'payer' | 'payee' + transfer_fee_handling_side?: 'payer' | 'payee' | undefined address_attributes?: { /** 郵便番号（8文字以内） */ - zipcode?: string + zipcode?: string | undefined /** 都道府県コード（0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄 */ - prefecture_code?: number + prefecture_code?: number | undefined /** 市区町村・番地（255文字以内） */ - street_name1?: string + street_name1?: string | undefined /** 建物名・部屋番号など（255文字以内） */ - street_name2?: string - } + street_name2?: string | undefined + } | undefined partner_doc_setting_attributes?: { /** 請求書送付方法(email:メール、posting:郵送、email_and_posting:メールと郵送) */ - sending_method?: 'email' | 'posting' | 'email_and_posting' - } + sending_method?: 'email' | 'posting' | 'email_and_posting' | undefined + } | undefined partner_bank_account_attributes?: { /** 銀行名 */ - bank_name?: string + bank_name?: string | undefined /** 銀行名（カナ） */ - bank_name_kana?: string + bank_name_kana?: string | undefined /** 銀行番号 */ - bank_code?: string + bank_code?: string | undefined /** 支店名 */ - branch_name?: string + branch_name?: string | undefined /** 支店名（カナ） */ - branch_kana?: string + branch_kana?: string | undefined /** 支店番号 */ - branch_code?: string + branch_code?: string | undefined /** 口座種別(ordinary:普通、checking：当座、earmarked：納税準備預金、savings：貯蓄、other:その他) */ - account_type?: string + account_type?: string | undefined /** 口座番号 */ - account_number?: string + account_number?: string | undefined /** 受取人名 */ - long_account_name?: string + long_account_name?: string | undefined /** 受取人名（カナ） */ - account_name?: string - } + account_name?: string | undefined + } | undefined payment_term_attributes?: { /** 締め日（29, 30, 31日の末日を指定する場合は、32を指定してください。） */ - cutoff_day?: number + cutoff_day?: number | undefined /** 支払月 */ - additional_months?: number + additional_months?: number | undefined /** 支払日（29, 30, 31日の末日を指定する場合は、32を指定してください。） */ - fixed_day?: number - } + fixed_day?: number | undefined + } | undefined invoice_payment_term_attributes?: { /** 締め日（29, 30, 31日の末日を指定する場合は、32を指定してください。） */ - cutoff_day?: number + cutoff_day?: number | undefined /** 支払月 */ - additional_months?: number + additional_months?: number | undefined /** 支払日（29, 30, 31日の末日を指定する場合は、32を指定してください。） */ - fixed_day?: number - } + fixed_day?: number | undefined + } | undefined } export type ReceiptCreateParams = { /** 事業所ID */ company_id: number /** メモ (255文字以内) */ - description?: string + description?: string | undefined /** 取引日 (yyyy-mm-dd) */ - issue_date?: string + issue_date?: string | undefined /** 証憑ファイル */ receipt: (File | ReadStream) } @@ -585,7 +585,7 @@ export type ReceiptUpdateParams = { /** 事業所ID */ company_id: number /** メモ (255文字以内) */ - description?: string + description?: string | undefined /** 取引日 (yyyy-mm-dd) */ issue_date: string } @@ -598,9 +598,9 @@ export type AccountItemParams = { /** 勘定科目名 (30文字以内) */ name: string /** ショートカット1 (20文字以内) */ - shortcut?: string + shortcut?: string | undefined /** ショートカット2(勘定科目コード)(20文字以内) */ - shortcut_num?: string + shortcut_num?: string | undefined /** 税区分 */ tax_name: string /** 決算書表示名（小カテゴリー） */ @@ -612,17 +612,17 @@ export type AccountItemParams = { /** 支出取引相手勘定科目名 */ corresponding_expense_name: string /** 減価償却累計額勘定科目 */ - accumulated_dep_account_item_name?: string + accumulated_dep_account_item_name?: string | undefined /** 検索可能:2, 検索不可：3(登録時未指定の場合は2で登録されます。更新時未指定の場合はsearchableは変更されません。) */ - searchable?: number + searchable?: number | undefined /** 品目 */ items?: { - id?: number - }[] + id?: number | undefined + }[] | undefined /** 取引先 */ partners?: { - id?: number - }[] + id?: number | undefined + }[] | undefined } } @@ -633,11 +633,11 @@ export type AccountItemsResponse = { /** 勘定科目名 (30文字以内) */ name: string /** ショートカット1 (20文字以内) */ - shortcut?: string | null + shortcut?: string | null | undefined /** ショートカット2(勘定科目コード) (20文字以内) */ - shortcut_num?: string | null + shortcut_num?: string | null | undefined /** デフォルト設定がされている税区分ID */ - default_tax_id?: number + default_tax_id?: number | undefined /** デフォルト設定がされている税区分コード */ default_tax_code: number /** 勘定科目カテゴリー */ @@ -650,15 +650,15 @@ export type AccountItemsResponse = { /** 口座ID */ walletable_id: number | null /** 決算書表示名（小カテゴリー） */ - group_name?: string | null + group_name?: string | null | undefined /** 収入取引相手勘定科目名 */ - corresponding_income_name?: string | null + corresponding_income_name?: string | null | undefined /** 収入取引相手勘定科目ID */ - corresponding_income_id?: number | null + corresponding_income_id?: number | null | undefined /** 支出取引相手勘定科目名 */ - corresponding_expense_name?: string | null + corresponding_expense_name?: string | null | undefined /** 支出取引相手勘定科目ID */ - corresponding_expense_id?: number | null + corresponding_expense_id?: number | null | undefined }[] } @@ -677,9 +677,9 @@ export type AccountItemResponse = { /** 勘定科目のカテゴリーID */ account_category_id: number /** ショートカット1 (20文字以内) */ - shortcut?: string + shortcut?: string | undefined /** ショートカット2(勘定科目コード) (20文字以内) */ - shortcut_num?: string + shortcut_num?: string | undefined /** 支出取引相手勘定科目種別 */ corresponding_type_expense: number /** 収入取引相手勘定科目種別 */ @@ -687,33 +687,33 @@ export type AccountItemResponse = { /** 検索可能:2, 検索不可：3 */ searchable: number /** 減価償却累計額勘定科目 */ - accumulated_dep_account_item_name?: string + accumulated_dep_account_item_name?: string | undefined items?: { /** 品目ID */ id: number /** 品目 */ name: string - }[] + }[] | undefined partners?: { /** 取引先ID */ id: number /** 取引先 */ name: string - }[] + }[] | undefined /** 勘定科目の使用設定（true: 使用する、false: 使用しない） */ available: boolean /** 口座ID */ walletable_id: number | null /** 決算書表示名（小カテゴリー） */ - group_name?: string | null + group_name?: string | null | undefined /** 収入取引相手勘定科目名 */ - corresponding_income_name?: string | null + corresponding_income_name?: string | null | undefined /** 収入取引相手勘定科目ID */ - corresponding_income_id?: number | null + corresponding_income_id?: number | null | undefined /** 支出取引相手勘定科目名 */ - corresponding_expense_name?: string | null + corresponding_expense_name?: string | null | undefined /** 支出取引相手勘定科目ID */ - corresponding_expense_id?: number | null + corresponding_expense_id?: number | null | undefined } } @@ -722,11 +722,11 @@ export type BankResponse = { /** 連携サービスID */ id: number /** 連携サービス名 */ - name?: string + name?: string | undefined /** 連携サービス種別: (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet) */ - type?: 'bank_account' | 'credit_card' | 'wallet' + type?: 'bank_account' | 'credit_card' | 'wallet' | undefined /** 連携サービス名(カナ) */ - name_kana?: string | null + name_kana?: string | null | undefined } } @@ -735,18 +735,18 @@ export type JournalsResponse = { /** 受け付けID */ id: number /** 受け付けメッセージ */ - messages?: string + messages?: string | undefined /** 事業所ID */ company_id: number /** ダウンロード形式 */ - download_type?: 'csv' | 'generic' | 'pdf' + download_type?: 'csv' | 'generic' | 'pdf' | undefined /** 取得開始日 (yyyy-mm-dd) */ - start_date?: string + start_date?: string | undefined /** 取得終了日 (yyyy-mm-dd) */ - end_date?: string - visible_tags?: ('partner' | 'item' | 'tag' | 'section' | 'description' | 'wallet_txn_description' | 'all')[] + end_date?: string | undefined + visible_tags?: ('partner' | 'item' | 'tag' | 'section' | 'description' | 'wallet_txn_description' | 'all')[] | undefined /** ステータス確認用URL */ - status_url?: string + status_url?: string | undefined } } @@ -766,7 +766,7 @@ export type JournalStatusResponse = { end_date: string visible_tags: ('partner' | 'item' | 'tag' | 'section' | 'description' | 'wallet_txn_description' | 'all')[] /** ダウンロードURL */ - download_url?: string + download_url?: string | undefined } } @@ -777,90 +777,90 @@ export type TrialBsResponse = { /** 集計結果が最新かどうか */ up_to_date: boolean /** 会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる） */ - fiscal_year?: number + fiscal_year?: number | undefined /** 発生月で絞込：開始会計月(mm)(条件に指定した時のみ含まれる） */ - start_month?: number + start_month?: number | undefined /** 発生月で絞込：終了会計月(mm)(条件に指定した時のみ含まれる） */ - end_month?: number + end_month?: number | undefined /** 発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる） */ - start_date?: string + start_date?: string | undefined /** 発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる） */ - end_date?: string + end_date?: string | undefined /** 勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる） */ - account_item_display_type?: 'account_item' | 'group' + account_item_display_type?: 'account_item' | 'group' | undefined /** 内訳の表示（取引先: partner, 品目: item, 勘定科目: account_item）(条件に指定した時のみ含まれる） */ - breakdown_display_type?: 'partner' | 'item' | 'account_item' + breakdown_display_type?: 'partner' | 'item' | 'account_item' | undefined /** 取引先ID(条件に指定した時のみ含まれる） */ - partner_id?: number + partner_id?: number | undefined /** 取引先コード(条件に指定した時のみ含まれる） */ - partner_code?: string + partner_code?: string | undefined /** 品目ID(条件に指定した時のみ含まれる） */ - item_id?: number + item_id?: number | undefined /** 決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる） */ - adjustment?: 'only' | 'without' + adjustment?: 'only' | 'without' | undefined /** 作成日時 */ - created_at?: string + created_at?: string | undefined balances: { /** 勘定科目ID(勘定科目の時のみ含まれる) */ - account_item_id?: number + account_item_id?: number | undefined /** 勘定科目名(勘定科目の時のみ含まれる) */ - account_item_name?: string + account_item_name?: string | undefined /** breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる */ partners?: { /** 取引先ID */ id: number /** 取引先名 */ - name?: string + name?: string | undefined /** 期首残高 */ - opening_balance?: number + opening_balance?: number | undefined /** 借方金額 */ - debit_amount?: number + debit_amount?: number | undefined /** 貸方金額 */ - credit_amount?: number + credit_amount?: number | undefined /** 期末残高 */ - closing_balance?: number + closing_balance?: number | undefined /** 構成比 */ - composition_ratio?: number - }[] + composition_ratio?: number | undefined + }[] | undefined /** breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる */ items?: { /** 品目ID */ id: number /** 品目 */ - name?: string + name?: string | undefined /** 期首残高 */ - opening_balance?: number + opening_balance?: number | undefined /** 借方金額 */ - debit_amount?: number + debit_amount?: number | undefined /** 貸方金額 */ - credit_amount?: number + credit_amount?: number | undefined /** 期末残高 */ - closing_balance?: number + closing_balance?: number | undefined /** 構成比 */ - composition_ratio?: number - }[] + composition_ratio?: number | undefined + }[] | undefined /** 勘定科目カテゴリーID(勘定科目カテゴリーの時のみ含まれる) */ - account_category_id?: number + account_category_id?: number | undefined /** 勘定科目カテゴリー名(勘定科目カテゴリーの時のみ含まれる) */ - account_category_name?: string + account_category_name?: string | undefined /** 合計行(勘定科目カテゴリー名の時のみ含まれる) */ - total_line?: boolean + total_line?: boolean | undefined /** 階層レベル */ - hierarchy_level?: number + hierarchy_level?: number | undefined /** 上位科目カテゴリーID(上層が存在する場合含まれる) */ - parent_account_category_id?: number + parent_account_category_id?: number | undefined /** 上位勘定科目カテゴリー名(上層が存在する場合含まれる) */ - parent_account_category_name?: string + parent_account_category_name?: string | undefined /** 期首残高 */ - opening_balance?: number + opening_balance?: number | undefined /** 借方金額 */ - debit_amount?: number + debit_amount?: number | undefined /** 貸方金額 */ - credit_amount?: number + credit_amount?: number | undefined /** 期末残高 */ - closing_balance?: number + closing_balance?: number | undefined /** 構成比 */ - composition_ratio?: number + composition_ratio?: number | undefined }[] } } @@ -872,78 +872,78 @@ export type TrialBsTwoYearsResponse = { /** 集計結果が最新かどうか */ up_to_date: boolean /** 会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる） */ - fiscal_year?: number + fiscal_year?: number | undefined /** 発生月で絞込：開始会計月(mm)(条件に指定した時のみ含まれる） */ - start_month?: number + start_month?: number | undefined /** 発生月で絞込：終了会計月(mm)(条件に指定した時のみ含まれる） */ - end_month?: number + end_month?: number | undefined /** 発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる） */ - start_date?: string + start_date?: string | undefined /** 発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる） */ - end_date?: string + end_date?: string | undefined /** 勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる） */ - account_item_display_type?: 'account_item' | 'group' + account_item_display_type?: 'account_item' | 'group' | undefined /** 内訳の表示（取引先: partner, 品目: item, 勘定科目: account_item）(条件に指定した時のみ含まれる） */ - breakdown_display_type?: 'partner' | 'item' | 'account_item' + breakdown_display_type?: 'partner' | 'item' | 'account_item' | undefined /** 取引先ID(条件に指定した時のみ含まれる） */ - partner_id?: number + partner_id?: number | undefined /** 取引先コード(条件に指定した時のみ含まれる） */ - partner_code?: string + partner_code?: string | undefined /** 品目ID(条件に指定した時のみ含まれる） */ - item_id?: number + item_id?: number | undefined /** 決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる） */ - adjustment?: 'only' | 'without' + adjustment?: 'only' | 'without' | undefined /** 作成日時 */ - created_at?: string + created_at?: string | undefined balances: { /** 勘定科目ID(勘定科目の時のみ含まれる) */ - account_item_id?: number + account_item_id?: number | undefined /** 勘定科目名(勘定科目の時のみ含まれる) */ - account_item_name?: string + account_item_name?: string | undefined /** breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる */ partners?: { /** 取引先ID */ id: number /** 取引先名 */ - name?: string + name?: string | undefined /** 前年度期末残高 */ - last_year_closing_balance?: number + last_year_closing_balance?: number | undefined /** 期末残高 */ - closing_balance?: number + closing_balance?: number | undefined /** 前年比 */ - year_on_year?: number - }[] + year_on_year?: number | undefined + }[] | undefined /** breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる */ items?: { /** 品目ID */ id: number /** 品目 */ - name?: string + name?: string | undefined /** 前年度期末残高 */ - last_year_closing_balance?: number + last_year_closing_balance?: number | undefined /** 期末残高 */ - closing_balance?: number + closing_balance?: number | undefined /** 前年比 */ - year_on_year?: number - }[] + year_on_year?: number | undefined + }[] | undefined /** 勘定科目カテゴリーID(勘定科目カテゴリーの時のみ含まれる) */ - account_category_id?: number + account_category_id?: number | undefined /** 勘定科目カテゴリー名(勘定科目カテゴリーの時のみ含まれる) */ - account_category_name?: string + account_category_name?: string | undefined /** 合計行(勘定科目カテゴリー名の時のみ含まれる) */ - total_line?: boolean + total_line?: boolean | undefined /** 階層レベル */ - hierarchy_level?: number + hierarchy_level?: number | undefined /** 上位科目カテゴリーID(上層が存在する場合含まれる) */ - parent_account_category_id?: number + parent_account_category_id?: number | undefined /** 上位勘定科目カテゴリー名(上層が存在する場合含まれる) */ - parent_account_category_name?: string + parent_account_category_name?: string | undefined /** 前年度期末残高 */ - last_year_closing_balance?: number + last_year_closing_balance?: number | undefined /** 期末残高 */ - closing_balance?: number + closing_balance?: number | undefined /** 前年比 */ - year_on_year?: number + year_on_year?: number | undefined }[] } } @@ -955,84 +955,84 @@ export type TrialBsThreeYearsResponse = { /** 集計結果が最新かどうか */ up_to_date: boolean /** 会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる） */ - fiscal_year?: number + fiscal_year?: number | undefined /** 発生月で絞込：開始会計月(mm)(条件に指定した時のみ含まれる） */ - start_month?: number + start_month?: number | undefined /** 発生月で絞込：終了会計月(mm)(条件に指定した時のみ含まれる） */ - end_month?: number + end_month?: number | undefined /** 発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる） */ - start_date?: string + start_date?: string | undefined /** 発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる） */ - end_date?: string + end_date?: string | undefined /** 勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる） */ - account_item_display_type?: 'account_item' | 'group' + account_item_display_type?: 'account_item' | 'group' | undefined /** 内訳の表示（取引先: partner, 品目: item, 勘定科目: account_item）(条件に指定した時のみ含まれる） */ - breakdown_display_type?: 'partner' | 'item' | 'account_item' + breakdown_display_type?: 'partner' | 'item' | 'account_item' | undefined /** 取引先ID(条件に指定した時のみ含まれる） */ - partner_id?: number + partner_id?: number | undefined /** 取引先コード(条件に指定した時のみ含まれる） */ - partner_code?: string + partner_code?: string | undefined /** 品目ID(条件に指定した時のみ含まれる） */ - item_id?: number + item_id?: number | undefined /** 決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる） */ - adjustment?: 'only' | 'without' + adjustment?: 'only' | 'without' | undefined /** 作成日時 */ - created_at?: string + created_at?: string | undefined balances: { /** 勘定科目ID(勘定科目の時のみ含まれる) */ - account_item_id?: number + account_item_id?: number | undefined /** 勘定科目名(勘定科目の時のみ含まれる) */ - account_item_name?: string + account_item_name?: string | undefined /** breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる */ partners?: { /** 取引先ID */ id: number /** 取引先名 */ - name?: string + name?: string | undefined /** 前々年度期末残高 */ - two_years_before_closing_balance?: number + two_years_before_closing_balance?: number | undefined /** 前年度期末残高 */ - last_year_closing_balance?: number + last_year_closing_balance?: number | undefined /** 期末残高 */ - closing_balance?: number + closing_balance?: number | undefined /** 前年比 */ - year_on_year?: number - }[] + year_on_year?: number | undefined + }[] | undefined /** breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる */ items?: { /** 品目ID */ id: number /** 品目 */ - name?: string + name?: string | undefined /** 前々年度期末残高 */ - two_years_before_closing_balance?: number + two_years_before_closing_balance?: number | undefined /** 前年度期末残高 */ - last_year_closing_balance?: number + last_year_closing_balance?: number | undefined /** 期末残高 */ - closing_balance?: number + closing_balance?: number | undefined /** 前年比 */ - year_on_year?: number - }[] + year_on_year?: number | undefined + }[] | undefined /** 勘定科目カテゴリーID(勘定科目カテゴリーの時のみ含まれる) */ - account_category_id?: number + account_category_id?: number | undefined /** 勘定科目カテゴリー名(勘定科目カテゴリーの時のみ含まれる) */ - account_category_name?: string + account_category_name?: string | undefined /** 合計行(勘定科目カテゴリー名の時のみ含まれる) */ - total_line?: boolean + total_line?: boolean | undefined /** 階層レベル */ - hierarchy_level?: number + hierarchy_level?: number | undefined /** 上位科目カテゴリーID(上層が存在する場合含まれる) */ - parent_account_category_id?: number + parent_account_category_id?: number | undefined /** 上位勘定科目カテゴリー名(上層が存在する場合含まれる) */ - parent_account_category_name?: string + parent_account_category_name?: string | undefined /** 前々年度期末残高 */ - two_years_before_closing_balance?: number + two_years_before_closing_balance?: number | undefined /** 前年度期末残高 */ - last_year_closing_balance?: number + last_year_closing_balance?: number | undefined /** 期末残高 */ - closing_balance?: number + closing_balance?: number | undefined /** 前年比 */ - year_on_year?: number + year_on_year?: number | undefined }[] } } @@ -1044,111 +1044,111 @@ export type TrialPlResponse = { /** 集計結果が最新かどうか */ up_to_date: boolean /** 会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる） */ - fiscal_year?: number + fiscal_year?: number | undefined /** 発生月で絞込：開始会計月(mm)(条件に指定した時のみ含まれる） */ - start_month?: number + start_month?: number | undefined /** 発生月で絞込：終了会計月(mm)(条件に指定した時のみ含まれる） */ - end_month?: number + end_month?: number | undefined /** 発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる） */ - start_date?: string + start_date?: string | undefined /** 発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる） */ - end_date?: string + end_date?: string | undefined /** 勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる） */ - account_item_display_type?: 'account_item' | 'group' + account_item_display_type?: 'account_item' | 'group' | undefined /** 内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item）(条件に指定した時のみ含まれる） */ - breakdown_display_type?: 'partner' | 'item' | 'section' | 'account_item' + breakdown_display_type?: 'partner' | 'item' | 'section' | 'account_item' | undefined /** 取引先ID(条件に指定した時のみ含まれる） */ - partner_id?: number + partner_id?: number | undefined /** 取引先コード(条件に指定した時のみ含まれる） */ - partner_code?: string + partner_code?: string | undefined /** 品目ID(条件に指定した時のみ含まれる） */ - item_id?: number + item_id?: number | undefined /** 部門ID(条件に指定した時のみ含まれる） */ - section_id?: number + section_id?: number | undefined /** 決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる） */ - adjustment?: 'only' | 'without' + adjustment?: 'only' | 'without' | undefined /** 配賦仕訳のみ：only,配賦仕訳以外：without(条件に指定した時のみ含まれる） */ - cost_allocation?: 'only' | 'without' + cost_allocation?: 'only' | 'without' | undefined /** 作成日時 */ - created_at?: string + created_at?: string | undefined balances: { /** 勘定科目ID(勘定科目の時のみ含まれる) */ - account_item_id?: number + account_item_id?: number | undefined /** 勘定科目名(勘定科目の時のみ含まれる) */ - account_item_name?: string + account_item_name?: string | undefined /** breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる */ partners?: { /** 取引先ID */ id: number /** 取引先名 */ - name?: string + name?: string | undefined /** 期首残高 */ - opening_balance?: number + opening_balance?: number | undefined /** 借方金額 */ - debit_amount?: number + debit_amount?: number | undefined /** 貸方金額 */ - credit_amount?: number + credit_amount?: number | undefined /** 期末残高 */ - closing_balance?: number + closing_balance?: number | undefined /** 構成比 */ - composition_ratio?: number - }[] + composition_ratio?: number | undefined + }[] | undefined /** breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる */ items?: { /** 品目ID */ id: number /** 品目 */ - name?: string + name?: string | undefined /** 期首残高 */ - opening_balance?: number + opening_balance?: number | undefined /** 借方金額 */ - debit_amount?: number + debit_amount?: number | undefined /** 貸方金額 */ - credit_amount?: number + credit_amount?: number | undefined /** 期末残高 */ - closing_balance?: number + closing_balance?: number | undefined /** 構成比 */ - composition_ratio?: number - }[] + composition_ratio?: number | undefined + }[] | undefined /** breakdown_display_type:section, account_item_display_type:account_item指定時のみ含まれる */ sections?: { /** 部門ID */ id: number /** 部門名 */ - name?: string + name?: string | undefined /** 期首残高 */ - opening_balance?: number + opening_balance?: number | undefined /** 借方金額 */ - debit_amount?: number + debit_amount?: number | undefined /** 貸方金額 */ - credit_amount?: number + credit_amount?: number | undefined /** 期末残高 */ - closing_balance?: number + closing_balance?: number | undefined /** 構成比 */ - composition_ratio?: number - }[] + composition_ratio?: number | undefined + }[] | undefined /** 勘定科目カテゴリーID(勘定科目カテゴリーの時のみ含まれる) */ - account_category_id?: number + account_category_id?: number | undefined /** 勘定科目カテゴリー名(勘定科目カテゴリーの時のみ含まれる) */ - account_category_name?: string + account_category_name?: string | undefined /** 合計行(勘定科目カテゴリー名の時のみ含まれる) */ - total_line?: boolean + total_line?: boolean | undefined /** 階層レベル */ - hierarchy_level?: number + hierarchy_level?: number | undefined /** 上位科目カテゴリーID(上層が存在する場合含まれる) */ - parent_account_category_id?: number + parent_account_category_id?: number | undefined /** 上位勘定科目カテゴリー名(上層が存在する場合含まれる) */ - parent_account_category_name?: string + parent_account_category_name?: string | undefined /** 期首残高 */ - opening_balance?: number + opening_balance?: number | undefined /** 借方金額 */ - debit_amount?: number + debit_amount?: number | undefined /** 貸方金額 */ - credit_amount?: number + credit_amount?: number | undefined /** 期末残高 */ - closing_balance?: number + closing_balance?: number | undefined /** 構成比 */ - composition_ratio?: number + composition_ratio?: number | undefined }[] } } @@ -1160,95 +1160,95 @@ export type TrialPlTwoYearsResponse = { /** 集計結果が最新かどうか */ up_to_date: boolean /** 会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる） */ - fiscal_year?: number + fiscal_year?: number | undefined /** 発生月で絞込：開始会計月(mm)(条件に指定した時のみ含まれる） */ - start_month?: number + start_month?: number | undefined /** 発生月で絞込：終了会計月(mm)(条件に指定した時のみ含まれる） */ - end_month?: number + end_month?: number | undefined /** 発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる） */ - start_date?: string + start_date?: string | undefined /** 発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる） */ - end_date?: string + end_date?: string | undefined /** 勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる） */ - account_item_display_type?: 'account_item' | 'group' + account_item_display_type?: 'account_item' | 'group' | undefined /** 内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item）(条件に指定した時のみ含まれる） */ - breakdown_display_type?: 'partner' | 'item' | 'section' | 'account_item' + breakdown_display_type?: 'partner' | 'item' | 'section' | 'account_item' | undefined /** 取引先ID(条件に指定した時のみ含まれる） */ - partner_id?: number + partner_id?: number | undefined /** 取引先コード(条件に指定した時のみ含まれる） */ - partner_code?: string + partner_code?: string | undefined /** 品目ID(条件に指定した時のみ含まれる） */ - item_id?: number + item_id?: number | undefined /** 部門ID(条件に指定した時のみ含まれる） */ - section_id?: number + section_id?: number | undefined /** 決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる） */ - adjustment?: 'only' | 'without' + adjustment?: 'only' | 'without' | undefined /** 配賦仕訳のみ：only,配賦仕訳以外：without(条件に指定した時のみ含まれる） */ - cost_allocation?: 'only' | 'without' + cost_allocation?: 'only' | 'without' | undefined /** 作成日時 */ - created_at?: string + created_at?: string | undefined balances: { /** 勘定科目ID(勘定科目の時のみ含まれる) */ - account_item_id?: number + account_item_id?: number | undefined /** 勘定科目名(勘定科目の時のみ含まれる) */ - account_item_name?: string + account_item_name?: string | undefined /** breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる */ partners?: { /** 取引先ID */ id: number /** 取引先名 */ - name?: string + name?: string | undefined /** 前年度期末残高 */ - last_year_closing_balance?: number + last_year_closing_balance?: number | undefined /** 期末残高 */ - closing_balance?: number + closing_balance?: number | undefined /** 前年比 */ - year_on_year?: number - }[] + year_on_year?: number | undefined + }[] | undefined /** breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる */ items?: { /** 品目ID */ id: number /** 品目 */ - name?: string + name?: string | undefined /** 前年度期末残高 */ - last_year_closing_balance?: number + last_year_closing_balance?: number | undefined /** 期末残高 */ - closing_balance?: number + closing_balance?: number | undefined /** 前年比 */ - year_on_year?: number - }[] + year_on_year?: number | undefined + }[] | undefined /** breakdown_display_type:section, account_item_display_type:account_item指定時のみ含まれる */ sections?: { /** 部門ID */ id: number /** 部門名 */ - name?: string + name?: string | undefined /** 前年度期末残高 */ - last_year_closing_balance?: number + last_year_closing_balance?: number | undefined /** 期末残高 */ - closing_balance?: number + closing_balance?: number | undefined /** 前年比 */ - year_on_year?: number - }[] + year_on_year?: number | undefined + }[] | undefined /** 勘定科目カテゴリーID(勘定科目カテゴリーの時のみ含まれる) */ - account_category_id?: number + account_category_id?: number | undefined /** 勘定科目カテゴリー名(勘定科目カテゴリーの時のみ含まれる) */ - account_category_name?: string + account_category_name?: string | undefined /** 合計行(勘定科目カテゴリー名の時のみ含まれる) */ - total_line?: boolean + total_line?: boolean | undefined /** 階層レベル */ - hierarchy_level?: number + hierarchy_level?: number | undefined /** 上位科目カテゴリーID(上層が存在する場合含まれる) */ - parent_account_category_id?: number + parent_account_category_id?: number | undefined /** 上位勘定科目カテゴリー名(上層が存在する場合含まれる) */ - parent_account_category_name?: string + parent_account_category_name?: string | undefined /** 前年度期末残高 */ - last_year_closing_balance?: number + last_year_closing_balance?: number | undefined /** 期末残高 */ - closing_balance?: number + closing_balance?: number | undefined /** 前年比 */ - year_on_year?: number + year_on_year?: number | undefined }[] } } @@ -1260,103 +1260,103 @@ export type TrialPlThreeYearsResponse = { /** 集計結果が最新かどうか */ up_to_date: boolean /** 会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる） */ - fiscal_year?: number + fiscal_year?: number | undefined /** 発生月で絞込：開始会計月(mm)(条件に指定した時のみ含まれる） */ - start_month?: number + start_month?: number | undefined /** 発生月で絞込：終了会計月(mm)(条件に指定した時のみ含まれる） */ - end_month?: number + end_month?: number | undefined /** 発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる） */ - start_date?: string + start_date?: string | undefined /** 発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる） */ - end_date?: string + end_date?: string | undefined /** 勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる） */ - account_item_display_type?: 'account_item' | 'group' + account_item_display_type?: 'account_item' | 'group' | undefined /** 内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item）(条件に指定した時のみ含まれる） */ - breakdown_display_type?: 'partner' | 'item' | 'section' | 'account_item' + breakdown_display_type?: 'partner' | 'item' | 'section' | 'account_item' | undefined /** 取引先ID(条件に指定した時のみ含まれる） */ - partner_id?: number + partner_id?: number | undefined /** 取引先コード(条件に指定した時のみ含まれる） */ - partner_code?: string + partner_code?: string | undefined /** 品目ID(条件に指定した時のみ含まれる） */ - item_id?: number + item_id?: number | undefined /** 部門ID(条件に指定した時のみ含まれる） */ - section_id?: number + section_id?: number | undefined /** 決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる） */ - adjustment?: 'only' | 'without' + adjustment?: 'only' | 'without' | undefined /** 配賦仕訳のみ：only,配賦仕訳以外：without(条件に指定した時のみ含まれる） */ - cost_allocation?: 'only' | 'without' + cost_allocation?: 'only' | 'without' | undefined /** 作成日時 */ - created_at?: string + created_at?: string | undefined balances: { /** 勘定科目ID(勘定科目の時のみ含まれる) */ - account_item_id?: number + account_item_id?: number | undefined /** 勘定科目名(勘定科目の時のみ含まれる) */ - account_item_name?: string + account_item_name?: string | undefined /** breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる */ partners?: { /** 取引先ID */ id: number /** 取引先名 */ - name?: string + name?: string | undefined /** 前々年度期末残高 */ - two_years_before_closing_balance?: number + two_years_before_closing_balance?: number | undefined /** 前年度期末残高 */ - last_year_closing_balance?: number + last_year_closing_balance?: number | undefined /** 期末残高 */ - closing_balance?: number + closing_balance?: number | undefined /** 前年比 */ - year_on_year?: number - }[] + year_on_year?: number | undefined + }[] | undefined /** breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる */ items?: { /** 品目ID */ id: number /** 品目 */ - name?: string + name?: string | undefined /** 前々年度期末残高 */ - two_years_before_closing_balance?: number + two_years_before_closing_balance?: number | undefined /** 前年度期末残高 */ - last_year_closing_balance?: number + last_year_closing_balance?: number | undefined /** 期末残高 */ - closing_balance?: number + closing_balance?: number | undefined /** 前年比 */ - year_on_year?: number - }[] + year_on_year?: number | undefined + }[] | undefined /** breakdown_display_type:section, account_item_display_type:account_item指定時のみ含まれる */ sections?: { /** 部門ID */ id: number /** 部門名 */ - name?: string + name?: string | undefined /** 前々年度期末残高 */ - two_years_before_closing_balance?: number + two_years_before_closing_balance?: number | undefined /** 前年度期末残高 */ - last_year_closing_balance?: number + last_year_closing_balance?: number | undefined /** 期末残高 */ - closing_balance?: number + closing_balance?: number | undefined /** 前年比 */ - year_on_year?: number - }[] + year_on_year?: number | undefined + }[] | undefined /** 勘定科目カテゴリーID(勘定科目カテゴリーの時のみ含まれる) */ - account_category_id?: number + account_category_id?: number | undefined /** 勘定科目カテゴリー名(勘定科目カテゴリーの時のみ含まれる) */ - account_category_name?: string + account_category_name?: string | undefined /** 合計行(勘定科目カテゴリー名の時のみ含まれる) */ - total_line?: boolean + total_line?: boolean | undefined /** 階層レベル */ - hierarchy_level?: number + hierarchy_level?: number | undefined /** 上位科目カテゴリーID(上層が存在する場合含まれる) */ - parent_account_category_id?: number + parent_account_category_id?: number | undefined /** 上位勘定科目カテゴリー名(上層が存在する場合含まれる) */ - parent_account_category_name?: string + parent_account_category_name?: string | undefined /** 前々年度期末残高 */ - two_years_before_closing_balance?: number + two_years_before_closing_balance?: number | undefined /** 前年度期末残高 */ - last_year_closing_balance?: number + last_year_closing_balance?: number | undefined /** 期末残高 */ - closing_balance?: number + closing_balance?: number | undefined /** 前年比 */ - year_on_year?: number + year_on_year?: number | undefined }[] } } @@ -1370,77 +1370,77 @@ export type TrialPlSectionsResponse = { /** 出力する部門の指定 */ section_ids: string /** 会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる） */ - fiscal_year?: number + fiscal_year?: number | undefined /** 発生月で絞込：開始会計月(mm)(条件に指定した時のみ含まれる） */ - start_month?: number + start_month?: number | undefined /** 発生月で絞込：終了会計月(mm)(条件に指定した時のみ含まれる） */ - end_month?: number + end_month?: number | undefined /** 発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる） */ - start_date?: string + start_date?: string | undefined /** 発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる） */ - end_date?: string + end_date?: string | undefined /** 勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる） */ - account_item_display_type?: 'account_item' | 'group' + account_item_display_type?: 'account_item' | 'group' | undefined /** 内訳の表示（取引先: partner, 品目: item, 勘定科目: account_item）(条件に指定した時のみ含まれる） */ - breakdown_display_type?: 'partner' | 'item' | 'account_item' + breakdown_display_type?: 'partner' | 'item' | 'account_item' | undefined /** 取引先ID(条件に指定した時のみ含まれる） */ - partner_id?: number + partner_id?: number | undefined /** 取引先コード(条件に指定した時のみ含まれる） */ - partner_code?: string + partner_code?: string | undefined /** 品目ID(条件に指定した時のみ含まれる） */ - item_id?: number + item_id?: number | undefined /** 決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる） */ - adjustment?: 'only' | 'without' + adjustment?: 'only' | 'without' | undefined /** 配賦仕訳のみ：only,配賦仕訳以外：without(条件に指定した時のみ含まれる） */ - cost_allocation?: 'only' | 'without' + cost_allocation?: 'only' | 'without' | undefined /** 作成日時 */ - created_at?: string + created_at?: string | undefined balances: { /** 勘定科目ID(勘定科目の時のみ含まれる) */ - account_item_id?: number + account_item_id?: number | undefined /** 勘定科目名(勘定科目の時のみ含まれる) */ - account_item_name?: string + account_item_name?: string | undefined /** 部門(勘定科目の時のみ含まれる) */ sections?: { /** 部門ID */ id: number /** 部門名 */ - name?: string + name?: string | undefined /** 期末残高 */ - closing_balance?: number + closing_balance?: number | undefined /** breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる */ partners?: { /** 取引先ID */ id: number /** 取引先名 */ - name?: string + name?: string | undefined /** 期末残高 */ - closing_balance?: number - }[] + closing_balance?: number | undefined + }[] | undefined /** breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる */ items?: { /** 品目ID */ id: number /** 品目 */ - name?: string + name?: string | undefined /** 期末残高 */ - closing_balance?: number - }[] - }[] + closing_balance?: number | undefined + }[] | undefined + }[] | undefined /** 勘定科目カテゴリーID(勘定科目カテゴリーの時のみ含まれる) */ - account_category_id?: number + account_category_id?: number | undefined /** 勘定科目カテゴリー名(勘定科目カテゴリーの時のみ含まれる) */ - account_category_name?: string + account_category_name?: string | undefined /** 合計行(勘定科目カテゴリー名の時のみ含まれる) */ - total_line?: boolean + total_line?: boolean | undefined /** 階層レベル */ - hierarchy_level?: number + hierarchy_level?: number | undefined /** 上位科目カテゴリーID(上層が存在する場合含まれる) */ - parent_account_category_id?: number + parent_account_category_id?: number | undefined /** 上位勘定科目カテゴリー名(上層が存在する場合含まれる) */ - parent_account_category_name?: string + parent_account_category_name?: string | undefined /** 期末残高 */ - closing_balance?: number + closing_balance?: number | undefined }[] } } @@ -1451,13 +1451,13 @@ export type SectionParams = { /** 部門名 (30文字以内) */ name: string /** 正式名称 (255文字以内) */ - long_name?: string + long_name?: string | undefined /** ショートカット１ (20文字以内) */ - shortcut1?: string + shortcut1?: string | undefined /** ショートカット２ (20文字以内) */ - shortcut2?: string + shortcut2?: string | undefined /** 親部門ID (ビジネスプラン以上) */ - parent_id?: number + parent_id?: number | undefined } export type SectionResponse = { @@ -1467,13 +1467,13 @@ export type SectionResponse = { /** 部門名 (30文字以内) */ name: string /** 正式名称（255文字以内） */ - long_name?: string | null + long_name?: string | null | undefined /** 事業所ID */ company_id: number /** ショートカット１ (20文字以内) */ - shortcut1?: string | null + shortcut1?: string | null | undefined /** ショートカット２ (20文字以内) */ - shortcut2?: string | null + shortcut2?: string | null | undefined } } @@ -1486,19 +1486,19 @@ export type DealCreateResponse = { /** 発生日 (yyyy-mm-dd) */ issue_date: string /** 支払期日 (yyyy-mm-dd) */ - due_date?: string + due_date?: string | undefined /** 金額 */ amount: number /** 支払金額 */ - due_amount?: number + due_amount?: number | undefined /** 収支区分 (収入: income, 支出: expense) */ - type?: 'income' | 'expense' + type?: 'income' | 'expense' | undefined /** 取引先ID */ partner_id: number /** 取引先コード */ - partner_code?: string | null + partner_code?: string | null | undefined /** 管理番号 */ - ref_number?: string + ref_number?: string | undefined /** 決済状況 (未決済: unsettled, 完了: settled) */ status: 'unsettled' | 'settled' /** 取引の明細行 */ @@ -1508,30 +1508,30 @@ export type DealCreateResponse = { /** 勘定科目ID */ account_item_id: number /** 税区分ID（廃止予定） */ - tax_id?: number + tax_id?: number | undefined /** 税区分コード */ tax_code: number /** 品目ID */ - item_id?: number | null + item_id?: number | null | undefined /** 部門ID */ - section_id?: number | null + section_id?: number | null | undefined /** メモタグID */ - tag_ids?: number[] + tag_ids?: number[] | undefined /** セグメント１ID */ - segment_1_tag_id?: number | null + segment_1_tag_id?: number | null | undefined /** セグメント２ID */ - segment_2_tag_id?: number | null + segment_2_tag_id?: number | null | undefined /** セグメント３ID */ - segment_3_tag_id?: number | null + segment_3_tag_id?: number | null | undefined /** 取引金額 */ amount: number /** 消費税額 */ vat: number /** 備考 */ - description?: string + description?: string | undefined /** 貸借（貸方: credit, 借方: debit） */ entry_side: 'credit' | 'debit' - }[] + }[] | undefined /** 取引の支払行 */ payments?: { /** 取引行ID */ @@ -1539,12 +1539,12 @@ export type DealCreateResponse = { /** 支払日 */ date: string /** 口座区分 (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet, プライベート資金（法人の場合は役員借入金もしくは役員借入金、個人の場合は事業主貸もしくは事業主借）: private_account_item) */ - from_walletable_type?: 'bank_account' | 'credit_card' | 'wallet' | 'private_account_item' + from_walletable_type?: 'bank_account' | 'credit_card' | 'wallet' | 'private_account_item' | undefined /** 口座ID（from_walletable_typeがprivate_account_itemの場合は勘定科目ID） */ - from_walletable_id?: number + from_walletable_id?: number | undefined /** 支払金額 */ amount: number - }[] + }[] | undefined } } @@ -1557,19 +1557,19 @@ export type DealResponse = { /** 発生日 (yyyy-mm-dd) */ issue_date: string /** 支払期日 (yyyy-mm-dd) */ - due_date?: string + due_date?: string | undefined /** 金額 */ amount: number /** 支払金額 */ - due_amount?: number + due_amount?: number | undefined /** 収支区分 (収入: income, 支出: expense) */ - type?: 'income' | 'expense' + type?: 'income' | 'expense' | undefined /** 取引先ID */ partner_id: number /** 取引先コード */ - partner_code?: string | null + partner_code?: string | null | undefined /** 管理番号 */ - ref_number?: string + ref_number?: string | undefined /** 決済状況 (未決済: unsettled, 完了: settled) */ status: 'unsettled' | 'settled' /** 取引の明細行 */ @@ -1579,30 +1579,30 @@ export type DealResponse = { /** 勘定科目ID */ account_item_id: number /** 税区分ID（廃止予定） */ - tax_id?: number + tax_id?: number | undefined /** 税区分コード */ tax_code: number /** 品目ID */ - item_id?: number | null + item_id?: number | null | undefined /** 部門ID */ - section_id?: number | null + section_id?: number | null | undefined /** メモタグID */ - tag_ids?: number[] + tag_ids?: number[] | undefined /** セグメント１ID */ - segment_1_tag_id?: number | null + segment_1_tag_id?: number | null | undefined /** セグメント２ID */ - segment_2_tag_id?: number | null + segment_2_tag_id?: number | null | undefined /** セグメント３ID */ - segment_3_tag_id?: number | null + segment_3_tag_id?: number | null | undefined /** 取引金額 */ amount: number /** 消費税額 */ vat: number /** 備考 */ - description?: string + description?: string | undefined /** 貸借（貸方: credit, 借方: debit） */ entry_side: 'credit' | 'debit' - }[] + }[] | undefined /** 取引の+更新行 */ renews?: { /** +更新行ID */ @@ -1624,24 +1624,24 @@ export type DealResponse = { /** 税区分コード */ tax_code: number /** 品目ID */ - item_id?: number | null + item_id?: number | null | undefined /** 部門ID */ - section_id?: number | null + section_id?: number | null | undefined tag_ids: number[] /** セグメント１ID */ - segment_1_tag_id?: number | null + segment_1_tag_id?: number | null | undefined /** セグメント２ID */ - segment_2_tag_id?: number | null + segment_2_tag_id?: number | null | undefined /** セグメント３ID */ - segment_3_tag_id?: number | null + segment_3_tag_id?: number | null | undefined /** 金額（税込で指定してください） */ amount: number /** 消費税額（指定しない場合は自動で計算されます） */ vat: number /** 備考 */ - description?: string | null + description?: string | null | undefined }[] - }[] + }[] | undefined /** 取引の支払行 */ payments?: { /** 取引行ID */ @@ -1649,12 +1649,12 @@ export type DealResponse = { /** 支払日 */ date: string /** 口座区分 (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet, プライベート資金（法人の場合は役員借入金もしくは役員借入金、個人の場合は事業主貸もしくは事業主借）: private_account_item) */ - from_walletable_type?: 'bank_account' | 'credit_card' | 'wallet' | 'private_account_item' + from_walletable_type?: 'bank_account' | 'credit_card' | 'wallet' | 'private_account_item' | undefined /** 口座ID（from_walletable_typeがprivate_account_itemの場合は勘定科目ID） */ - from_walletable_id?: number + from_walletable_id?: number | undefined /** 支払金額 */ amount: number - }[] + }[] | undefined /** 証憑ファイル */ receipts?: { /** 証憑ID */ @@ -1662,11 +1662,11 @@ export type DealResponse = { /** ステータス(unconfirmed:確認待ち、confirmed:確認済み、deleted:削除済み、ignored:無視) */ status: 'unconfirmed' | 'confirmed' | 'deleted' | 'ignored' /** メモ */ - description?: string + description?: string | undefined /** MIMEタイプ */ mime_type: string /** 発生日 */ - issue_date?: string + issue_date?: string | undefined /** アップロード元種別 */ origin: 'unknown' | 'web' | 'mobile_camera' | 'mobile_album' | 'scansnap' | 'scannable' | 'dropbox' | 'mail' | 'safety_contact_file' | 'public_api' /** 作成日時（ISO8601形式） */ @@ -1680,9 +1680,9 @@ export type DealResponse = { /** メールアドレス */ email: string /** 表示名 */ - display_name?: string | null + display_name?: string | null | undefined } - }[] + }[] | undefined } } @@ -1697,37 +1697,37 @@ export type SelectablesIndexResponse = { /** カテゴリー名 */ title: string /** カテゴリーの説明 */ - desc?: string + desc?: string | undefined /** 勘定科目の一覧 */ account_items: { /** 勘定科目ID */ id: number /** 勘定科目 */ - name?: string + name?: string | undefined /** 勘定科目の説明 */ - desc?: string + desc?: string | undefined /** 勘定科目の説明（詳細） */ - help?: string + help?: string | undefined /** ショートカット */ - shortcut?: string + shortcut?: string | undefined default_tax?: { tax_rate_5?: { /** 税区分ID */ - id?: number + id?: number | undefined /** 税区分 */ - name?: string - } + name?: string | undefined + } | undefined tax_rate_8?: { /** 税区分ID */ - id?: number + id?: number | undefined /** 税区分 */ - name?: string - } - } + name?: string | undefined + } | undefined + } | undefined }[] - }[] + }[] | undefined /** 決算書表示名（小カテゴリー） */ account_groups?: { /** 決算書表示名（小カテゴリー）ID */ @@ -1739,14 +1739,14 @@ export type SelectablesIndexResponse = { /** 勘定科目カテゴリーID */ account_category_id: number /** 詳細パラメータの種類 */ - detail_type?: number + detail_type?: number | undefined /** 並び順 */ index: number /** 作成日時 */ - created_at?: string + created_at?: string | undefined /** 更新日時 */ - updated_at?: string - }[] + updated_at?: string | undefined + }[] | undefined } export type ItemResponse = { @@ -1758,9 +1758,9 @@ export type ItemResponse = { /** 品目名 (30文字以内) */ name: string /** ショートカット１ (20文字以内) */ - shortcut1?: string | null + shortcut1?: string | null | undefined /** ショートカット２ (20文字以内) */ - shortcut2?: string | null + shortcut2?: string | null | undefined } } @@ -1791,7 +1791,7 @@ export type ManualJournalResponse = { /** 取引先名 */ partner_name: string | null /** 取引先コード */ - partner_code?: string | null + partner_code?: string | null | undefined /** 正式名称（255文字以内） */ partner_long_name: string | null /** 品目ID */ @@ -1805,17 +1805,17 @@ export type ManualJournalResponse = { tag_ids: number[] tag_names: string[] /** セグメント１ID */ - segment_1_tag_id?: number + segment_1_tag_id?: number | undefined /** セグメント１ID */ - segment_1_tag_name?: number + segment_1_tag_name?: number | undefined /** セグメント２ID */ - segment_2_tag_id?: number + segment_2_tag_id?: number | undefined /** セグメント２ */ - segment_2_tag_name?: number + segment_2_tag_name?: number | undefined /** セグメント３ID */ - segment_3_tag_id?: number + segment_3_tag_id?: number | undefined /** セグメント３ */ - segment_3_tag_name?: number + segment_3_tag_name?: number | undefined /** 金額（税込で指定してください） */ amount: number /** 消費税額（指定しない場合は自動で計算されます） */ @@ -1832,9 +1832,9 @@ export type TagParams = { /** メモタグ名 (30文字以内) */ name: string /** メモタグ検索用 (20文字以内) */ - shortcut1?: string + shortcut1?: string | undefined /** メモタグ検索用 (20文字以内) */ - shortcut2?: string + shortcut2?: string | undefined } export type TagResponse = { @@ -1846,9 +1846,9 @@ export type TagResponse = { /** 名前(30文字以内) */ name: string | null /** ショートカット1 (255文字以内) */ - shortcut1?: string | null + shortcut1?: string | null | undefined /** ショートカット2 (255文字以内) */ - shortcut2?: string | null + shortcut2?: string | null | undefined } } @@ -1873,7 +1873,7 @@ export type CompanyUpdateResponse = { /** 仕訳番号形式（not_used: 使用しない、digits: 数字（例：5091824）、alnum: 英数字（例：59J0P）） */ txn_number_format: 'not_used' | 'digits' | 'alnum' /** 決済口座のデフォルト */ - default_wallet_account_id?: number + default_wallet_account_id?: number | undefined /** プライベート資金/役員資金（false: 使用しない、true: 使用する） */ private_settlement: boolean /** マイナスの表示方法（0: -、 1: △） */ @@ -1912,9 +1912,9 @@ export type CompanyUpdateResponse = { /** 固定資産の控除法(false: 減価償却累計額でまとめる、true: 独立間接控除方式) */ indirect_write_off_method: boolean /** 期首日 */ - start_date?: string + start_date?: string | undefined /** 期末日 */ - end_date?: string + end_date?: string | undefined /** 月次償却（0: しない、1: する） */ depreciation_record_method: number /** 課税区分（0: 免税、1: 簡易課税、2: 本則課税（個別対応方式）、3: 本則課税（一括比例配分方式）、4: 本則課税（全額控除）） */ @@ -1927,7 +1927,7 @@ export type CompanyUpdateResponse = { tax_account_method: number /** 不動産所得使用区分（0: 一般、1: 一般/不動産） ※個人事業主のみ設定可能 */ return_code: number - }[] + }[] | undefined } } @@ -1967,7 +1967,7 @@ export type CompanyResponse = { /** 仕訳番号形式（not_used: 使用しない、digits: 数字（例：5091824）、alnum: 英数字（例：59J0P）） */ txn_number_format: 'not_used' | 'digits' | 'alnum' /** 決済口座のデフォルト */ - default_wallet_account_id?: number + default_wallet_account_id?: number | undefined /** プライベート資金/役員資金（false: 使用しない、true: 使用する） */ private_settlement: boolean /** マイナスの表示方法（0: -、 1: △） */ @@ -2007,31 +2007,31 @@ export type CompanyResponse = { } export type UnauthorizedError = { - message?: string - messages?: string + message?: string | undefined + messages?: string | undefined } export type ForbiddenError = { - message?: string - messages?: string + message?: string | undefined + messages?: string | undefined } export type BadRequestError = { - status_code?: number + status_code?: number | undefined errors?: { messages: Partial type: 'status' | 'validation' | 'error' - }[] + }[] | undefined } export type BadRequestNotFoundError = { - status_code?: number + status_code?: number | undefined errors?: { messages: Partial type: 'status' | 'validation' | 'error' - }[] + }[] | undefined } export type TooManyRequestsError = { @@ -2041,7 +2041,7 @@ export type TooManyRequestsError = { /** 設定されている上限値 */ limit: number /** 使用回数をカウントする期間 (秒) */ - period?: number + period?: number | undefined /** 上限に達するまでの使用可能回数 */ remaining: number /** （上限値に達した場合）使用回数がリセットされる時刻 */ @@ -2050,12 +2050,12 @@ export type TooManyRequestsError = { } export type InternalServerError = { - status_code?: number + status_code?: number | undefined errors?: { messages: Partial type: 'status' | 'validation' | 'error' - }[] + }[] | undefined } export type ServiceUnavailableError = { @@ -2077,55 +2077,55 @@ export type PartnersResponse = { /** 取引先名 */ name: string /** ショートカット1 (20文字以内) */ - shortcut1?: string | null + shortcut1?: string | null | undefined /** ショートカット2 (20文字以内) */ - shortcut2?: string | null + shortcut2?: string | null | undefined /** 正式名称（255文字以内） */ - long_name?: string | null + long_name?: string | null | undefined /** カナ名称（255文字以内） */ - name_kana?: string | null + name_kana?: string | null | undefined /** 敬称（御中、様、(空白)の3つから選択） */ - default_title?: string | null + default_title?: string | null | undefined /** 電話番号 */ - phone?: string | null + phone?: string | null | undefined /** 担当者 氏名 */ - contact_name?: string | null + contact_name?: string | null | undefined /** 担当者 メールアドレス */ - email?: string | null + email?: string | null | undefined /** 振込元口座ID（一括振込ファイル用）:（未設定の場合は、nullです。） */ - payer_walletable_id?: number | null + payer_walletable_id?: number | null | undefined /** 振込手数料負担（一括振込ファイル用）: (振込元(当方): payer, 振込先(先方): payee) */ - transfer_fee_handling_side?: 'payer' | 'payee' + transfer_fee_handling_side?: 'payer' | 'payee' | undefined /** 郵便番号 */ - 'address_attributes[zipcode]'?: string | null + 'address_attributes[zipcode]'?: string | null | undefined /** 都道府県コード（0:北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄 */ - 'address_attributes[prefecture_code]'?: number + 'address_attributes[prefecture_code]'?: number | undefined /** 市区町村・番地 */ - 'address_attributes[street_name1]'?: string | null + 'address_attributes[street_name1]'?: string | null | undefined /** 建物名・部屋番号など */ - 'address_attributes[street_name2]'?: string | null + 'address_attributes[street_name2]'?: string | null | undefined /** 請求書送付方法(mail:メール、posting:郵送、mail_and_posting:メールと郵送) */ - 'partner_doc_setting_attributes[sending_method]'?: 'mail' | 'posting' | 'main_and_posting' | null + 'partner_doc_setting_attributes[sending_method]'?: 'mail' | 'posting' | 'main_and_posting' | null | undefined /** 銀行名 */ - 'partner_bank_account_attributes[bank_name]'?: string | null + 'partner_bank_account_attributes[bank_name]'?: string | null | undefined /** 銀行名（カナ） */ - 'partner_bank_account_attributes[bank_name_kana]'?: string | null + 'partner_bank_account_attributes[bank_name_kana]'?: string | null | undefined /** 銀行番号 */ - 'partner_bank_account_attributes[bank_code]'?: string | null + 'partner_bank_account_attributes[bank_code]'?: string | null | undefined /** 支店名 */ - 'partner_bank_account_attributes[branch_name]'?: string | null + 'partner_bank_account_attributes[branch_name]'?: string | null | undefined /** 支店名（カナ） */ - 'partner_bank_account_attributes[branch_kana]'?: string | null + 'partner_bank_account_attributes[branch_kana]'?: string | null | undefined /** 受取人名（カナ） */ - 'partner_bank_account_attributes[branch_code]'?: string | null + 'partner_bank_account_attributes[branch_code]'?: string | null | undefined /** 口座種別(ordinary:普通、checking:当座、earmarked:納税準備預金、savings:貯蓄、other:その他) */ - 'partner_bank_account_attributes[account_type]'?: 'ordinary' | 'checking' | 'earmarked' | 'savings' | 'other' | null + 'partner_bank_account_attributes[account_type]'?: 'ordinary' | 'checking' | 'earmarked' | 'savings' | 'other' | null | undefined /** 口座番号 */ - 'partner_bank_account_attributes[account_number]'?: string | null + 'partner_bank_account_attributes[account_number]'?: string | null | undefined /** 受取人名（カナ） */ - 'partner_bank_account_attributes[account_name]'?: string | null + 'partner_bank_account_attributes[account_name]'?: string | null | undefined /** 受取人名 */ - 'partner_bank_account_attributes[long_account_name]'?: string | null + 'partner_bank_account_attributes[long_account_name]'?: string | null | undefined }[] } @@ -2140,67 +2140,67 @@ export type PartnerResponse = { /** 取引先名 */ name: string /** ショートカット1 (20文字以内) */ - shortcut1?: string | null + shortcut1?: string | null | undefined /** ショートカット2 (20文字以内) */ - shortcut2?: string | null + shortcut2?: string | null | undefined /** 正式名称（255文字以内） */ - long_name?: string | null + long_name?: string | null | undefined /** カナ名称（255文字以内） */ - name_kana?: string | null + name_kana?: string | null | undefined /** 敬称（御中、様、(空白)の3つから選択） */ - default_title?: string | null + default_title?: string | null | undefined /** 電話番号 */ - phone?: string | null + phone?: string | null | undefined /** 担当者 氏名 */ - contact_name?: string | null + contact_name?: string | null | undefined /** 担当者 メールアドレス */ - email?: string | null + email?: string | null | undefined /** 振込元口座ID（一括振込ファイル用）:（未設定の場合は、nullです。） */ - payer_walletable_id?: number | null + payer_walletable_id?: number | null | undefined /** 振込手数料負担（一括振込ファイル用）: (振込元(当方): payer, 振込先(先方): payee) */ - transfer_fee_handling_side?: 'payer' | 'payee' + transfer_fee_handling_side?: 'payer' | 'payee' | undefined /** 郵便番号 */ - 'address_attributes[zipcode]'?: string | null + 'address_attributes[zipcode]'?: string | null | undefined /** 都道府県コード（0:北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄 */ - 'address_attributes[prefecture_code]'?: number + 'address_attributes[prefecture_code]'?: number | undefined /** 市区町村・番地 */ - 'address_attributes[street_name1]'?: string | null + 'address_attributes[street_name1]'?: string | null | undefined /** 建物名・部屋番号など */ - 'address_attributes[street_name2]'?: string | null + 'address_attributes[street_name2]'?: string | null | undefined /** 請求書送付方法(email:メール、posting:郵送、email_and_posting:メールと郵送) */ - 'partner_doc_setting_attributes[sending_method]'?: 'email' | 'posting' | 'email_and_posting' | null + 'partner_doc_setting_attributes[sending_method]'?: 'email' | 'posting' | 'email_and_posting' | null | undefined /** 銀行名 */ - 'partner_bank_account_attributes[bank_name]'?: string | null + 'partner_bank_account_attributes[bank_name]'?: string | null | undefined /** 銀行名（カナ） */ - 'partner_bank_account_attributes[bank_name_kana]'?: string | null + 'partner_bank_account_attributes[bank_name_kana]'?: string | null | undefined /** 銀行番号 */ - 'partner_bank_account_attributes[bank_code]'?: string | null + 'partner_bank_account_attributes[bank_code]'?: string | null | undefined /** 支店名 */ - 'partner_bank_account_attributes[branch_name]'?: string | null + 'partner_bank_account_attributes[branch_name]'?: string | null | undefined /** 支店名（カナ） */ - 'partner_bank_account_attributes[branch_kana]'?: string | null + 'partner_bank_account_attributes[branch_kana]'?: string | null | undefined /** 受取人名（カナ） */ - 'partner_bank_account_attributes[branch_code]'?: string | null + 'partner_bank_account_attributes[branch_code]'?: string | null | undefined /** 口座種別(ordinary:普通、checking:当座、earmarked:納税準備預金、savings:貯蓄、other:その他) */ - 'partner_bank_account_attributes[account_type]'?: 'ordinary' | 'checking' | 'earmarked' | 'savings' | 'other' | null + 'partner_bank_account_attributes[account_type]'?: 'ordinary' | 'checking' | 'earmarked' | 'savings' | 'other' | null | undefined /** 口座番号 */ - 'partner_bank_account_attributes[account_number]'?: string | null + 'partner_bank_account_attributes[account_number]'?: string | null | undefined /** 受取人名（カナ） */ - 'partner_bank_account_attributes[account_name]'?: string | null + 'partner_bank_account_attributes[account_name]'?: string | null | undefined /** 受取人名 */ - 'partner_bank_account_attributes[long_account_name]'?: string | null + 'partner_bank_account_attributes[long_account_name]'?: string | null | undefined /** 締め日（29, 30, 31日の末日を指定する場合は、32。） */ - 'payment_term_attributes[cutoff_day]'?: number | null + 'payment_term_attributes[cutoff_day]'?: number | null | undefined /** 支払月 */ - 'payment_term_attributes[additional_months]'?: number | null + 'payment_term_attributes[additional_months]'?: number | null | undefined /** 支払日（29, 30, 31日の末日を指定する場合は、32。） */ - 'payment_term_attributes[fixed_day]'?: number | null + 'payment_term_attributes[fixed_day]'?: number | null | undefined /** 締め日（29, 30, 31日の末日を指定する場合は、32。） */ - 'invoice_payment_term_attributes[cutoff_day]'?: number | null + 'invoice_payment_term_attributes[cutoff_day]'?: number | null | undefined /** 支払月 */ - 'invoice_payment_term_attributes[additional_months]'?: number | null + 'invoice_payment_term_attributes[additional_months]'?: number | null | undefined /** 支払日（29, 30, 31日の末日を指定する場合は、32。） */ - 'invoice_payment_term_attributes[fixed_day]'?: number | null + 'invoice_payment_term_attributes[fixed_day]'?: number | null | undefined } } @@ -2226,14 +2226,14 @@ export type WalletableResponse = { /** 口座区分 (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet) */ type: 'bank_account' | 'credit_card' | 'wallet' /** 同期残高 */ - last_balance?: number + last_balance?: number | undefined /** 登録残高 */ - walletable_balance?: number + walletable_balance?: number | undefined meta?: { /** 集計結果が最新かどうか */ - up_to_date?: boolean - } + up_to_date?: boolean | undefined + } | undefined } } @@ -2300,15 +2300,15 @@ export type TransferResponse = { export type UserParams = { /** 表示名 (20文字以内) */ - display_name?: string + display_name?: string | undefined /** 氏名（名） (20文字以内) */ - first_name?: string + first_name?: string | undefined /** 氏名（姓） (20文字以内) */ - last_name?: string + last_name?: string | undefined /** 氏名（カナ・名） (20文字以内) */ - first_name_kana?: string + first_name_kana?: string | undefined /** 氏名（カナ・姓） (20文字以内) */ - last_name_kana?: string + last_name_kana?: string | undefined } export type UserResponse = { @@ -2318,16 +2318,16 @@ export type UserResponse = { /** メールアドレス */ email: string /** 表示名 */ - display_name?: string | null + display_name?: string | null | undefined /** 氏名（名） */ - first_name?: string | null + first_name?: string | null | undefined /** 氏名（姓） */ - last_name?: string | null + last_name?: string | null | undefined /** 氏名（カナ・名） */ - first_name_kana?: string | null + first_name_kana?: string | null | undefined /** 氏名（カナ・姓） */ - last_name_kana?: string | null - } + last_name_kana?: string | null | undefined + } | undefined } export type MeResponse = { @@ -2337,15 +2337,15 @@ export type MeResponse = { /** メールアドレス */ email: string /** 表示ユーザー名 */ - display_name?: string | null + display_name?: string | null | undefined /** 名 */ - first_name?: string | null + first_name?: string | null | undefined /** 姓 */ - last_name?: string | null + last_name?: string | null | undefined /** 名（カナ） */ - first_name_kana?: string | null + first_name_kana?: string | null | undefined /** 姓（カナ） */ - last_name_kana?: string | null + last_name_kana?: string | null | undefined companies?: { /** 事業所ID */ id: number @@ -2355,19 +2355,19 @@ export type MeResponse = { role: 'admin' | 'simple_accounting' | 'self_only' | 'read_only' /** カスタム権限（true: 使用する、false: 使用しない） */ use_custom_role: boolean - }[] + }[] | undefined } } export type UserCapability = { /** 閲覧 */ - read?: boolean + read?: boolean | undefined /** 作成 */ - create?: boolean + create?: boolean | undefined /** 更新 */ - update?: boolean + update?: boolean | undefined /** 削除 */ - destroy?: boolean + destroy?: boolean | undefined } export type ReceiptResponse = { @@ -2377,11 +2377,11 @@ export type ReceiptResponse = { /** ステータス(unconfirmed:確認待ち、confirmed:確認済み、deleted:削除済み、ignored:無視) */ status: 'unconfirmed' | 'confirmed' | 'deleted' | 'ignored' /** メモ */ - description?: string + description?: string | undefined /** MIMEタイプ */ mime_type: string /** 発生日 */ - issue_date?: string + issue_date?: string | undefined /** アップロード元種別 */ origin: 'unknown' | 'web' | 'mobile_camera' | 'mobile_album' | 'scansnap' | 'scannable' | 'dropbox' | 'mail' | 'safety_contact_file' | 'public_api' /** 作成日時（ISO8601形式） */ @@ -2395,7 +2395,7 @@ export type ReceiptResponse = { /** メールアドレス */ email: string /** 表示名 */ - display_name?: string | null + display_name?: string | null | undefined } } } @@ -2406,9 +2406,9 @@ export type Fiscal_years = { /** 固定資産の控除法(false: 減価償却累計額でまとめる、true: 独立間接控除方式) */ indirect_write_off_method: boolean /** 期首日 */ - start_date?: string + start_date?: string | undefined /** 期末日 */ - end_date?: string + end_date?: string | undefined /** 月次償却（0: しない、1: する） */ depreciation_record_method: number /** 課税区分（0: 免税、1: 簡易課税、2: 本則課税（個別対応方式）、3: 本則課税（一括比例配分方式）、4: 本則課税（全額控除）） */ @@ -2434,31 +2434,31 @@ export type ExpenseApplicationResponse = { /** 申請日 (yyyy-mm-dd) */ issue_date: string | null /** 備考 */ - description?: string + description?: string | undefined /** 会計freeeのWeb画面から申請内容を編集可能：falseの場合、Web上からの項目行の追加／削除・金額の編集が出来なくなります。APIでの編集は可能です。 */ editable_on_web: boolean /** 合計金額 */ - total_amount?: number + total_amount?: number | undefined /** 申請ステータス(draft:下書き, in_progress:申請中, approved:承認済, rejected:却下, feedback:差戻し) */ status: 'draft' | 'in_progress' | 'approved' | 'rejected' | 'feedback' /** 部門ID */ - section_id?: number | null + section_id?: number | null | undefined /** メモタグID */ - tag_ids?: number[] + tag_ids?: number[] | undefined /** 経費申請の項目行一覧（配列） */ expense_application_lines: { /** 経費申請の項目行ID */ id: number /** 日付 (yyyy-mm-dd) */ - transaction_date?: string + transaction_date?: string | undefined /** 内容 */ - description?: string + description?: string | undefined /** 金額 */ - amount?: number + amount?: number | undefined /** 経費科目ID */ - expense_application_line_template_id?: number + expense_application_line_template_id?: number | undefined /** 証憑ID */ - receipt_id?: number + receipt_id?: number | undefined }[] /** 取引ID (申請ステータス:statusがapprovedで、取引が存在する時のみdeal_idが表示されます) */ deal_id: number | null @@ -2474,17 +2474,17 @@ export type ExpenseApplicationLineTemplateResponse = { /** 経費科目名 */ name: string /** 勘定科目ID */ - account_item_id?: number + account_item_id?: number | undefined /** 勘定科目名 */ account_item_name: string /** 税区分コード */ - tax_code?: number + tax_code?: number | undefined /** 税区分名 */ tax_name: string /** 経費科目の説明 */ - description?: string + description?: string | undefined /** 内容の補足 */ - line_description?: string + line_description?: string | undefined } } @@ -2496,17 +2496,17 @@ export type ApprovalRequestParams = { /** 経路申請ID */ approval_flow_route_id: number /** 承認者ID */ - approver_id?: number + approver_id?: number | undefined /** 申請タイトル (255文字以内) */ title: string request_items?: { /** 項目ID */ - id?: number + id?: number | undefined /** 項目タイプ(single_line: 自由記述形式 1行, multi_line: 自由記述形式 複数行, select: プルダウン, date: 日付, amount: 金額, receipt: 添付ファイル) */ - type?: 'single_line' | 'multi_line' | 'select' | 'date' | 'amount' | 'receipt' + type?: 'single_line' | 'multi_line' | 'select' | 'date' | 'amount' | 'receipt' | undefined /** 項目の値 (項目タイプによって入力可能な値が異なります。詳細は注意点をご確認ください） */ - value?: string - }[] + value?: string | undefined + }[] | undefined } export type GeneralApplicationCreateParams = { @@ -2519,18 +2519,18 @@ export type GeneralApplicationCreateParams = { /** 申請フォームID */ form_id: number /** 承認者ID */ - approver_id?: number + approver_id?: number | undefined /** falseの時、in_progress:申請中で作成する。それ以外の時はdraft:下書きで作成する */ draft: boolean /** 親申請ID(既存各種申請IDのみ指定可能です。) */ - parent_id?: number + parent_id?: number | undefined request_items: { /** 項目ID */ - id?: number + id?: number | undefined /** 項目タイプ(title: 申請タイトル, single_line: 自由記述形式 1行, multi_line: 自由記述形式 複数行, select: プルダウン, date: 日付, amount: 金額, receipt: 添付ファイル) */ - type?: 'title' | 'single_line' | 'multi_line' | 'select' | 'date' | 'amount' | 'receipt' + type?: 'title' | 'single_line' | 'multi_line' | 'select' | 'date' | 'amount' | 'receipt' | undefined /** 項目の値 */ - value?: string + value?: string | undefined }[] } @@ -2542,16 +2542,16 @@ export type GeneralApplicationUpdateParams = { /** 申請経路ID */ approval_flow_route_id: number /** 承認者ID */ - approver_id?: number + approver_id?: number | undefined /** falseの時、in_progress:申請中で更新する。それ以外の時はdraft:下書きで更新する */ draft: boolean request_items: { /** 項目ID */ - id?: number + id?: number | undefined /** 項目タイプ(title: 申請タイトル, single_line: 自由記述形式 1行, multi_line: 自由記述形式 複数行, select: プルダウン, date: 日付, amount: 金額, receipt: 添付ファイル) */ - type?: 'title' | 'single_line' | 'multi_line' | 'select' | 'date' | 'amount' | 'receipt' + type?: 'title' | 'single_line' | 'multi_line' | 'select' | 'date' | 'amount' | 'receipt' | undefined /** 項目の値 */ - value?: string + value?: string | undefined }[] } @@ -2561,7 +2561,7 @@ export type GeneralApplicationActionCreateParams = { /** 操作(approve: 承認する、force_approve: 代理承認する、cancel: 申請を取り消す、reject: 却下する、feedback: 申請者へ差し戻す、force_feedback: 承認済み・却下済みを取り消す) */ approval_action: 'approve' | 'force_approve' | 'cancel' | 'reject' | 'feedback' | 'force_feedback' /** 次ステップの承認者ID */ - next_approver_id?: number | null + next_approver_id?: number | null | undefined } export type RenewCreateParams = { @@ -2580,21 +2580,21 @@ export type RenewCreateParams = { /** 取引金額（税込で指定してください） */ amount: number /** 消費税額（指定しない場合は自動で計算されます） */ - vat?: number + vat?: number | undefined /** 品目ID */ - item_id?: number + item_id?: number | undefined /** 部門ID */ - section_id?: number + section_id?: number | undefined /** メモタグID */ - tag_ids?: number[] + tag_ids?: number[] | undefined /** セグメント１ID */ - segment_1_tag_id?: number + segment_1_tag_id?: number | undefined /** セグメント２ID */ - segment_2_tag_id?: number + segment_2_tag_id?: number | undefined /** セグメント３ID */ - segment_3_tag_id?: number + segment_3_tag_id?: number | undefined /** 備考 */ - description?: string + description?: string | undefined }[] } @@ -2612,21 +2612,21 @@ export type RenewUpdateParams = { /** 取引金額（税込で指定してください） */ amount: number /** 消費税額（指定しない場合は自動で計算されます） */ - vat?: number + vat?: number | undefined /** 品目ID */ - item_id?: number + item_id?: number | undefined /** 部門ID */ - section_id?: number + section_id?: number | undefined /** メモタグID */ - tag_ids?: number[] + tag_ids?: number[] | undefined /** セグメント１ID */ - segment_1_tag_id?: number + segment_1_tag_id?: number | undefined /** セグメント２ID */ - segment_2_tag_id?: number + segment_2_tag_id?: number | undefined /** セグメント３ID */ - segment_3_tag_id?: number + segment_3_tag_id?: number | undefined /** 備考 */ - description?: string + description?: string | undefined }[] } @@ -2636,15 +2636,15 @@ export type ExpenseApplicationLineTemplateParams = { /** 経費科目名 (100文字以内) */ name: string /** 勘定科目ID */ - account_items_id?: number + account_items_id?: number | undefined /** 品目ID */ - item_id?: number + item_id?: number | undefined /** 税区分コード（税区分のdisplay_categoryがtax_5: 5%表示の税区分, tax_r8: 軽減税率8%表示の税区分に該当するtax_codeのみ利用可能です。税区分のdisplay_categoryは /taxes/companies/{:company_id}のAPIから取得可能です。） */ tax_code: number /** 経費科目の説明 (1000文字以内) */ - description?: string + description?: string | undefined /** 内容の補足 (1000文字以内) */ - line_description?: string + line_description?: string | undefined } export type ApprovalRequestResponse = { @@ -2788,27 +2788,27 @@ export type GeneralApplicationFormResponse = { /** 項目ID */ id: number /** 順序 */ - order?: number + order?: number | undefined /** 項目種別 (title: 申請タイトル, single_line: 自由記述形式 1行, multi_line: 自由記述形式 複数行, select: プルダウン, date: 日付, amount: 金額, receipt: 添付ファイル) */ - type?: 'title' | 'single_line' | 'multi_line' | 'select' | 'date' | 'amount' | 'receipt' + type?: 'title' | 'single_line' | 'multi_line' | 'select' | 'date' | 'amount' | 'receipt' | undefined /** 項目名 */ - label?: string + label?: string | undefined /** 追加説明 */ - annotation?: string | null + annotation?: string | null | undefined /** 必須かどうか */ - required?: boolean | null + required?: boolean | null | undefined /** 選択項目 */ values?: { /** 選択項目名 */ name: string /** 順序 */ order: number - }[] | null + }[] | null | undefined /** 上限金額 */ - max_amount?: number | null + max_amount?: number | null | undefined /** 下限金額 */ - min_amount?: number | null - }[] + min_amount?: number | null | undefined + }[] | undefined /** 適用された経路数 */ route_setting_count: number } @@ -2819,19 +2819,19 @@ export type ApprovalFlowRouteResponse = { /** 申請経路ID */ id: number /** 申請経路名 */ - name?: string + name?: string | undefined /** 申請経路の説明 */ - description?: string + description?: string | undefined /** 更新したユーザのユーザID */ - user_id?: number | null + user_id?: number | null | undefined /** システム作成の申請経路かどうか */ - definition_system?: boolean + definition_system?: boolean | undefined /** この申請経路を使用中の申請があるかどうか */ - is_in_progress?: boolean + is_in_progress?: boolean | undefined /** 最初の承認ステップのID */ - first_step_id?: number + first_step_id?: number | undefined /** 申請種別 */ - usages?: ('TxnApproval' | 'ExpenseApplication' | 'PaymentRequest' | 'ApprovalRequest' | 'DocApproval')[] + usages?: ('TxnApproval' | 'ExpenseApplication' | 'PaymentRequest' | 'ApprovalRequest' | 'DocApproval')[] | undefined } } @@ -2856,11 +2856,11 @@ export type SegmentTagParams = { /** セグメントタグ名 (30文字以内) */ name: string /** 備考 (30文字以内) */ - description?: string + description?: string | undefined /** ショートカット１ (20文字以内) */ - shortcut1?: string + shortcut1?: string | undefined /** ショートカット２ (20文字以内) */ - shortcut2?: string + shortcut2?: string | undefined } export type InvoiceResponse = { @@ -2874,85 +2874,85 @@ export type InvoiceResponse = { /** 取引先ID */ partner_id: number | null /** 取引先コード */ - partner_code?: string | null + partner_code?: string | null | undefined /** 請求書番号 */ invoice_number: string /** タイトル */ - title?: string | null + title?: string | null | undefined /** 期日 (yyyy-mm-dd) */ - due_date?: string | null + due_date?: string | null | undefined /** 合計金額 */ total_amount: number /** 合計金額 */ - total_vat?: number + total_vat?: number | undefined /** 小計 */ - sub_total?: number + sub_total?: number | undefined /** 売上計上日 */ - booking_date?: string | null + booking_date?: string | null | undefined /** 概要 */ - description?: string | null + description?: string | null | undefined /** 請求書ステータス (draft: 下書き, applying: 申請中, remanded: 差し戻し, rejected: 却下, approved: 承認済み, issued: 発行済み) */ invoice_status: 'draft' | 'applying' | 'remanded' | 'rejected' | 'approved' | 'issued' /** 入金ステータス (unsettled: 入金待ち, settled: 入金済み) */ - payment_status?: '' | 'unsettled' | 'settled' + payment_status?: '' | 'unsettled' | 'settled' | undefined /** 入金日 */ - payment_date?: string | null + payment_date?: string | null | undefined /** Web共有日時(最新) */ - web_published_at?: string | null + web_published_at?: string | null | undefined /** Web共有ダウンロード日時(最新) */ - web_downloaded_at?: string | null + web_downloaded_at?: string | null | undefined /** Web共有取引先確認日時(最新) */ - web_confirmed_at?: string | null + web_confirmed_at?: string | null | undefined /** メール送信日時(最新) */ - mail_sent_at?: string | null + mail_sent_at?: string | null | undefined /** 郵送ステータス(unrequested: リクエスト前, preview_registered: プレビュー登録, preview_failed: プレビュー登録失敗, ordered: 注文中, order_failed: 注文失敗, printing: 印刷中, canceled: キャンセル, posted: 投函済み) */ posting_status: '' | 'unrequested' | 'preview_registered' | 'preview_failed' | 'ordered' | 'order_failed' | 'printing' | 'canceled' | 'posted' /** 取引先名 */ - partner_name?: string | null + partner_name?: string | null | undefined /** 取引先正式名称 */ - partner_long_name?: string | null + partner_long_name?: string | null | undefined /** 敬称（御中、様、(空白)の3つから選択） */ - partner_title?: string | null + partner_title?: string | null | undefined /** 郵便番号 */ - partner_zipcode?: string | null + partner_zipcode?: string | null | undefined /** 都道府県コード（0:北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄 */ - partner_prefecture_code?: number | null + partner_prefecture_code?: number | null | undefined /** 都道府県 */ - partner_prefecture_name?: string | null + partner_prefecture_name?: string | null | undefined /** 市区町村・番地 */ - partner_address1?: string | null + partner_address1?: string | null | undefined /** 建物名・部屋番号など */ - partner_address2?: string | null + partner_address2?: string | null | undefined /** 取引先担当者名 */ - partner_contact_info?: string | null + partner_contact_info?: string | null | undefined /** 事業所名 */ company_name: string /** 郵便番号 */ - company_zipcode?: string | null + company_zipcode?: string | null | undefined /** 都道府県コード（0:北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄 */ - company_prefecture_code?: number | null + company_prefecture_code?: number | null | undefined /** 都道府県 */ - company_prefecture_name?: string | null + company_prefecture_name?: string | null | undefined /** 市区町村・番地 */ - company_address1?: string | null + company_address1?: string | null | undefined /** 建物名・部屋番号など */ - company_address2?: string | null + company_address2?: string | null | undefined /** 事業所担当者名 */ - company_contact_info?: string | null + company_contact_info?: string | null | undefined /** 支払方法 (振込: transfer, 引き落とし: direct_debit) */ payment_type: '' | 'transfer' | 'direct_debit' /** 支払口座 */ - payment_bank_info?: string | null + payment_bank_info?: string | null | undefined /** メッセージ */ - message?: string | null + message?: string | null | undefined /** 備考 */ - notes?: string | null + notes?: string | null | undefined /** レイアウト(default_classic: レイアウト１/クラシック, standard_classic: レイアウト２/クラシック, envelope_classic: 封筒１/クラシック, carried_forward_standard_classic: レイアウト３（繰越金額欄あり）/クラシック, carried_forward_envelope_classic: 封筒２（繰越金額欄あり）/クラシック, default_modern: レイアウト１/モダン, standard_modern: レイアウト２/モダン, envelope_modern: 封筒/モダン) */ invoice_layout: 'default_classic' | 'standard_classic' | 'envelope_classic' | 'carried_forward_standard_classic' | 'carried_forward_envelope_classic' | 'default_modern' | 'standard_modern' | 'envelope_modern' /** 請求書の消費税計算方法(inclusive: 内税, exclusive: 外税) */ tax_entry_method: '' | 'inclusive' | 'exclusive' /** 取引ID (invoice_statusがissuedの時のみIDが表示されます) */ - deal_id?: number | null + deal_id?: number | null | undefined /** 請求内容 */ invoice_contents?: { /** 請求内容ID */ @@ -2992,18 +2992,18 @@ export type InvoiceResponse = { tag_ids: number[] tag_names: string[] /** セグメント１ID */ - segment_1_tag_id?: number | null + segment_1_tag_id?: number | null | undefined /** セグメント１ID */ - segment_1_tag_name?: string | null + segment_1_tag_name?: string | null | undefined /** セグメント２ID */ - segment_2_tag_id?: number | null + segment_2_tag_id?: number | null | undefined /** セグメント２ */ - segment_2_tag_name?: string | null + segment_2_tag_name?: string | null | undefined /** セグメント３ID */ - segment_3_tag_id?: number | null + segment_3_tag_id?: number | null | undefined /** セグメント３ */ - segment_3_tag_name?: string | null - }[] + segment_3_tag_name?: string | null | undefined + }[] | undefined total_amount_per_vat_rate: { /** 税率5%の税込み金額合計 */ @@ -3022,63 +3022,63 @@ export type InvoiceCreateParams = { /** 事業所ID */ company_id: number /** 請求日 (yyyy-mm-dd) */ - issue_date?: string + issue_date?: string | undefined /** 取引先ID */ - partner_id?: number | null + partner_id?: number | null | undefined /** 取引先コード */ - partner_code?: string | null + partner_code?: string | null | undefined /** 請求書番号 (デフォルト: 自動採番されます) */ - invoice_number?: string + invoice_number?: string | undefined /** タイトル (デフォルト: 請求書) */ - title?: string + title?: string | undefined /** 期日 (yyyy-mm-dd) */ - due_date?: string + due_date?: string | undefined /** 売上計上日 */ - booking_date?: string + booking_date?: string | undefined /** 概要 */ - description?: string + description?: string | undefined /** 請求書ステータス (draft: 下書き (デフォルト), issue: 発行(請求先ワークフローを利用している場合は指定できません)) */ - invoice_status?: 'draft' | 'issue' + invoice_status?: 'draft' | 'issue' | undefined /** 請求書に表示する取引先名（未指定の場合は取引先の名称をそのまま利用します） */ - partner_name?: string | null + partner_name?: string | null | undefined /** 敬称（御中、様、(空白)の3つから選択） */ - partner_title?: string | null + partner_title?: string | null | undefined /** 取引先担当者名 */ - partner_contact_info?: string | null + partner_contact_info?: string | null | undefined /** 取引先郵便番号 (デフォルトはpartner_idもしくははpartner_codeで指定された取引先設定情報が補完されます) */ - partner_zipcode?: string | null + partner_zipcode?: string | null | undefined /** 取引先都道府県コード（0:北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄) (デフォルトはpartner_idもしくははpartner_codeで指定された取引先設定情報が補完されます) */ - partner_prefecture_code?: number | null + partner_prefecture_code?: number | null | undefined /** 取引先市区町村・番地 (デフォルトはpartner_idもしくははpartner_codeで指定された取引先設定情報が補完されます) */ - partner_address1?: string | null + partner_address1?: string | null | undefined /** 取引先建物名・部屋番号など (デフォルトはpartner_idもしくははpartner_codeで指定された取引先設定情報が補完されます) */ - partner_address2?: string | null + partner_address2?: string | null | undefined /** 事業所名 (デフォルトは事業所設定情報が補完されます) */ - company_name?: string + company_name?: string | undefined /** 郵便番号 (デフォルトは事業所設定情報が補完されます) */ - company_zipcode?: string + company_zipcode?: string | undefined /** 都道府県コード（0:北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄) (デフォルトは事業所設定情報が補完されます) */ - company_prefecture_code?: number + company_prefecture_code?: number | undefined /** 市区町村・番地 (デフォルトは事業所設定情報が補完されます) */ - company_address1?: string + company_address1?: string | undefined /** 建物名・部屋番号など (デフォルトは事業所設定情報が補完されます) */ - company_address2?: string + company_address2?: string | undefined /** 事業所担当者名 (デフォルトは事業所設定情報が補完されます) */ - company_contact_info?: string + company_contact_info?: string | undefined /** 支払方法 (振込: transfer, 引き落とし: direct_debit) */ - payment_type?: 'transfer' | 'direct_debit' + payment_type?: 'transfer' | 'direct_debit' | undefined /** 支払口座 */ - payment_bank_info?: string + payment_bank_info?: string | undefined /** 振込専用口座の利用(利用しない: not_use(デフォルト), 利用する: use) */ - use_virtual_transfer_account?: 'not_use' | 'use' + use_virtual_transfer_account?: 'not_use' | 'use' | undefined /** メッセージ (デフォルト: 下記の通りご請求申し上げます。) */ - message?: string + message?: string | undefined /** 備考 */ - notes?: string + notes?: string | undefined /** レイアウト(default_classic: レイアウト１/クラシック (デフォルト), standard_classic: レイアウト２/クラシック, envelope_classic: 封筒１/クラシック, carried_forward_standard_classic: レイアウト３（繰越金額欄あり）/クラシック, carried_forward_envelope_classic: 封筒２（繰越金額欄あり）/クラシック, default_modern: レイアウト１/モダン, standard_modern: レイアウト２/モダン, envelope_modern: 封筒/モダン) */ - invoice_layout?: 'default_classic' | 'standard_classic' | 'envelope_classic' | 'carried_forward_standard_classic' | 'carried_forward_envelope_classic' | 'default_modern' | 'standard_modern' | 'envelope_modern' + invoice_layout?: 'default_classic' | 'standard_classic' | 'envelope_classic' | 'carried_forward_standard_classic' | 'carried_forward_envelope_classic' | 'default_modern' | 'standard_modern' | 'envelope_modern' | undefined /** 請求書の消費税計算方法(inclusive: 内税表示, exclusive: 外税表示 (デフォルト)) */ - tax_entry_method?: 'inclusive' | 'exclusive' + tax_entry_method?: 'inclusive' | 'exclusive' | undefined /** 請求内容 */ invoice_contents?: { /** 順序 */ @@ -3086,128 +3086,128 @@ export type InvoiceCreateParams = { /** 行の種類 */ type: 'normal' | 'discount' | 'text' /** 数量 */ - qty?: number + qty?: number | undefined /** 単位 */ - unit?: string + unit?: string | undefined /** 単価 (tax_entry_method: inclusiveの場合は税込価格、tax_entry_method: exclusiveの場合は税抜価格となります) */ - unit_price?: number + unit_price?: number | undefined /** 消費税額 */ - vat?: number | null + vat?: number | null | undefined /** 備考 */ - description?: string + description?: string | undefined /** 勘定科目ID */ - account_item_id?: number + account_item_id?: number | undefined /** 税区分ID */ - tax_code?: number + tax_code?: number | undefined /** 品目ID */ - item_id?: number + item_id?: number | undefined /** 部門ID */ - section_id?: number - tag_ids?: number[] + section_id?: number | undefined + tag_ids?: number[] | undefined /** セグメント１ID */ - segment_1_tag_id?: number + segment_1_tag_id?: number | undefined /** セグメント２ID */ - segment_2_tag_id?: number + segment_2_tag_id?: number | undefined /** セグメント３ID */ - segment_3_tag_id?: number - }[] + segment_3_tag_id?: number | undefined + }[] | undefined } export type InvoiceUpdateParams = { /** 事業所ID */ company_id: number /** 請求日 (yyyy-mm-dd) */ - issue_date?: string + issue_date?: string | undefined /** 取引先ID */ - partner_id?: number | null + partner_id?: number | null | undefined /** 取引先コード */ - partner_code?: string | null + partner_code?: string | null | undefined /** 請求書番号 (デフォルト: 自動採番されます) */ - invoice_number?: string + invoice_number?: string | undefined /** タイトル (デフォルト: 請求書) */ - title?: string + title?: string | undefined /** 期日 (yyyy-mm-dd) */ - due_date?: string + due_date?: string | undefined /** 売上計上日 */ - booking_date?: string + booking_date?: string | undefined /** 概要 */ - description?: string + description?: string | undefined /** 請求書ステータス (draft: 下書き (デフォルト), issue: 発行(請求先ワークフローを利用している場合は承認済の請求書にのみ指定できます)) */ - invoice_status?: 'draft' | 'issue' + invoice_status?: 'draft' | 'issue' | undefined /** 請求書に表示する取引先名（未指定の場合は取引先の名称をそのまま利用します） */ - partner_name?: string | null + partner_name?: string | null | undefined /** 敬称（御中、様、(空白)の3つから選択） */ - partner_title?: string | null + partner_title?: string | null | undefined /** 取引先担当者名 */ - partner_contact_info?: string | null + partner_contact_info?: string | null | undefined /** 取引先郵便番号 (デフォルトはpartner_idもしくははpartner_codeで指定された取引先設定情報が補完されます) */ - partner_zipcode?: string | null + partner_zipcode?: string | null | undefined /** 取引先都道府県コード（0:北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄) (デフォルトはpartner_idもしくははpartner_codeで指定された取引先設定情報が補完されます) */ - partner_prefecture_code?: number | null + partner_prefecture_code?: number | null | undefined /** 取引先市区町村・番地 (デフォルトはpartner_idもしくははpartner_codeで指定された取引先設定情報が補完されます) */ - partner_address1?: string | null + partner_address1?: string | null | undefined /** 取引先建物名・部屋番号など (デフォルトはpartner_idもしくははpartner_codeで指定された取引先設定情報が補完されます) */ - partner_address2?: string | null + partner_address2?: string | null | undefined /** 事業所名 (デフォルトは事業所設定情報が補完されます) */ - company_name?: string + company_name?: string | undefined /** 郵便番号 (デフォルトは事業所設定情報が補完されます) */ - company_zipcode?: string + company_zipcode?: string | undefined /** 都道府県コード（0:北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄) (デフォルトは事業所設定情報が補完されます) */ - company_prefecture_code?: number + company_prefecture_code?: number | undefined /** 市区町村・番地 (デフォルトは事業所設定情報が補完されます) */ - company_address1?: string + company_address1?: string | undefined /** 建物名・部屋番号など (デフォルトは事業所設定情報が補完されます) */ - company_address2?: string + company_address2?: string | undefined /** 事業所担当者名 (デフォルトは事業所設定情報が補完されます) */ - company_contact_info?: string + company_contact_info?: string | undefined /** 支払方法 (振込: transfer, 引き落とし: direct_debit) */ - payment_type?: 'transfer' | 'direct_debit' + payment_type?: 'transfer' | 'direct_debit' | undefined /** 支払口座 */ - payment_bank_info?: string + payment_bank_info?: string | undefined /** 振込専用口座の利用(利用しない: not_use(デフォルト), 利用する: use) */ - use_virtual_transfer_account?: 'not_use' | 'use' + use_virtual_transfer_account?: 'not_use' | 'use' | undefined /** メッセージ (デフォルト: 下記の通りご請求申し上げます。) */ - message?: string + message?: string | undefined /** 備考 */ - notes?: string + notes?: string | undefined /** レイアウト(default_classic: レイアウト１/クラシック (デフォルト), standard_classic: レイアウト２/クラシック, envelope_classic: 封筒１/クラシック, carried_forward_standard_classic: レイアウト３（繰越金額欄あり）/クラシック, carried_forward_envelope_classic: 封筒２（繰越金額欄あり）/クラシック, default_modern: レイアウト１/モダン, standard_modern: レイアウト２/モダン, envelope_modern: 封筒/モダン) */ - invoice_layout?: 'default_classic' | 'standard_classic' | 'envelope_classic' | 'carried_forward_standard_classic' | 'carried_forward_envelope_classic' | 'default_modern' | 'standard_modern' | 'envelope_modern' + invoice_layout?: 'default_classic' | 'standard_classic' | 'envelope_classic' | 'carried_forward_standard_classic' | 'carried_forward_envelope_classic' | 'default_modern' | 'standard_modern' | 'envelope_modern' | undefined /** 請求書の消費税計算方法(inclusive: 内税表示, exclusive: 外税表示 (デフォルト)) */ - tax_entry_method?: 'inclusive' | 'exclusive' + tax_entry_method?: 'inclusive' | 'exclusive' | undefined /** 請求内容 */ invoice_contents?: { /** 請求内容ID */ - id?: number + id?: number | undefined /** 順序 */ order: number /** 行の種類 */ type: 'normal' | 'discount' | 'text' /** 数量 */ - qty?: number + qty?: number | undefined /** 単位 */ - unit?: string + unit?: string | undefined /** 単価 (tax_entry_method: inclusiveの場合は税込価格、tax_entry_method: exclusiveの場合は税抜価格となります) */ - unit_price?: number + unit_price?: number | undefined /** 消費税額 */ - vat?: number | null + vat?: number | null | undefined /** 備考 */ - description?: string + description?: string | undefined /** 勘定科目ID */ - account_item_id?: number + account_item_id?: number | undefined /** 税区分ID */ - tax_code?: number + tax_code?: number | undefined /** 品目ID */ - item_id?: number + item_id?: number | undefined /** 部門ID */ - section_id?: number - tag_ids?: number[] + section_id?: number | undefined + tag_ids?: number[] | undefined /** セグメント１ID */ - segment_1_tag_id?: number + segment_1_tag_id?: number | undefined /** セグメント２ID */ - segment_2_tag_id?: number + segment_2_tag_id?: number | undefined /** セグメント３ID */ - segment_3_tag_id?: number - }[] + segment_3_tag_id?: number | undefined + }[] | undefined } export type QuotationResponse = { @@ -3221,65 +3221,65 @@ export type QuotationResponse = { /** 取引先ID */ partner_id: number | null /** 取引先コード */ - partner_code?: string | null + partner_code?: string | null | undefined /** 見積書番号 */ quotation_number: string /** タイトル */ - title?: string | null + title?: string | null | undefined /** 合計金額 */ total_amount: number /** 消費税 */ - total_vat?: number + total_vat?: number | undefined /** 小計 */ - sub_total?: number + sub_total?: number | undefined /** 概要 */ - description?: string | null + description?: string | null | undefined /** 見積書ステータス (unsubmitted: 送付待ち, submitted: 送付済み, all: 全て) */ quotation_status: 'unsubmitted' | 'submitted' | 'all' /** Web共有日時(最新) */ - web_published_at?: string | null + web_published_at?: string | null | undefined /** Web共有ダウンロード日時(最新) */ - web_downloaded_at?: string | null + web_downloaded_at?: string | null | undefined /** Web共有取引先確認日時(最新) */ - web_confirmed_at?: string | null + web_confirmed_at?: string | null | undefined /** メール送信日時(最新) */ - mail_sent_at?: string | null + mail_sent_at?: string | null | undefined /** 取引先名 */ - partner_name?: string | null + partner_name?: string | null | undefined /** 取引先正式名称 */ - partner_display_name?: string | null + partner_display_name?: string | null | undefined /** 敬称（御中、様、(空白)の3つから選択） */ partner_title: '御中' | '様' | '(空白)' | null /** 郵便番号 */ - partner_zipcode?: string | null + partner_zipcode?: string | null | undefined /** 都道府県コード（0:北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄 */ - partner_prefecture_code?: number | null + partner_prefecture_code?: number | null | undefined /** 都道府県 */ - partner_prefecture_name?: string | null + partner_prefecture_name?: string | null | undefined /** 市区町村・番地 */ - partner_address1?: string | null + partner_address1?: string | null | undefined /** 建物名・部屋番号など */ - partner_address2?: string | null + partner_address2?: string | null | undefined /** 取引先担当者名 */ - partner_contact_info?: string | null + partner_contact_info?: string | null | undefined /** 事業所名 */ company_name: string /** 郵便番号 */ - company_zipcode?: string | null + company_zipcode?: string | null | undefined /** 都道府県コード（0:北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄 */ - company_prefecture_code?: number | null + company_prefecture_code?: number | null | undefined /** 都道府県 */ - company_prefecture_name?: string | null + company_prefecture_name?: string | null | undefined /** 市区町村・番地 */ - company_address1?: string | null + company_address1?: string | null | undefined /** 建物名・部屋番号など */ - company_address2?: string | null + company_address2?: string | null | undefined /** 事業所担当者名 */ - company_contact_info?: string | null + company_contact_info?: string | null | undefined /** メッセージ */ - message?: string | null + message?: string | null | undefined /** 備考 */ - notes?: string | null + notes?: string | null | undefined /** レイアウト(default_classic: レイアウト１/クラシック, standard_classic: レイアウト２/クラシック, envelope_classic: 封筒１/クラシック, carried_forward_standard_classic: レイアウト３（繰越金額欄あり）/クラシック, carried_forward_envelope_classic: 封筒２（繰越金額欄あり）/クラシック, default_modern: レイアウト１/モダン, standard_modern: レイアウト２/モダン, envelope_modern: 封筒/モダン) */ quotation_layout: 'default_classic' | 'standard_classic' | 'envelope_classic' | 'carried_forward_standard_classic' | 'carried_forward_envelope_classic' | 'default_modern' | 'standard_modern' | 'envelope_modern' /** 見積書の消費税計算方法(inclusive: 内税, exclusive: 外税) */ @@ -3323,18 +3323,18 @@ export type QuotationResponse = { tag_ids: number[] tag_names: string[] /** セグメント１ID */ - segment_1_tag_id?: number | null + segment_1_tag_id?: number | null | undefined /** セグメント１ID */ - segment_1_tag_name?: string | null + segment_1_tag_name?: string | null | undefined /** セグメント２ID */ - segment_2_tag_id?: number | null + segment_2_tag_id?: number | null | undefined /** セグメント２ */ - segment_2_tag_name?: string | null + segment_2_tag_name?: string | null | undefined /** セグメント３ID */ - segment_3_tag_id?: number | null + segment_3_tag_id?: number | null | undefined /** セグメント３ */ - segment_3_tag_name?: string | null - }[] + segment_3_tag_name?: string | null | undefined + }[] | undefined total_amount_per_vat_rate: { /** 税率5%の税込み金額合計 */ @@ -3353,53 +3353,53 @@ export type QuotationCreateParams = { /** 事業所ID */ company_id: number /** 見積日 (yyyy-mm-dd) */ - issue_date?: string + issue_date?: string | undefined /** 取引先ID */ - partner_id?: number | null + partner_id?: number | null | undefined /** 取引先コード */ - partner_code?: string | null + partner_code?: string | null | undefined /** 見積書番号 (デフォルト: 自動採番されます) */ - quotation_number?: string + quotation_number?: string | undefined /** タイトル (デフォルト: 見積書) */ - title?: string + title?: string | undefined /** 概要 */ - description?: string + description?: string | undefined /** 見積書ステータス (unsubmitted: 送付待ち, submitted: 送付済み) */ - quotation_status?: 'unsubmitted' | 'submitted' + quotation_status?: 'unsubmitted' | 'submitted' | undefined /** 見積書に表示する取引先名 */ partner_display_name: string /** 敬称（御中、様、(空白)の3つから選択） */ partner_title: string /** 取引先担当者名 */ - partner_contact_info?: string | null + partner_contact_info?: string | null | undefined /** 取引先郵便番号 (デフォルトはpartner_idもしくははpartner_codeで指定された取引先設定情報が補完されます) */ - partner_zipcode?: string | null + partner_zipcode?: string | null | undefined /** 取引先都道府県コード（0:北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄) (デフォルトはpartner_idもしくはpartner_codeで指定された取引先設定情報が補完されます) */ - partner_prefecture_code?: number | null + partner_prefecture_code?: number | null | undefined /** 取引先市区町村・番地 (デフォルトはpartner_idもしくははpartner_codeで指定された取引先設定情報が補完されます) */ - partner_address1?: string | null + partner_address1?: string | null | undefined /** 取引先建物名・部屋番号など (デフォルトはpartner_idもしくははpartner_codeで指定された取引先設定情報が補完されます) */ - partner_address2?: string | null + partner_address2?: string | null | undefined /** 事業所名 (デフォルトは事業所設定情報が補完されます) */ - company_name?: string + company_name?: string | undefined /** 郵便番号 (デフォルトは事業所設定情報が補完されます) */ - company_zipcode?: string + company_zipcode?: string | undefined /** 都道府県コード（0:北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄) (デフォルトは事業所設定情報が補完されます) */ - company_prefecture_code?: number + company_prefecture_code?: number | undefined /** 市区町村・番地 (デフォルトは事業所設定情報が補完されます) */ - company_address1?: string + company_address1?: string | undefined /** 建物名・部屋番号など (デフォルトは事業所設定情報が補完されます) */ - company_address2?: string + company_address2?: string | undefined /** 事業所担当者名 (デフォルトは事業所設定情報が補完されます) */ - company_contact_info?: string + company_contact_info?: string | undefined /** メッセージ (デフォルト: 下記の通り御見積申し上げます。) */ - message?: string + message?: string | undefined /** 備考 */ - notes?: string + notes?: string | undefined /** レイアウト(default_classic: レイアウト１/クラシック (デフォルト), standard_classic: レイアウト２/クラシック, envelope_classic: 封筒１/クラシック, default_modern: レイアウト１/モダン, standard_modern: レイアウト２/モダン, envelope_modern: 封筒/モダン) */ - quotation_layout?: 'default_classic' | 'standard_classic' | 'envelope_classic' | 'default_modern' | 'standard_modern' | 'envelope_modern' + quotation_layout?: 'default_classic' | 'standard_classic' | 'envelope_classic' | 'default_modern' | 'standard_modern' | 'envelope_modern' | undefined /** 見積書の消費税計算方法(inclusive: 内税表示, exclusive: 外税表示 (デフォルト)) */ - tax_entry_method?: 'inclusive' | 'exclusive' + tax_entry_method?: 'inclusive' | 'exclusive' | undefined /** 見積内容 */ quotation_contents?: { /** 順序 */ @@ -3407,118 +3407,118 @@ export type QuotationCreateParams = { /** 行の種類 */ type: 'normal' | 'discount' | 'text' /** 数量 */ - qty?: number + qty?: number | undefined /** 単位 */ - unit?: string + unit?: string | undefined /** 単価 (tax_entry_method: inclusiveの場合は税込価格、tax_entry_method: exclusiveの場合は税抜価格となります) */ - unit_price?: number + unit_price?: number | undefined /** 消費税額 */ - vat?: number | null + vat?: number | null | undefined /** 備考 */ - description?: string + description?: string | undefined /** 勘定科目ID */ - account_item_id?: number + account_item_id?: number | undefined /** 税区分ID */ - tax_code?: number + tax_code?: number | undefined /** 品目ID */ - item_id?: number + item_id?: number | undefined /** 部門ID */ - section_id?: number - tag_ids?: number[] + section_id?: number | undefined + tag_ids?: number[] | undefined /** セグメント１ID */ - segment_1_tag_id?: number + segment_1_tag_id?: number | undefined /** セグメント２ID */ - segment_2_tag_id?: number + segment_2_tag_id?: number | undefined /** セグメント３ID */ - segment_3_tag_id?: number - }[] + segment_3_tag_id?: number | undefined + }[] | undefined } export type QuotationUpdateParams = { /** 事業所ID */ company_id: number /** 見積日 (yyyy-mm-dd) */ - issue_date?: string + issue_date?: string | undefined /** 取引先ID */ - partner_id?: number | null + partner_id?: number | null | undefined /** 取引先コード */ - partner_code?: string | null + partner_code?: string | null | undefined /** 見積書番号 (デフォルト: 自動採番されます) */ - quotation_number?: string + quotation_number?: string | undefined /** タイトル (デフォルト: 見積書) */ - title?: string + title?: string | undefined /** 概要 */ - description?: string + description?: string | undefined /** 見積書ステータス (unsubmitted: 送付待ち, submitted: 送付済み) */ - quotation_status?: 'unsubmitted' | 'submitted' + quotation_status?: 'unsubmitted' | 'submitted' | undefined /** 見積書に表示する取引先名 */ partner_display_name: string /** 敬称（御中、様、(空白)の3つから選択） */ partner_title: string /** 取引先担当者名 */ - partner_contact_info?: string | null + partner_contact_info?: string | null | undefined /** 取引先郵便番号 (デフォルトはpartner_idもしくははpartner_codeで指定された取引先設定情報が補完されます) */ - partner_zipcode?: string | null + partner_zipcode?: string | null | undefined /** 取引先都道府県コード（0:北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄) (デフォルトはpartner_idもしくはpartner_codeで指定された取引先設定情報が補完されます) */ - partner_prefecture_code?: number | null + partner_prefecture_code?: number | null | undefined /** 取引先市区町村・番地 (デフォルトはpartner_idもしくははpartner_codeで指定された取引先設定情報が補完されます) */ - partner_address1?: string | null + partner_address1?: string | null | undefined /** 取引先建物名・部屋番号など (デフォルトはpartner_idもしくははpartner_codeで指定された取引先設定情報が補完されます) */ - partner_address2?: string | null + partner_address2?: string | null | undefined /** 事業所名 (デフォルトは事業所設定情報が補完されます) */ - company_name?: string + company_name?: string | undefined /** 郵便番号 (デフォルトは事業所設定情報が補完されます) */ - company_zipcode?: string + company_zipcode?: string | undefined /** 都道府県コード（0:北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄) (デフォルトは事業所設定情報が補完されます) */ - company_prefecture_code?: number + company_prefecture_code?: number | undefined /** 市区町村・番地 (デフォルトは事業所設定情報が補完されます) */ - company_address1?: string + company_address1?: string | undefined /** 建物名・部屋番号など (デフォルトは事業所設定情報が補完されます) */ - company_address2?: string + company_address2?: string | undefined /** 事業所担当者名 (デフォルトは事業所設定情報が補完されます) */ - company_contact_info?: string + company_contact_info?: string | undefined /** メッセージ (デフォルト: 下記の通り御見積申し上げます。) */ - message?: string + message?: string | undefined /** 備考 */ - notes?: string + notes?: string | undefined /** レイアウト(default_classic: レイアウト１/クラシック (デフォルト), standard_classic: レイアウト２/クラシック, envelope_classic: 封筒１/クラシック, default_modern: レイアウト１/モダン, standard_modern: レイアウト２/モダン, envelope_modern: 封筒/モダン) */ - quotation_layout?: 'default_classic' | 'standard_classic' | 'envelope_classic' | 'default_modern' | 'standard_modern' | 'envelope_modern' + quotation_layout?: 'default_classic' | 'standard_classic' | 'envelope_classic' | 'default_modern' | 'standard_modern' | 'envelope_modern' | undefined /** 見積書の消費税計算方法(inclusive: 内税表示, exclusive: 外税表示 (デフォルト)) */ - tax_entry_method?: 'inclusive' | 'exclusive' + tax_entry_method?: 'inclusive' | 'exclusive' | undefined /** 見積内容 */ quotation_contents?: { /** 見積内容ID */ - id?: number + id?: number | undefined /** 順序 */ order: number /** 行の種類 */ type: 'normal' | 'discount' | 'text' /** 数量 */ - qty?: number + qty?: number | undefined /** 単位 */ - unit?: string + unit?: string | undefined /** 単価 (tax_entry_method: inclusiveの場合は税込価格、tax_entry_method: exclusiveの場合は税抜価格となります) */ - unit_price?: number + unit_price?: number | undefined /** 消費税額 */ - vat?: number | null + vat?: number | null | undefined /** 備考 */ - description?: string + description?: string | undefined /** 勘定科目ID */ - account_item_id?: number + account_item_id?: number | undefined /** 税区分ID */ - tax_code?: number + tax_code?: number | undefined /** 品目ID */ - item_id?: number + item_id?: number | undefined /** 部門ID */ - section_id?: number - tag_ids?: number[] + section_id?: number | undefined + tag_ids?: number[] | undefined /** セグメント１ID */ - segment_1_tag_id?: number + segment_1_tag_id?: number | undefined /** セグメント２ID */ - segment_2_tag_id?: number + segment_2_tag_id?: number | undefined /** セグメント３ID */ - segment_3_tag_id?: number - }[] + segment_3_tag_id?: number | undefined + }[] | undefined } export type CompaniesPlanResponse = { diff --git a/samples/freee/api/1/account_items/index.ts b/samples/freee/api/1/account_items/index.ts index 9d5ab241..75007eab 100644 --- a/samples/freee/api/1/account_items/index.ts +++ b/samples/freee/api/1/account_items/index.ts @@ -20,7 +20,7 @@ export type Methods = { /** 事業所ID */ company_id: number /** 基準日:指定した場合、勘定科目に紐づく税区分(default_tax_code)が、基準日の税率に基づいて返ります。 */ - base_date?: string + base_date?: string | undefined } status: 200 diff --git a/samples/freee/api/1/banks/index.ts b/samples/freee/api/1/banks/index.ts index 5356d8aa..cd2515bb 100644 --- a/samples/freee/api/1/banks/index.ts +++ b/samples/freee/api/1/banks/index.ts @@ -24,12 +24,12 @@ export type Methods = { get: { query?: { /** 取得レコードのオフセット (デフォルト: 0) */ - offset?: number + offset?: number | undefined /** 取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 500) */ - limit?: number + limit?: number | undefined /** サービス種別 */ - type?: 'bank' | 'credit_card' | 'wallet' - } + type?: 'bank' | 'credit_card' | 'wallet' | undefined + } | undefined status: 200 diff --git a/samples/freee/api/1/companies/_id@number/index.ts b/samples/freee/api/1/companies/_id@number/index.ts index b710aa91..c144010d 100644 --- a/samples/freee/api/1/companies/_id@number/index.ts +++ b/samples/freee/api/1/companies/_id@number/index.ts @@ -28,22 +28,22 @@ export type Methods = { get: { query?: { /** 取得情報に勘定科目・税区分コード・税区分・品目・取引先・部門・メモタグ・口座の一覧を含める */ - details?: true + details?: true | undefined /** 取得情報に勘定科目一覧を含める */ - account_items?: true + account_items?: true | undefined /** 取得情報に税区分コード・税区分一覧を含める */ - taxes?: true + taxes?: true | undefined /** 取得情報に品目一覧を含める */ - items?: true + items?: true | undefined /** 取得情報に取引先一覧を含める */ - partners?: true + partners?: true | undefined /** 取得情報に部門一覧を含める */ - sections?: true + sections?: true | undefined /** 取得情報にメモタグ一覧を含める */ - tags?: true + tags?: true | undefined /** 取得情報に口座一覧を含める */ - walletables?: true - } + walletables?: true | undefined + } | undefined status: 200 resBody: Types.CompanyResponse @@ -60,6 +60,6 @@ export type Methods = { status: 200 resBody: Types.CompanyUpdateResponse reqFormat: URLSearchParams - reqBody?: Types.CompanyParams + reqBody?: Types.CompanyParams | undefined } } diff --git a/samples/freee/api/1/deals/_id@number/index.ts b/samples/freee/api/1/deals/_id@number/index.ts index 00bf344f..e512c1e2 100644 --- a/samples/freee/api/1/deals/_id@number/index.ts +++ b/samples/freee/api/1/deals/_id@number/index.ts @@ -66,7 +66,7 @@ export type Methods = { /** 事業所ID */ company_id: number /** 取引の債権債務行の表示（without: 表示しない(デフォルト), with: 表示する） */ - accruals?: 'without' | 'with' + accruals?: 'without' | 'with' | undefined } status: 200 @@ -133,7 +133,7 @@ export type Methods = { resBody: Types.DealResponse reqFormat: URLSearchParams /** 取引（収入／支出）の更新 */ - reqBody?: Types.DealUpdateParams + reqBody?: Types.DealUpdateParams | undefined } delete: { diff --git a/samples/freee/api/1/deals/index.ts b/samples/freee/api/1/deals/index.ts index 259d275b..f8cbb0f9 100644 --- a/samples/freee/api/1/deals/index.ts +++ b/samples/freee/api/1/deals/index.ts @@ -67,35 +67,35 @@ export type Methods = { /** 事業所ID */ company_id: number /** 取引先IDで絞込 */ - partner_id?: number + partner_id?: number | undefined /** 勘定科目IDで絞込 */ - account_item_id?: number + account_item_id?: number | undefined /** 取引先コードで絞込 */ - partner_code?: string + partner_code?: string | undefined /** 決済状況で絞込 (未決済: unsettled, 完了: settled) */ - status?: 'unsettled' | 'settled' + status?: 'unsettled' | 'settled' | undefined /** 収支区分 (収入: income, 支出: expense) */ - type?: 'income' | 'expense' + type?: 'income' | 'expense' | undefined /** 発生日で絞込：開始日(yyyy-mm-dd) */ - start_issue_date?: string + start_issue_date?: string | undefined /** 発生日で絞込：終了日(yyyy-mm-dd) */ - end_issue_date?: string + end_issue_date?: string | undefined /** 支払期日で絞込：開始日(yyyy-mm-dd) */ - start_due_date?: string + start_due_date?: string | undefined /** 支払期日で絞込：終了日(yyyy-mm-dd) */ - end_due_date?: string + end_due_date?: string | undefined /** +更新日で絞込：開始日(yyyy-mm-dd) */ - start_renew_date?: string + start_renew_date?: string | undefined /** +更新日で絞込：終了日(yyyy-mm-dd) */ - end_renew_date?: string + end_renew_date?: string | undefined /** 取得レコードのオフセット (デフォルト: 0) */ - offset?: number + offset?: number | undefined /** 取得レコードの件数 (デフォルト: 20, 最大: 100) */ - limit?: number + limit?: number | undefined /** 取引登録元アプリで絞込（me: 本APIを叩くアプリ自身から登録した取引のみ） */ - registered_from?: 'me' + registered_from?: 'me' | undefined /** 取引の債権債務行の表示（without: 表示しない(デフォルト), with: 表示する） */ - accruals?: 'without' | 'with' + accruals?: 'without' | 'with' | undefined } status: 200 @@ -175,6 +175,6 @@ export type Methods = { resBody: Types.DealCreateResponse reqFormat: URLSearchParams /** 取引（収入／支出）の作成 */ - reqBody?: Types.DealCreateParams + reqBody?: Types.DealCreateParams | undefined } } diff --git a/samples/freee/api/1/expense_application_line_templates/index.ts b/samples/freee/api/1/expense_application_line_templates/index.ts index 80774a6a..4f24c98e 100644 --- a/samples/freee/api/1/expense_application_line_templates/index.ts +++ b/samples/freee/api/1/expense_application_line_templates/index.ts @@ -12,9 +12,9 @@ export type Methods = { /** 事業所ID */ company_id: number /** 取得レコードのオフセット (デフォルト: 0) */ - offset?: number + offset?: number | undefined /** 取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 100) */ - limit?: number + limit?: number | undefined } status: 200 diff --git a/samples/freee/api/1/expense_applications/_id@number/index.ts b/samples/freee/api/1/expense_applications/_id@number/index.ts index a98ae924..0e7c13c1 100644 --- a/samples/freee/api/1/expense_applications/_id@number/index.ts +++ b/samples/freee/api/1/expense_applications/_id@number/index.ts @@ -31,7 +31,7 @@ export type Methods = { resBody: Types.ExpenseApplicationResponse reqFormat: URLSearchParams /** 経費申請の更新 */ - reqBody?: Types.ExpenseApplicationUpdateParams + reqBody?: Types.ExpenseApplicationUpdateParams | undefined } /** diff --git a/samples/freee/api/1/expense_applications/index.ts b/samples/freee/api/1/expense_applications/index.ts index 68112dcb..41d0ddea 100644 --- a/samples/freee/api/1/expense_applications/index.ts +++ b/samples/freee/api/1/expense_applications/index.ts @@ -7,9 +7,9 @@ export type Methods = { /** 事業所ID */ company_id: number /** 取得レコードのオフセット (デフォルト: 0) */ - offset?: number + offset?: number | undefined /** 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 500) */ - limit?: number + limit?: number | undefined } status: 200 @@ -38,6 +38,6 @@ export type Methods = { resBody: Types.ExpenseApplicationResponse reqFormat: URLSearchParams /** 経費申請の作成 */ - reqBody?: Types.ExpenseApplicationCreateParams + reqBody?: Types.ExpenseApplicationCreateParams | undefined } } diff --git a/samples/freee/api/1/forms/selectables/index.ts b/samples/freee/api/1/forms/selectables/index.ts index 4a15d6ef..013ce45b 100644 --- a/samples/freee/api/1/forms/selectables/index.ts +++ b/samples/freee/api/1/forms/selectables/index.ts @@ -12,7 +12,7 @@ export type Methods = { /** 事業所ID */ company_id: number /** 取得する項目(項目: account_item) */ - includes?: 'account_item' + includes?: 'account_item' | undefined } status: 200 diff --git a/samples/freee/api/1/invoices/_id@number/index.ts b/samples/freee/api/1/invoices/_id@number/index.ts index a771e56c..9449fb16 100644 --- a/samples/freee/api/1/invoices/_id@number/index.ts +++ b/samples/freee/api/1/invoices/_id@number/index.ts @@ -37,7 +37,7 @@ export type Methods = { resBody: Types.InvoiceResponse reqFormat: URLSearchParams /** 請求書の更新 */ - reqBody?: Types.InvoiceUpdateParams + reqBody?: Types.InvoiceUpdateParams | undefined } /** diff --git a/samples/freee/api/1/invoices/index.ts b/samples/freee/api/1/invoices/index.ts index fdb8f642..1414933a 100644 --- a/samples/freee/api/1/invoices/index.ts +++ b/samples/freee/api/1/invoices/index.ts @@ -12,29 +12,29 @@ export type Methods = { /** 事業所ID */ company_id: number /** 取引先IDで絞込 */ - partner_id?: number + partner_id?: number | undefined /** 取引先コードで絞込 */ - partner_code?: string + partner_code?: string | undefined /** 請求日の開始日(yyyy-mm-dd) */ - issue_date_start?: string + issue_date_start?: string | undefined /** 請求日の終了日(yyyy-mm-dd) */ - issue_date_end?: string + issue_date_end?: string | undefined /** 期日の開始日(yyyy-mm-dd) */ - due_date_start?: string + due_date_start?: string | undefined /** 期日の終了日(yyyy-mm-dd) */ - due_date_end?: string + due_date_end?: string | undefined /** 請求書番号 */ - invoice_number?: string + invoice_number?: string | undefined /** 概要 */ - description?: string + description?: string | undefined /** 請求書ステータス (draft: 下書き, applying: 申請中, remanded: 差し戻し, rejected: 却下, approved: 承認済み, issued: 発行済み, unsubmitted: 送付待ち) */ - invoice_status?: 'draft' | 'applying' | 'remanded' | 'rejected' | 'approved' | 'issued' | 'unsubmitted' + invoice_status?: 'draft' | 'applying' | 'remanded' | 'rejected' | 'approved' | 'issued' | 'unsubmitted' | undefined /** 入金ステータス (unsettled: 入金待ち, settled: 入金済み) */ - payment_status?: 'unsettled' | 'settled' + payment_status?: 'unsettled' | 'settled' | undefined /** 取得レコードのオフセット (デフォルト: 0) */ - offset?: number + offset?: number | undefined /** 取得レコードの件数 (デフォルト: 20, 最大: 100) */ - limit?: number + limit?: number | undefined } status: 200 @@ -61,6 +61,6 @@ export type Methods = { resBody: Types.InvoiceResponse reqFormat: URLSearchParams /** 請求書の作成 */ - reqBody?: Types.InvoiceCreateParams + reqBody?: Types.InvoiceCreateParams | undefined } } diff --git a/samples/freee/api/1/items/_id@number/index.ts b/samples/freee/api/1/items/_id@number/index.ts index 098f5bbf..102f4d60 100644 --- a/samples/freee/api/1/items/_id@number/index.ts +++ b/samples/freee/api/1/items/_id@number/index.ts @@ -27,7 +27,7 @@ export type Methods = { resBody: Types.ItemResponse reqFormat: URLSearchParams /** 品目の更新 */ - reqBody?: Types.ItemParams + reqBody?: Types.ItemParams | undefined } /** diff --git a/samples/freee/api/1/items/index.ts b/samples/freee/api/1/items/index.ts index 9810effb..215107af 100644 --- a/samples/freee/api/1/items/index.ts +++ b/samples/freee/api/1/items/index.ts @@ -30,6 +30,6 @@ export type Methods = { resBody: Types.ItemResponse reqFormat: URLSearchParams /** 品目の作成 */ - reqBody?: Types.ItemParams + reqBody?: Types.ItemParams | undefined } } diff --git a/samples/freee/api/1/journals/index.ts b/samples/freee/api/1/journals/index.ts index 2c870937..998cb630 100644 --- a/samples/freee/api/1/journals/index.ts +++ b/samples/freee/api/1/journals/index.ts @@ -50,11 +50,11 @@ export type Methods = { /** 事業所ID */ company_id: number /** 補助科目やコメントとして出力する項目 */ - visible_tags?: ('partner' | 'item' | 'tag' | 'section' | 'description' | 'wallet_txn_description' | 'all')[] + visible_tags?: ('partner' | 'item' | 'tag' | 'section' | 'description' | 'wallet_txn_description' | 'all')[] | undefined /** 取得開始日 (yyyy-mm-dd) */ - start_date?: string + start_date?: string | undefined /** 取得終了日 (yyyy-mm-dd) */ - end_date?: string + end_date?: string | undefined } status: 202 diff --git a/samples/freee/api/1/journals/reports/_id@number/status/index.ts b/samples/freee/api/1/journals/reports/_id@number/status/index.ts index 2ec8311f..741c1381 100644 --- a/samples/freee/api/1/journals/reports/_id@number/status/index.ts +++ b/samples/freee/api/1/journals/reports/_id@number/status/index.ts @@ -34,11 +34,11 @@ export type Methods = { /** 事業所ID */ company_id: number /** 補助科目やコメントとして出力する項目 */ - visible_tags?: ('partner' | 'item' | 'tag' | 'section' | 'description' | 'wallet_txn_description' | 'all')[] + visible_tags?: ('partner' | 'item' | 'tag' | 'section' | 'description' | 'wallet_txn_description' | 'all')[] | undefined /** 取得開始日 (yyyy-mm-dd) */ - start_date?: string + start_date?: string | undefined /** 取得終了日 (yyyy-mm-dd) */ - end_date?: string + end_date?: string | undefined } status: 200 diff --git a/samples/freee/api/1/manual_journals/_id@number/index.ts b/samples/freee/api/1/manual_journals/_id@number/index.ts index e18c9297..c4651b27 100644 --- a/samples/freee/api/1/manual_journals/_id@number/index.ts +++ b/samples/freee/api/1/manual_journals/_id@number/index.ts @@ -96,7 +96,7 @@ export type Methods = { resBody: Types.ManualJournalResponse reqFormat: URLSearchParams /** 振替伝票の更新 */ - reqBody?: Types.ManualJournalUpdateParams + reqBody?: Types.ManualJournalUpdateParams | undefined } /** diff --git a/samples/freee/api/1/manual_journals/index.ts b/samples/freee/api/1/manual_journals/index.ts index 8b37cf1c..0e111751 100644 --- a/samples/freee/api/1/manual_journals/index.ts +++ b/samples/freee/api/1/manual_journals/index.ts @@ -54,43 +54,43 @@ export type Methods = { /** 事業所ID */ company_id: number /** 発生日で絞込：開始日(yyyy-mm-dd) */ - start_issue_date?: string + start_issue_date?: string | undefined /** 発生日で絞込：終了日(yyyy-mm-dd) */ - end_issue_date?: string + end_issue_date?: string | undefined /** 貸借で絞込 (貸方: credit, 借方: debit) */ - entry_side?: 'credit' | 'debit' + entry_side?: 'credit' | 'debit' | undefined /** 勘定科目IDで絞込 */ - account_item_id?: number + account_item_id?: number | undefined /** 金額で絞込：下限 */ - min_amount?: number + min_amount?: number | undefined /** 金額で絞込：上限 */ - max_amount?: number + max_amount?: number | undefined /** 取引先IDで絞込（0を指定すると、取引先が未選択の貸借行を絞り込めます） */ - partner_id?: number + partner_id?: number | undefined /** 取引先コードで絞込 */ - partner_code?: string + partner_code?: string | undefined /** 品目IDで絞込（0を指定すると、品目が未選択の貸借行を絞り込めます） */ - item_id?: number + item_id?: number | undefined /** 部門IDで絞込（0を指定すると、部門が未選択の貸借行を絞り込めます） */ - section_id?: number + section_id?: number | undefined /** セグメント１IDで絞り込み（0を指定すると、セグメント１が未選択の貸借行を絞り込めます） */ - segment_1_tag_id?: number + segment_1_tag_id?: number | undefined /** セグメント２IDで絞り込み（0を指定すると、セグメント２が未選択の貸借行を絞り込めます） */ - segment_2_tag_id?: number + segment_2_tag_id?: number | undefined /** セグメント３IDで絞り込み（0を指定すると、セグメント３が未選択の貸借行を絞り込めます） */ - segment_3_tag_id?: number + segment_3_tag_id?: number | undefined /** コメント状態で絞込（自分宛のコメント: posted_with_mention, 自分宛のコメント-未解決: raised_with_mention, 自分宛のコメント-解決済: resolved_with_mention, コメントあり: posted, 未解決: raised, 解決済: resolved, コメントなし: none） */ - comment_status?: 'posted_with_mention' | 'raised_with_mention' | 'resolved_with_mention' | 'posted' | 'raised' | 'resolved' | 'none' + comment_status?: 'posted_with_mention' | 'raised_with_mention' | 'resolved_with_mention' | 'posted' | 'raised' | 'resolved' | 'none' | undefined /** 重要コメント付きの振替伝票を絞込 */ - comment_important?: boolean + comment_important?: boolean | undefined /** 決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without） */ - adjustment?: 'only' | 'without' + adjustment?: 'only' | 'without' | undefined /** 仕訳番号で絞込（事業所の仕訳番号形式が有効な場合のみ） */ - txn_number?: string + txn_number?: string | undefined /** 取得レコードのオフセット (デフォルト: 0) */ - offset?: number + offset?: number | undefined /** 取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 500) */ - limit?: number + limit?: number | undefined } status: 200 @@ -153,6 +153,6 @@ export type Methods = { resBody: Types.ManualJournalResponse reqFormat: URLSearchParams /** 振替伝票の作成 */ - reqBody?: Types.ManualJournalCreateParams + reqBody?: Types.ManualJournalCreateParams | undefined } } diff --git a/samples/freee/api/1/partners/index.ts b/samples/freee/api/1/partners/index.ts index 17753335..6c2c4740 100644 --- a/samples/freee/api/1/partners/index.ts +++ b/samples/freee/api/1/partners/index.ts @@ -14,11 +14,11 @@ export type Methods = { /** 事業所ID */ company_id: number /** 取得レコードのオフセット (デフォルト: 0) */ - offset?: number + offset?: number | undefined /** 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 3000) */ - limit?: number + limit?: number | undefined /** 検索キーワード：取引先名・正式名称・カナ名称に対するあいまい検索で一致、またはショートカットキー1・2のいずれかに完全一致 */ - keyword?: string + keyword?: string | undefined } status: 200 diff --git a/samples/freee/api/1/quotations/_id@number/index.ts b/samples/freee/api/1/quotations/_id@number/index.ts index 41687212..391a68a6 100644 --- a/samples/freee/api/1/quotations/_id@number/index.ts +++ b/samples/freee/api/1/quotations/_id@number/index.ts @@ -33,7 +33,7 @@ export type Methods = { resBody: Types.QuotationResponse reqFormat: URLSearchParams /** 見積書の更新 */ - reqBody?: Types.QuotationUpdateParams + reqBody?: Types.QuotationUpdateParams | undefined } /** diff --git a/samples/freee/api/1/quotations/index.ts b/samples/freee/api/1/quotations/index.ts index bf9fd581..c78af5aa 100644 --- a/samples/freee/api/1/quotations/index.ts +++ b/samples/freee/api/1/quotations/index.ts @@ -12,23 +12,23 @@ export type Methods = { /** 事業所ID */ company_id: number /** 取引先IDで絞込 */ - partner_id?: number + partner_id?: number | undefined /** 取引先コードで絞込 */ - partner_code?: string + partner_code?: string | undefined /** 見積日の開始日(yyyy-mm-dd) */ - start_issue_date?: string + start_issue_date?: string | undefined /** 見積日の終了日(yyyy-mm-dd) */ - end_issue_date?: string + end_issue_date?: string | undefined /** 見積書番号 */ - quotation_number?: string + quotation_number?: string | undefined /** 概要 */ - description?: string + description?: string | undefined /** 見積書ステータス (unsubmitted: 送付待ち, submitted: 送付済み, all: 全て) */ - quotation_status?: 'all' | 'unsubmitted' | 'submitted' + quotation_status?: 'all' | 'unsubmitted' | 'submitted' | undefined /** 取得レコードのオフセット (デフォルト: 0) */ - offset?: number + offset?: number | undefined /** 取得レコードの件数 (デフォルト: 20, 最大: 100) */ - limit?: number + limit?: number | undefined } status: 200 @@ -54,6 +54,6 @@ export type Methods = { resBody: Types.QuotationResponse reqFormat: URLSearchParams /** 見積書の作成 */ - reqBody?: Types.QuotationCreateParams + reqBody?: Types.QuotationCreateParams | undefined } } diff --git a/samples/freee/api/1/receipts/index.ts b/samples/freee/api/1/receipts/index.ts index bab02764..4e9f891c 100644 --- a/samples/freee/api/1/receipts/index.ts +++ b/samples/freee/api/1/receipts/index.ts @@ -16,19 +16,19 @@ export type Methods = { /** アップロード日 (yyyy-mm-dd) */ end_date: string /** アップロードしたユーザー名、メールアドレス */ - user_name?: string + user_name?: string | undefined /** アップロードファイルNo */ - number?: number + number?: number | undefined /** posted:コメントあり, raised:未解決, resolved:解決済 */ - comment_type?: 'posted' | 'raised' | 'resolved' + comment_type?: 'posted' | 'raised' | 'resolved' | undefined /** trueの時、重要コメント付きが対象 */ - comment_important?: boolean + comment_important?: boolean | undefined /** all:すべて、without_deal:未登録、with_expense_application_line:経費申請中, with_deal:登録済み、ignored:無視 */ - category?: 'all' | 'without_deal' | 'with_expense_application_line' | 'with_deal' | 'ignored' + category?: 'all' | 'without_deal' | 'with_expense_application_line' | 'with_deal' | 'ignored' | undefined /** 取得レコードのオフセット (デフォルト: 0) */ - offset?: number + offset?: number | undefined /** 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 3000) */ - limit?: number + limit?: number | undefined } status: 200 diff --git a/samples/freee/api/1/reports/trial_bs/index.ts b/samples/freee/api/1/reports/trial_bs/index.ts index 7013ab0d..4d5f9688 100644 --- a/samples/freee/api/1/reports/trial_bs/index.ts +++ b/samples/freee/api/1/reports/trial_bs/index.ts @@ -91,27 +91,27 @@ export type Methods = { /** 事業所ID */ company_id: number /** 会計年度 */ - fiscal_year?: number + fiscal_year?: number | undefined /** 発生月で絞込：開始会計月(mm) */ - start_month?: number + start_month?: number | undefined /** 発生月で絞込：終了会計月(mm) */ - end_month?: number + end_month?: number | undefined /** 発生日で絞込：開始日(yyyy-mm-dd) */ - start_date?: string + start_date?: string | undefined /** 発生日で絞込：終了日(yyyy-mm-dd) */ - end_date?: string + end_date?: string | undefined /** 勘定科目の表示（勘定科目: account_item, 決算書表示:group） */ - account_item_display_type?: 'account_item' | 'group' + account_item_display_type?: 'account_item' | 'group' | undefined /** 内訳の表示（取引先: partner, 品目: item, 勘定科目: account_item） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます */ - breakdown_display_type?: 'partner' | 'item' | 'account_item' + breakdown_display_type?: 'partner' | 'item' | 'account_item' | undefined /** 取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます） */ - partner_id?: number + partner_id?: number | undefined /** 取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です） */ - partner_code?: string + partner_code?: string | undefined /** 品目IDで絞込（0を指定すると、品目が未選択で絞り込めます） */ - item_id?: number + item_id?: number | undefined /** 決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without） */ - adjustment?: 'only' | 'without' + adjustment?: 'only' | 'without' | undefined } status: 200 diff --git a/samples/freee/api/1/reports/trial_bs_three_years/index.ts b/samples/freee/api/1/reports/trial_bs_three_years/index.ts index 48d6b822..faa3b18a 100644 --- a/samples/freee/api/1/reports/trial_bs_three_years/index.ts +++ b/samples/freee/api/1/reports/trial_bs_three_years/index.ts @@ -73,27 +73,27 @@ export type Methods = { /** 事業所ID */ company_id: number /** 会計年度 */ - fiscal_year?: number + fiscal_year?: number | undefined /** 発生月で絞込：開始会計月(mm) */ - start_month?: number + start_month?: number | undefined /** 発生月で絞込：終了会計月(mm) */ - end_month?: number + end_month?: number | undefined /** 発生日で絞込：開始日(yyyy-mm-dd) */ - start_date?: string + start_date?: string | undefined /** 発生日で絞込：終了日(yyyy-mm-dd) */ - end_date?: string + end_date?: string | undefined /** 勘定科目の表示（勘定科目: account_item, 決算書表示:group） */ - account_item_display_type?: 'account_item' | 'group' + account_item_display_type?: 'account_item' | 'group' | undefined /** 内訳の表示（取引先: partner, 品目: item, 勘定科目: account_item） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます */ - breakdown_display_type?: 'partner' | 'item' | 'account_item' + breakdown_display_type?: 'partner' | 'item' | 'account_item' | undefined /** 取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます） */ - partner_id?: number + partner_id?: number | undefined /** 取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です） */ - partner_code?: string + partner_code?: string | undefined /** 品目IDで絞込（0を指定すると、品目が未選択で絞り込めます） */ - item_id?: number + item_id?: number | undefined /** 決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without） */ - adjustment?: 'only' | 'without' + adjustment?: 'only' | 'without' | undefined } status: 200 diff --git a/samples/freee/api/1/reports/trial_bs_two_years/index.ts b/samples/freee/api/1/reports/trial_bs_two_years/index.ts index 788b0d0c..df4937f2 100644 --- a/samples/freee/api/1/reports/trial_bs_two_years/index.ts +++ b/samples/freee/api/1/reports/trial_bs_two_years/index.ts @@ -68,27 +68,27 @@ export type Methods = { /** 事業所ID */ company_id: number /** 会計年度 */ - fiscal_year?: number + fiscal_year?: number | undefined /** 発生月で絞込：開始会計月(mm) */ - start_month?: number + start_month?: number | undefined /** 発生月で絞込：終了会計月(mm) */ - end_month?: number + end_month?: number | undefined /** 発生日で絞込：開始日(yyyy-mm-dd) */ - start_date?: string + start_date?: string | undefined /** 発生日で絞込：終了日(yyyy-mm-dd) */ - end_date?: string + end_date?: string | undefined /** 勘定科目の表示（勘定科目: account_item, 決算書表示:group） */ - account_item_display_type?: 'account_item' | 'group' + account_item_display_type?: 'account_item' | 'group' | undefined /** 内訳の表示（取引先: partner, 品目: item, 勘定科目: account_item） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます */ - breakdown_display_type?: 'partner' | 'item' | 'account_item' + breakdown_display_type?: 'partner' | 'item' | 'account_item' | undefined /** 取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます） */ - partner_id?: number + partner_id?: number | undefined /** 取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です） */ - partner_code?: string + partner_code?: string | undefined /** 品目IDで絞込（0を指定すると、品目が未選択で絞り込めます） */ - item_id?: number + item_id?: number | undefined /** 決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without） */ - adjustment?: 'only' | 'without' + adjustment?: 'only' | 'without' | undefined } status: 200 diff --git a/samples/freee/api/1/reports/trial_pl/index.ts b/samples/freee/api/1/reports/trial_pl/index.ts index 6ea4a553..67bdf666 100644 --- a/samples/freee/api/1/reports/trial_pl/index.ts +++ b/samples/freee/api/1/reports/trial_pl/index.ts @@ -91,31 +91,31 @@ export type Methods = { /** 事業所ID */ company_id: number /** 会計年度 */ - fiscal_year?: number + fiscal_year?: number | undefined /** 発生月で絞込：開始会計月(mm) */ - start_month?: number + start_month?: number | undefined /** 発生月で絞込：終了会計月(mm) */ - end_month?: number + end_month?: number | undefined /** 発生日で絞込：開始日(yyyy-mm-dd) */ - start_date?: string + start_date?: string | undefined /** 発生日で絞込：終了日(yyyy-mm-dd) */ - end_date?: string + end_date?: string | undefined /** 勘定科目の表示（勘定科目: account_item, 決算書表示:group） */ - account_item_display_type?: 'account_item' | 'group' + account_item_display_type?: 'account_item' | 'group' | undefined /** 内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます */ - breakdown_display_type?: 'partner' | 'item' | 'section' | 'account_item' + breakdown_display_type?: 'partner' | 'item' | 'section' | 'account_item' | undefined /** 取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます） */ - partner_id?: number + partner_id?: number | undefined /** 取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です） */ - partner_code?: string + partner_code?: string | undefined /** 品目IDで絞込（0を指定すると、品目が未選択で絞り込めます） */ - item_id?: number + item_id?: number | undefined /** 部門IDで絞込（0を指定すると、部門が未選択で絞り込めます） */ - section_id?: number + section_id?: number | undefined /** 決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without） */ - adjustment?: 'only' | 'without' + adjustment?: 'only' | 'without' | undefined /** 配賦仕訳で絞込（配賦仕訳のみ：only,配賦仕訳以外：without） */ - cost_allocation?: 'only' | 'not_include' + cost_allocation?: 'only' | 'not_include' | undefined } status: 200 diff --git a/samples/freee/api/1/reports/trial_pl_sections/index.ts b/samples/freee/api/1/reports/trial_pl_sections/index.ts index 4db659a3..19795f5d 100644 --- a/samples/freee/api/1/reports/trial_pl_sections/index.ts +++ b/samples/freee/api/1/reports/trial_pl_sections/index.ts @@ -81,29 +81,29 @@ export type Methods = { /** 出力する部門の指定（半角数字のidを半角カンマ区切りスペースなしで指定してください） */ section_ids: string /** 会計年度 */ - fiscal_year?: number + fiscal_year?: number | undefined /** 発生月で絞込：開始会計月(mm) */ - start_month?: number + start_month?: number | undefined /** 発生月で絞込：終了会計月(mm) */ - end_month?: number + end_month?: number | undefined /** 発生日で絞込：開始日(yyyy-mm-dd) */ - start_date?: string + start_date?: string | undefined /** 発生日で絞込：終了日(yyyy-mm-dd) */ - end_date?: string + end_date?: string | undefined /** 勘定科目の表示（勘定科目: account_item, 決算書表示:group） */ - account_item_display_type?: 'account_item' | 'group' + account_item_display_type?: 'account_item' | 'group' | undefined /** 内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます */ - breakdown_display_type?: 'partner' | 'item' | 'section' | 'account_item' + breakdown_display_type?: 'partner' | 'item' | 'section' | 'account_item' | undefined /** 取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます） */ - partner_id?: number + partner_id?: number | undefined /** 取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です） */ - partner_code?: string + partner_code?: string | undefined /** 品目IDで絞込（0を指定すると、品目が未選択で絞り込めます） */ - item_id?: number + item_id?: number | undefined /** 決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without） */ - adjustment?: 'only' | 'without' + adjustment?: 'only' | 'without' | undefined /** 配賦仕訳で絞込（配賦仕訳のみ：only,配賦仕訳以外：without） */ - cost_allocation?: 'only' | 'not_include' + cost_allocation?: 'only' | 'not_include' | undefined } status: 200 diff --git a/samples/freee/api/1/reports/trial_pl_three_years/index.ts b/samples/freee/api/1/reports/trial_pl_three_years/index.ts index 761543ed..4d34d381 100644 --- a/samples/freee/api/1/reports/trial_pl_three_years/index.ts +++ b/samples/freee/api/1/reports/trial_pl_three_years/index.ts @@ -73,31 +73,31 @@ export type Methods = { /** 事業所ID */ company_id: number /** 会計年度 */ - fiscal_year?: number + fiscal_year?: number | undefined /** 発生月で絞込：開始会計月(mm) */ - start_month?: number + start_month?: number | undefined /** 発生月で絞込：終了会計月(mm) */ - end_month?: number + end_month?: number | undefined /** 発生日で絞込：開始日(yyyy-mm-dd) */ - start_date?: string + start_date?: string | undefined /** 発生日で絞込：終了日(yyyy-mm-dd) */ - end_date?: string + end_date?: string | undefined /** 勘定科目の表示（勘定科目: account_item, 決算書表示:group） */ - account_item_display_type?: 'account_item' | 'group' + account_item_display_type?: 'account_item' | 'group' | undefined /** 内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます */ - breakdown_display_type?: 'partner' | 'item' | 'section' | 'account_item' + breakdown_display_type?: 'partner' | 'item' | 'section' | 'account_item' | undefined /** 取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます） */ - partner_id?: number + partner_id?: number | undefined /** 取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です） */ - partner_code?: string + partner_code?: string | undefined /** 品目IDで絞込（0を指定すると、品目が未選択で絞り込めます） */ - item_id?: number + item_id?: number | undefined /** 部門IDで絞込（0を指定すると、部門が未選択で絞り込めます） */ - section_id?: number + section_id?: number | undefined /** 決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without） */ - adjustment?: 'only' | 'without' + adjustment?: 'only' | 'without' | undefined /** 配賦仕訳で絞込（配賦仕訳のみ：only,配賦仕訳以外：without） */ - cost_allocation?: 'only' | 'not_include' + cost_allocation?: 'only' | 'not_include' | undefined } status: 200 diff --git a/samples/freee/api/1/reports/trial_pl_two_years/index.ts b/samples/freee/api/1/reports/trial_pl_two_years/index.ts index d2cd4416..6544044f 100644 --- a/samples/freee/api/1/reports/trial_pl_two_years/index.ts +++ b/samples/freee/api/1/reports/trial_pl_two_years/index.ts @@ -71,31 +71,31 @@ export type Methods = { /** 事業所ID */ company_id: number /** 会計年度 */ - fiscal_year?: number + fiscal_year?: number | undefined /** 発生月で絞込：開始会計月(mm) */ - start_month?: number + start_month?: number | undefined /** 発生月で絞込：終了会計月(mm) */ - end_month?: number + end_month?: number | undefined /** 発生日で絞込：開始日(yyyy-mm-dd) */ - start_date?: string + start_date?: string | undefined /** 発生日で絞込：終了日(yyyy-mm-dd) */ - end_date?: string + end_date?: string | undefined /** 勘定科目の表示（勘定科目: account_item, 決算書表示:group） */ - account_item_display_type?: 'account_item' | 'group' + account_item_display_type?: 'account_item' | 'group' | undefined /** 内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます */ - breakdown_display_type?: 'partner' | 'item' | 'section' | 'account_item' + breakdown_display_type?: 'partner' | 'item' | 'section' | 'account_item' | undefined /** 取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます） */ - partner_id?: number + partner_id?: number | undefined /** 取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です） */ - partner_code?: string + partner_code?: string | undefined /** 品目IDで絞込（0を指定すると、品目が未選択で絞り込めます） */ - item_id?: number + item_id?: number | undefined /** 部門IDで絞込（0を指定すると、部門が未選択で絞り込めます） */ - section_id?: number + section_id?: number | undefined /** 決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without） */ - adjustment?: 'only' | 'without' + adjustment?: 'only' | 'without' | undefined /** 配賦仕訳で絞込（配賦仕訳のみ：only,配賦仕訳以外：without） */ - cost_allocation?: 'only' | 'not_include' + cost_allocation?: 'only' | 'not_include' | undefined } status: 200 diff --git a/samples/freee/api/1/sections/_id@number/index.ts b/samples/freee/api/1/sections/_id@number/index.ts index daf2be57..1bd32bf9 100644 --- a/samples/freee/api/1/sections/_id@number/index.ts +++ b/samples/freee/api/1/sections/_id@number/index.ts @@ -77,7 +77,7 @@ export type Methods = { resBody: Types.SectionResponse reqFormat: URLSearchParams /** 部門の更新 */ - reqBody?: Types.SectionParams + reqBody?: Types.SectionParams | undefined } /** diff --git a/samples/freee/api/1/sections/index.ts b/samples/freee/api/1/sections/index.ts index 86397779..f0e7a6fd 100644 --- a/samples/freee/api/1/sections/index.ts +++ b/samples/freee/api/1/sections/index.ts @@ -92,6 +92,6 @@ export type Methods = { resBody: Types.SectionResponse reqFormat: URLSearchParams /** 部門の作成 */ - reqBody?: Types.SectionParams + reqBody?: Types.SectionParams | undefined } } diff --git a/samples/freee/api/1/segments/_segment_id@number/tags/index.ts b/samples/freee/api/1/segments/_segment_id@number/tags/index.ts index 86432ca1..5fad2e3e 100644 --- a/samples/freee/api/1/segments/_segment_id@number/tags/index.ts +++ b/samples/freee/api/1/segments/_segment_id@number/tags/index.ts @@ -20,9 +20,9 @@ export type Methods = { /** 事業所ID */ company_id: number /** 取得レコードのオフセット (デフォルト: 0) */ - offset?: number + offset?: number | undefined /** 取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 500) */ - limit?: number + limit?: number | undefined } status: 200 diff --git a/samples/freee/api/1/tags/_id@number/index.ts b/samples/freee/api/1/tags/_id@number/index.ts index 5e8531aa..dfb5701c 100644 --- a/samples/freee/api/1/tags/_id@number/index.ts +++ b/samples/freee/api/1/tags/_id@number/index.ts @@ -27,7 +27,7 @@ export type Methods = { resBody: Types.TagResponse reqFormat: URLSearchParams /** メモタグの更新 */ - reqBody?: Types.TagParams + reqBody?: Types.TagParams | undefined } /** diff --git a/samples/freee/api/1/transfers/index.ts b/samples/freee/api/1/transfers/index.ts index aadd4cc5..19ca2a90 100644 --- a/samples/freee/api/1/transfers/index.ts +++ b/samples/freee/api/1/transfers/index.ts @@ -32,13 +32,13 @@ export type Methods = { /** 事業所ID */ company_id: number /** 振替日で絞込：開始日 (yyyy-mm-dd) */ - start_date?: string + start_date?: string | undefined /** 振替日で絞込：終了日 (yyyy-mm-dd) */ - end_date?: string + end_date?: string | undefined /** 取得レコードのオフセット (デフォルト: 0) */ - offset?: number + offset?: number | undefined /** 取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 100) */ - limit?: number + limit?: number | undefined } status: 200 @@ -78,6 +78,6 @@ export type Methods = { resBody: Types.TransferResponse reqFormat: URLSearchParams /** 取引（振替）の作成 */ - reqBody?: Types.TransferParams + reqBody?: Types.TransferParams | undefined } } diff --git a/samples/freee/api/1/users/index.ts b/samples/freee/api/1/users/index.ts index 6d1c9145..78a816cc 100644 --- a/samples/freee/api/1/users/index.ts +++ b/samples/freee/api/1/users/index.ts @@ -12,7 +12,7 @@ export type Methods = { /** 事業所ID */ company_id: number /** 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 3000) */ - limit?: number + limit?: number | undefined } status: 200 diff --git a/samples/freee/api/1/users/me/index.ts b/samples/freee/api/1/users/me/index.ts index e4fbcdc8..82a91208 100644 --- a/samples/freee/api/1/users/me/index.ts +++ b/samples/freee/api/1/users/me/index.ts @@ -10,8 +10,8 @@ export type Methods = { get: { query?: { /** 取得情報にユーザが所属する事業所一覧を含める */ - companies?: true - } + companies?: true | undefined + } | undefined status: 200 resBody: Types.MeResponse @@ -27,6 +27,6 @@ export type Methods = { resBody: Types.UserResponse reqFormat: URLSearchParams /** ユーザー情報の更新 */ - reqBody?: Types.UserParams + reqBody?: Types.UserParams | undefined } } diff --git a/samples/freee/api/1/wallet_txns/index.ts b/samples/freee/api/1/wallet_txns/index.ts index 8e985c7c..2d95d79a 100644 --- a/samples/freee/api/1/wallet_txns/index.ts +++ b/samples/freee/api/1/wallet_txns/index.ts @@ -50,19 +50,19 @@ export type Methods = { /** 事業所ID */ company_id: number /** 口座区分 (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet) */ - walletable_type?: 'bank_account' | 'credit_card' | 'wallet' + walletable_type?: 'bank_account' | 'credit_card' | 'wallet' | undefined /** 口座ID */ - walletable_id?: number + walletable_id?: number | undefined /** 取引日で絞込：開始日 (yyyy-mm-dd) */ - start_date?: string + start_date?: string | undefined /** 取引日で絞込：終了日 (yyyy-mm-dd) */ - end_date?: string + end_date?: string | undefined /** 入金／出金 (入金: income, 出金: expense) */ - entry_side?: 'income' | 'expense' + entry_side?: 'income' | 'expense' | undefined /** 取得レコードのオフセット (デフォルト: 0) */ - offset?: number + offset?: number | undefined /** 取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 100) */ - limit?: number + limit?: number | undefined } status: 200 @@ -120,6 +120,6 @@ export type Methods = { resBody: Types.WalletTxnResponse reqFormat: URLSearchParams /** 明細の作成 */ - reqBody?: Types.WalletTxnParams + reqBody?: Types.WalletTxnParams | undefined } } diff --git a/samples/freee/api/1/walletables/_type/_id@number/index.ts b/samples/freee/api/1/walletables/_type/_id@number/index.ts index f09371c7..06ed1dc6 100644 --- a/samples/freee/api/1/walletables/_type/_id@number/index.ts +++ b/samples/freee/api/1/walletables/_type/_id@number/index.ts @@ -50,7 +50,7 @@ export type Methods = { resBody: Types.WalletableResponse reqFormat: URLSearchParams /** 口座の作成 */ - reqBody?: Types.WalletableUpdateParams + reqBody?: Types.WalletableUpdateParams | undefined } /** diff --git a/samples/freee/api/1/walletables/index.ts b/samples/freee/api/1/walletables/index.ts index 76b6e0a9..7561b1de 100644 --- a/samples/freee/api/1/walletables/index.ts +++ b/samples/freee/api/1/walletables/index.ts @@ -30,9 +30,9 @@ export type Methods = { /** 事業所ID */ company_id: number /** 残高情報を含める */ - with_balance?: boolean + with_balance?: boolean | undefined /** 口座種別（bank_account : 銀行口座, credit_card : クレジットカード, wallet : その他の決済口座） */ - type?: 'bank_account' | 'credit_card' | 'wallet' + type?: 'bank_account' | 'credit_card' | 'wallet' | undefined } status: 200 @@ -43,7 +43,7 @@ export type Methods = { meta?: { /** 集計結果が最新かどうか */ up_to_date: boolean - } + } | undefined } } @@ -88,6 +88,6 @@ export type Methods = { resBody: Types.WalletableCreateResponse reqFormat: URLSearchParams /** 口座の作成 */ - reqBody?: Types.WalletableCreateParams + reqBody?: Types.WalletableCreateParams | undefined } } diff --git a/samples/nullable-object/@types/index.ts b/samples/nullable-object/@types/index.ts index 5ab4e2bd..b83abcef 100644 --- a/samples/nullable-object/@types/index.ts +++ b/samples/nullable-object/@types/index.ts @@ -1,4 +1,4 @@ /* eslint-disable */ export type User = { - id?: string + id?: string | undefined } diff --git a/samples/openapi/@types/index.ts b/samples/openapi/@types/index.ts index d3d2c14f..f4560ccb 100644 --- a/samples/openapi/@types/index.ts +++ b/samples/openapi/@types/index.ts @@ -17,15 +17,15 @@ export type UserTokenHeader = { } export type AppOrganisationToken = { - 'x-tchop-app-organisation-token'?: string + 'x-tchop-app-organisation-token'?: string | undefined } export type UserPublicKey = { - 'x-tchop-user-public-key'?: string + 'x-tchop-user-public-key'?: string | undefined } export type UserSignedChallenge = { - 'x-tchop-user-signed-challenge'?: string + 'x-tchop-user-signed-challenge'?: string | undefined } export type AppOrganisationTokenRequired = { @@ -34,13 +34,13 @@ export type AppOrganisationTokenRequired = { export type UserInstanceIdHeader = { /** Firebase Instance ID provides a unique identifier for each app instance and a mechanism to authenticate and authorize actions (example: sending FCM messages) */ - 'x-tchop-firebase-instance-id'?: string + 'x-tchop-firebase-instance-id'?: string | undefined } export type ErrorModel = { code: string message: string - messageCode?: string + messageCode?: string | undefined } export type ErrorValidationModel = { @@ -57,7 +57,7 @@ export type UserInfo = { id: number username: string email: string - avatar?: string + avatar?: string | undefined url: string } @@ -69,15 +69,15 @@ export type OrganisationModel = { name: string subdomain: string locale: string - androidStoreLink?: string - androidAppId?: string - androidHokeyStoreLink?: string - androidAppHokeyId?: string - iosStoreLink?: string - iosAppId?: string - iosHokeyStoreLink?: string - iosAppHokeyId?: string - fcmServerKeyId?: number + androidStoreLink?: string | undefined + androidAppId?: string | undefined + androidHokeyStoreLink?: string | undefined + androidAppHokeyId?: string | undefined + iosStoreLink?: string | undefined + iosAppId?: string | undefined + iosHokeyStoreLink?: string | undefined + iosAppHokeyId?: string | undefined + fcmServerKeyId?: number | undefined allowToStoreOriginalImageFile: string twoFactorForce: string sessionExpirationTime: string @@ -101,8 +101,8 @@ export type BaseMixModel = { shareUrl: string previewUrl: string includeInNewsFeed: boolean - displayItemUpdatedTime?: string - image?: ImageModel + displayItemUpdatedTime?: string | undefined + image?: ImageModel | undefined } export type ModelMixV3 = BaseMixModel & { @@ -116,48 +116,48 @@ export type ImageModel = { rightholder: string thumb: string status: 'ok' | 'processing' | 'error' - url?: string + url?: string | undefined } export type AudioModel = { id: number - url?: string + url?: string | undefined thumb: string - originalThumb?: string + originalThumb?: string | undefined status: string - duration?: number - width?: number - height?: number + duration?: number | undefined + width?: number | undefined + height?: number | undefined } export type ModelCard = { id: number type: CardEnumModel - createdByLabel?: string + createdByLabel?: string | undefined created: string postedTime: string updated: string published: boolean - position?: number - headline?: string - quotePerson?: string - quotePersonHandle?: string - quote?: string - title?: string - sourceName?: string - url?: string - abstract?: string - image?: ImageModel - audio?: AudioModel - styles?: CardStyleModel - author?: CardAuthorModel + position?: number | undefined + headline?: string | undefined + quotePerson?: string | undefined + quotePersonHandle?: string | undefined + quote?: string | undefined + title?: string | undefined + sourceName?: string | undefined + url?: string | undefined + abstract?: string | undefined + image?: ImageModel | undefined + audio?: AudioModel | undefined + styles?: CardStyleModel | undefined + author?: CardAuthorModel | undefined } export type CardAuthorModel = { type: 'curate-backend' | 'api' name: string - email?: string - image?: ImageModel + email?: string | undefined + image?: ImageModel | undefined } export type ReactionEnumModel = 'like' | 'love' | 'haha' | 'wow' | 'sad' | 'angry' @@ -166,40 +166,40 @@ export type CardEnumModel = 'article' | 'image' | 'video' | 'quote' | 'editorial /** The number of reactions to each type */ export type ReactionCountModel = { - like?: number - love?: number - haha?: number - wow?: number - sad?: number - angry?: number + like?: number | undefined + love?: number | undefined + haha?: number | undefined + wow?: number | undefined + sad?: number | undefined + angry?: number | undefined } export type MediaEXIFModel = { gps?: { x: number y: number - } + } | undefined } export type CardStyleModel = { - showAuthor?: boolean + showAuthor?: boolean | undefined /** Alternative UI Templates for article cards */ - teaserStyle?: 'standard' | 'small_with_text' | 'small_without_text' | 'big_without_text' + teaserStyle?: 'standard' | 'small_with_text' | 'small_without_text' | 'big_without_text' | undefined } export type QuoteModel = { - quotePerson?: string - quotePersonHandle?: string - quote?: string - quoteSource?: string - image?: string - quotePersonImage?: string - quoteCreated?: string + quotePerson?: string | undefined + quotePersonHandle?: string | undefined + quote?: string | undefined + quoteSource?: string | undefined + image?: string | undefined + quotePersonImage?: string | undefined + quoteCreated?: string | undefined } export type ArticleModel = { - title?: string - abstract?: string - sourceName?: string - image?: string + title?: string | undefined + abstract?: string | undefined + sourceName?: string | undefined + image?: string | undefined } diff --git a/samples/openapi/api/stream/v1/stories/_storyId@number/index.ts b/samples/openapi/api/stream/v1/stories/_storyId@number/index.ts index 4ab7d94e..38c88fce 100644 --- a/samples/openapi/api/stream/v1/stories/_storyId@number/index.ts +++ b/samples/openapi/api/stream/v1/stories/_storyId@number/index.ts @@ -5,8 +5,8 @@ export type Methods = { get: { query: { token: string - offset?: number - limit?: number + offset?: number | undefined + limit?: number | undefined } status: 200 diff --git a/samples/openapi/api/v1/me/index.ts b/samples/openapi/api/v1/me/index.ts index 156bd1c3..c6b41571 100644 --- a/samples/openapi/api/v1/me/index.ts +++ b/samples/openapi/api/v1/me/index.ts @@ -9,9 +9,9 @@ export type Methods = { screenName: string email: string isStaff: boolean - channelName?: string - channelId?: number - url?: string + channelName?: string | undefined + channelId?: number | undefined + url?: string | undefined } } } diff --git a/samples/openapi/api/v1/mixes/_id@string/index.ts b/samples/openapi/api/v1/mixes/_id@string/index.ts index 561a59d0..b0003803 100644 --- a/samples/openapi/api/v1/mixes/_id@string/index.ts +++ b/samples/openapi/api/v1/mixes/_id@string/index.ts @@ -5,7 +5,7 @@ export type Methods = { reqBody: { name: string - title?: string + title?: string | undefined } } } diff --git a/samples/openapi/api/v1/mixes/_mixId@string/cards/index.ts b/samples/openapi/api/v1/mixes/_mixId@string/cards/index.ts index 2099669f..ca5c532c 100644 --- a/samples/openapi/api/v1/mixes/_mixId@string/cards/index.ts +++ b/samples/openapi/api/v1/mixes/_mixId@string/cards/index.ts @@ -7,23 +7,23 @@ export type Methods = { reqBody: { type: Types.CardEnumModel - title?: string - abstract?: string - sourceName?: string - image?: string - imageId?: string - quotePerson?: string - quote?: string - url?: string - quotePersonImageId?: string - quotePersonImage?: string - quoteSource?: string - quotePersonHandle?: string - videoId?: string - text?: string - headline?: string - quoteCreated?: string - published?: boolean + title?: string | undefined + abstract?: string | undefined + sourceName?: string | undefined + image?: string | undefined + imageId?: string | undefined + quotePerson?: string | undefined + quote?: string | undefined + url?: string | undefined + quotePersonImageId?: string | undefined + quotePersonImage?: string | undefined + quoteSource?: string | undefined + quotePersonHandle?: string | undefined + videoId?: string | undefined + text?: string | undefined + headline?: string | undefined + quoteCreated?: string | undefined + published?: boolean | undefined } } } diff --git a/samples/openapi/api/v1/mixes/_mixId@string/url/index.ts b/samples/openapi/api/v1/mixes/_mixId@string/url/index.ts index 4dfc2e83..1a630af9 100644 --- a/samples/openapi/api/v1/mixes/_mixId@string/url/index.ts +++ b/samples/openapi/api/v1/mixes/_mixId@string/url/index.ts @@ -5,8 +5,8 @@ export type Methods = { reqBody: { url: string - published?: boolean - enableImage?: boolean + published?: boolean | undefined + enableImage?: boolean | undefined } } } diff --git a/samples/openapi/api/v1/mixes/index.ts b/samples/openapi/api/v1/mixes/index.ts index 5029f9c2..f67e44c8 100644 --- a/samples/openapi/api/v1/mixes/index.ts +++ b/samples/openapi/api/v1/mixes/index.ts @@ -20,7 +20,7 @@ export type Methods = { reqBody: { name: string - title?: string + title?: string | undefined } } } diff --git a/samples/openapi/api/v1/parse/image/index.ts b/samples/openapi/api/v1/parse/image/index.ts index 82a79cc6..64b1a22a 100644 --- a/samples/openapi/api/v1/parse/image/index.ts +++ b/samples/openapi/api/v1/parse/image/index.ts @@ -15,8 +15,8 @@ export type Methods = { reqBody: { /** Image to upload. */ file: (File | ReadStream) - rightholder?: string - statusCopyright?: 'unknown' | 'cc' | 'licensed' | 'sublicensed' + rightholder?: string | undefined + statusCopyright?: 'unknown' | 'cc' | 'licensed' | 'sublicensed' | undefined } } } diff --git a/samples/openapi/api/v3/2fa/index.ts b/samples/openapi/api/v3/2fa/index.ts index 7e68b851..41c907e4 100644 --- a/samples/openapi/api/v3/2fa/index.ts +++ b/samples/openapi/api/v3/2fa/index.ts @@ -3,7 +3,7 @@ import type * as Types from '../../../@types' export type Methods = { post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationTokenRequired + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationTokenRequired | undefined status: 200 /** OK */ diff --git a/samples/openapi/api/v3/channels/_channelId@number/chats/_chatId@number/items/_itemId@number/index.ts b/samples/openapi/api/v3/channels/_channelId@number/chats/_chatId@number/items/_itemId@number/index.ts index 3cec1c1f..10812674 100644 --- a/samples/openapi/api/v3/channels/_channelId@number/chats/_chatId@number/items/_itemId@number/index.ts +++ b/samples/openapi/api/v3/channels/_channelId@number/chats/_chatId@number/items/_itemId@number/index.ts @@ -3,7 +3,7 @@ import type * as Types from '../../../../../../../../@types' export type Methods = { post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader | undefined status: 200 /** OK */ diff --git a/samples/openapi/api/v3/channels/_channelId@number/news-feed/index.ts b/samples/openapi/api/v3/channels/_channelId@number/news-feed/index.ts index 27250289..afd6e39e 100644 --- a/samples/openapi/api/v3/channels/_channelId@number/news-feed/index.ts +++ b/samples/openapi/api/v3/channels/_channelId@number/news-feed/index.ts @@ -3,15 +3,15 @@ import type * as Types from '../../../../../@types' export type Methods = { get: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken & Types.UserInstanceIdHeader + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken & Types.UserInstanceIdHeader | undefined query?: { /** date string or number of milliseconds */ - timestamp?: number - offset?: number - limit?: number - reverse?: boolean - } + timestamp?: number | undefined + offset?: number | undefined + limit?: number | undefined + reverse?: boolean | undefined + } | undefined status: 200 diff --git a/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/index.ts b/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/index.ts index 2080e78d..5b4ec7dd 100644 --- a/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/index.ts +++ b/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/index.ts @@ -4,7 +4,7 @@ import type * as Types from '../../../../../../@types' export type Methods = { /** Returns users chats in channel */ get: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 200 /** OK */ @@ -46,7 +46,7 @@ export type Methods = { /** Updates chat */ put: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 200 reqBody: { @@ -61,7 +61,7 @@ export type Methods = { /** Deletes chat */ delete: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 200 } } diff --git a/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/items/audio/index.ts b/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/items/audio/index.ts index 7238b128..5a8831d7 100644 --- a/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/items/audio/index.ts +++ b/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/items/audio/index.ts @@ -5,7 +5,7 @@ import type * as Types from '../../../../../../../../@types' export type Methods = { /** Create shared audio item in chat */ post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.UserTokenHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.UserTokenHeader & Types.AppOrganisationToken | undefined status: 200 /** OK */ @@ -18,12 +18,12 @@ export type Methods = { reqBody: { /** Audio to upload. */ file: (File | ReadStream) - caption?: string - headline?: string - imageId?: string - published?: boolean + caption?: string | undefined + headline?: string | undefined + imageId?: string | undefined + published?: boolean | undefined /** text message to send to pubnub */ - formattedText?: string + formattedText?: string | undefined } } } diff --git a/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/items/image/index.ts b/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/items/image/index.ts index 2d8b47e9..8e9ffcc3 100644 --- a/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/items/image/index.ts +++ b/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/items/image/index.ts @@ -5,7 +5,7 @@ import type * as Types from '../../../../../../../../@types' export type Methods = { /** Create shared image item in chat */ post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 200 /** OK */ @@ -18,11 +18,11 @@ export type Methods = { reqBody: { /** Image to upload. */ file: (File | ReadStream) - caption?: string - headline?: string - published?: boolean + caption?: string | undefined + headline?: string | undefined + published?: boolean | undefined /** text message to send to pubnub */ - formattedText?: string + formattedText?: string | undefined } } } diff --git a/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/items/index.ts b/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/items/index.ts index d840a569..b2cd7ee0 100644 --- a/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/items/index.ts +++ b/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/items/index.ts @@ -4,11 +4,11 @@ import type * as Types from '../../../../../../../@types' export type Methods = { /** Returns a list of items of chat shared content */ get: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken & Types.UserInstanceIdHeader + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken & Types.UserInstanceIdHeader | undefined query?: { - offset?: number - } + offset?: number | undefined + } | undefined status: 200 @@ -21,7 +21,7 @@ export type Methods = { /** Create shared item in chat */ post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 200 /** OK */ @@ -32,25 +32,25 @@ export type Methods = { /** item to create */ reqBody: { type: Types.CardEnumModel - title?: string - abstract?: string - sourceName?: string - image?: string - imageId?: string - quotePerson?: string - quote?: string - url?: string - quotePersonImageId?: string - quotePersonImage?: string - quoteSource?: string - quotePersonHandle?: string - videoId?: string - text?: string - headline?: string - quoteCreated?: string - published?: boolean + title?: string | undefined + abstract?: string | undefined + sourceName?: string | undefined + image?: string | undefined + imageId?: string | undefined + quotePerson?: string | undefined + quote?: string | undefined + url?: string | undefined + quotePersonImageId?: string | undefined + quotePersonImage?: string | undefined + quoteSource?: string | undefined + quotePersonHandle?: string | undefined + videoId?: string | undefined + text?: string | undefined + headline?: string | undefined + quoteCreated?: string | undefined + published?: boolean | undefined /** text message to send to pubnub */ - formattedText?: string + formattedText?: string | undefined } } } diff --git a/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/items/video/index.ts b/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/items/video/index.ts index cf2fc148..525ddd16 100644 --- a/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/items/video/index.ts +++ b/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/items/video/index.ts @@ -5,7 +5,7 @@ import type * as Types from '../../../../../../../../@types' export type Methods = { /** Create shared video item in chat */ post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 200 /** OK */ @@ -18,11 +18,11 @@ export type Methods = { reqBody: { /** Video to upload. */ file: (File | ReadStream) - caption?: string - headline?: string - published?: boolean + caption?: string | undefined + headline?: string | undefined + published?: boolean | undefined /** text message to send to pubnub */ - formattedText?: string + formattedText?: string | undefined } } } diff --git a/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/itemslist/index.ts b/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/itemslist/index.ts index 2709fcaa..64b52800 100644 --- a/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/itemslist/index.ts +++ b/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/itemslist/index.ts @@ -4,7 +4,7 @@ import type * as Types from '../../../../../../../@types' export type Methods = { /** Returns chat items by list of ids */ get: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined query: { /** coma separated ids of requested cards */ diff --git a/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/users/index.ts b/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/users/index.ts index 77733311..199d3acb 100644 --- a/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/users/index.ts +++ b/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/users/index.ts @@ -4,7 +4,7 @@ import type * as Types from '../../../../../../../@types' export type Methods = { /** Returns chat members with deleted */ get: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 200 /** OK */ resBody: { @@ -20,7 +20,7 @@ export type Methods = { /** Adds members to chat */ post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 201 reqBody: { @@ -35,7 +35,7 @@ export type Methods = { /** Updates chat members */ put: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 200 reqBody: { @@ -44,9 +44,9 @@ export type Methods = { /** User ID */ id: number /** It is only allowed to change self chatHidden property */ - chatHidden?: boolean + chatHidden?: boolean | undefined /** It is only allowed to change other members access (if current user has chat admin access) */ - access?: 'r' | 'rw' | 'admin' | 'banned' + access?: 'r' | 'rw' | 'admin' | 'banned' | undefined }[] } } diff --git a/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/users/remove/index.ts b/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/users/remove/index.ts index 9d5097c5..ddd11dd0 100644 --- a/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/users/remove/index.ts +++ b/samples/openapi/api/v3/channels/_channelId@string/chats/_chatId@string/users/remove/index.ts @@ -4,7 +4,7 @@ import type * as Types from '../../../../../../../../@types' export type Methods = { /** Removes members from chat */ post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 200 reqBody: { diff --git a/samples/openapi/api/v3/channels/_channelId@string/chats/index.ts b/samples/openapi/api/v3/channels/_channelId@string/chats/index.ts index c9c3870a..fdea1150 100644 --- a/samples/openapi/api/v3/channels/_channelId@string/chats/index.ts +++ b/samples/openapi/api/v3/channels/_channelId@string/chats/index.ts @@ -4,7 +4,7 @@ import type * as Types from '../../../../../@types' export type Methods = { /** Returns users chats in channel */ get: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken & Types.UserPublicKey & Types.UserSignedChallenge + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken & Types.UserPublicKey & Types.UserSignedChallenge | undefined status: 200 /** OK */ @@ -58,7 +58,7 @@ export type Methods = { /** Creates chat */ post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 201 /** OK */ @@ -100,13 +100,13 @@ export type Methods = { type: 'p2p' | 'group' level: 'channel' | 'organisation' accessType: 'private' | 'publicRead' | 'publicWrite' - payload?: string + payload?: string | undefined /** Mix to pin */ - storyId?: number + storyId?: number | undefined /** Card to pin */ - itemId?: number + itemId?: number | undefined /** Array of users to add with 'rw' rights (without you). If type = 'p2p' should contain only one item */ - users?: number[] + users?: number[] | undefined } } } diff --git a/samples/openapi/api/v3/channels/_channelId@string/index.ts b/samples/openapi/api/v3/channels/_channelId@string/index.ts index 3b570365..89854a52 100644 --- a/samples/openapi/api/v3/channels/_channelId@string/index.ts +++ b/samples/openapi/api/v3/channels/_channelId@string/index.ts @@ -4,12 +4,12 @@ import type * as Types from '../../../../@types' export type Methods = { /** Returns a list of channel mixes with pre-fetching their contents */ get: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken & Types.UserInstanceIdHeader + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken & Types.UserInstanceIdHeader | undefined query?: { - excludeItems?: boolean - excludePinned?: boolean - } + excludeItems?: boolean | undefined + excludePinned?: boolean | undefined + } | undefined status: 200 } diff --git a/samples/openapi/api/v3/channels/_channelId@string/notifications/index.ts b/samples/openapi/api/v3/channels/_channelId@string/notifications/index.ts index 1ec95789..3b9dd934 100644 --- a/samples/openapi/api/v3/channels/_channelId@string/notifications/index.ts +++ b/samples/openapi/api/v3/channels/_channelId@string/notifications/index.ts @@ -3,12 +3,12 @@ import type * as Types from '../../../../../@types' export type Methods = { get: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined query?: { - published?: boolean - offset?: number - } + published?: boolean | undefined + offset?: number | undefined + } | undefined status: 200 diff --git a/samples/openapi/api/v3/channels/index.ts b/samples/openapi/api/v3/channels/index.ts index d19ff25f..422f89d8 100644 --- a/samples/openapi/api/v3/channels/index.ts +++ b/samples/openapi/api/v3/channels/index.ts @@ -3,12 +3,12 @@ import type * as Types from '../../../@types' export type Methods = { get: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined query?: { - unpublished?: boolean - 'read-only'?: boolean - } + unpublished?: boolean | undefined + 'read-only'?: boolean | undefined + } | undefined status: 200 /** OK */ @@ -21,10 +21,10 @@ export type Methods = { url: string ownerEmail: string ownerName: string - organisationName?: string + organisationName?: string | undefined ownerId: number organisationId: number - pinnedStoryId?: number + pinnedStoryId?: number | undefined stories: { id: number title: number diff --git a/samples/openapi/api/v3/chats/_chatId@number/items/_itemId@number/index.ts b/samples/openapi/api/v3/chats/_chatId@number/items/_itemId@number/index.ts index 2c3b236c..6551bb1e 100644 --- a/samples/openapi/api/v3/chats/_chatId@number/items/_itemId@number/index.ts +++ b/samples/openapi/api/v3/chats/_chatId@number/items/_itemId@number/index.ts @@ -3,7 +3,7 @@ import type * as Types from '../../../../../../@types' export type Methods = { post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader | undefined status: 200 /** OK */ @@ -17,7 +17,7 @@ export type Methods = { } get: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken & Types.UserInstanceIdHeader + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken & Types.UserInstanceIdHeader | undefined status: 200 /** OK */ resBody: Types.ModelCard diff --git a/samples/openapi/api/v3/chats/_chatId@string/items/audio/index.ts b/samples/openapi/api/v3/chats/_chatId@string/items/audio/index.ts index 613b170c..419ba1de 100644 --- a/samples/openapi/api/v3/chats/_chatId@string/items/audio/index.ts +++ b/samples/openapi/api/v3/chats/_chatId@string/items/audio/index.ts @@ -5,7 +5,7 @@ import type * as Types from '../../../../../../@types' export type Methods = { /** Create shared audio item in chat */ post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.UserTokenHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.UserTokenHeader & Types.AppOrganisationToken | undefined status: 200 /** OK */ @@ -18,12 +18,12 @@ export type Methods = { reqBody: { /** Audio to upload. */ file: (File | ReadStream) - caption?: string - headline?: string - imageId?: string - published?: boolean + caption?: string | undefined + headline?: string | undefined + imageId?: string | undefined + published?: boolean | undefined /** text message to send to pubnub */ - formattedText?: string + formattedText?: string | undefined } } } diff --git a/samples/openapi/api/v3/chats/_chatId@string/items/image/index.ts b/samples/openapi/api/v3/chats/_chatId@string/items/image/index.ts index 4ada0a49..716bec88 100644 --- a/samples/openapi/api/v3/chats/_chatId@string/items/image/index.ts +++ b/samples/openapi/api/v3/chats/_chatId@string/items/image/index.ts @@ -5,7 +5,7 @@ import type * as Types from '../../../../../../@types' export type Methods = { /** Create shared image item in chat */ post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 200 /** OK */ @@ -18,11 +18,11 @@ export type Methods = { reqBody: { /** Image to upload. */ file: (File | ReadStream) - caption?: string - headline?: string - published?: boolean + caption?: string | undefined + headline?: string | undefined + published?: boolean | undefined /** text message to send to pubnub */ - formattedText?: string + formattedText?: string | undefined } } } diff --git a/samples/openapi/api/v3/chats/_chatId@string/items/index.ts b/samples/openapi/api/v3/chats/_chatId@string/items/index.ts index 024b6c5c..b81bab07 100644 --- a/samples/openapi/api/v3/chats/_chatId@string/items/index.ts +++ b/samples/openapi/api/v3/chats/_chatId@string/items/index.ts @@ -4,13 +4,13 @@ import type * as Types from '../../../../../@types' export type Methods = { /** Returns a list of items of chat shared content */ get: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken & Types.UserInstanceIdHeader + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken & Types.UserInstanceIdHeader | undefined query?: { - offset?: number + offset?: number | undefined /** coma separated ids of requested cards */ - ids?: string - } + ids?: string | undefined + } | undefined status: 200 @@ -23,7 +23,7 @@ export type Methods = { /** Create shared item in chat */ post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 200 /** OK */ @@ -34,25 +34,25 @@ export type Methods = { /** item to create */ reqBody: { type: Types.CardEnumModel - title?: string - abstract?: string - sourceName?: string - image?: string - imageId?: string - quotePerson?: string - quote?: string - url?: string - quotePersonImageId?: string - quotePersonImage?: string - quoteSource?: string - quotePersonHandle?: string - videoId?: string - text?: string - headline?: string - quoteCreated?: string - published?: boolean + title?: string | undefined + abstract?: string | undefined + sourceName?: string | undefined + image?: string | undefined + imageId?: string | undefined + quotePerson?: string | undefined + quote?: string | undefined + url?: string | undefined + quotePersonImageId?: string | undefined + quotePersonImage?: string | undefined + quoteSource?: string | undefined + quotePersonHandle?: string | undefined + videoId?: string | undefined + text?: string | undefined + headline?: string | undefined + quoteCreated?: string | undefined + published?: boolean | undefined /** text message to send to pubnub */ - formattedText?: string + formattedText?: string | undefined } } } diff --git a/samples/openapi/api/v3/chats/_chatId@string/items/video/index.ts b/samples/openapi/api/v3/chats/_chatId@string/items/video/index.ts index 4b87e734..56567ed8 100644 --- a/samples/openapi/api/v3/chats/_chatId@string/items/video/index.ts +++ b/samples/openapi/api/v3/chats/_chatId@string/items/video/index.ts @@ -5,7 +5,7 @@ import type * as Types from '../../../../../../@types' export type Methods = { /** Create shared video item in chat */ post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 200 /** OK */ @@ -18,11 +18,11 @@ export type Methods = { reqBody: { /** Video to upload. */ file: (File | ReadStream) - caption?: string - headline?: string - published?: boolean + caption?: string | undefined + headline?: string | undefined + published?: boolean | undefined /** text message to send to pubnub */ - formattedText?: string + formattedText?: string | undefined } } } diff --git a/samples/openapi/api/v3/chats/keys/index.ts b/samples/openapi/api/v3/chats/keys/index.ts index 738d3c69..969e39d3 100644 --- a/samples/openapi/api/v3/chats/keys/index.ts +++ b/samples/openapi/api/v3/chats/keys/index.ts @@ -4,7 +4,7 @@ import type * as Types from '../../../../@types' export type Methods = { /** Returns valid pubnub keys and auth token, refreshes tokens and access if needed */ get: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken & Types.UserPublicKey & Types.UserSignedChallenge + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken & Types.UserPublicKey & Types.UserSignedChallenge | undefined status: 200 /** OK */ diff --git a/samples/openapi/api/v3/extension/audio/index.ts b/samples/openapi/api/v3/extension/audio/index.ts index 7d3cfb47..215e3272 100644 --- a/samples/openapi/api/v3/extension/audio/index.ts +++ b/samples/openapi/api/v3/extension/audio/index.ts @@ -4,7 +4,7 @@ import type * as Types from '../../../../@types' export type Methods = { post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 200 /** OK */ diff --git a/samples/openapi/api/v3/extension/image/index.ts b/samples/openapi/api/v3/extension/image/index.ts index ceb6ba0d..f62c9ed9 100644 --- a/samples/openapi/api/v3/extension/image/index.ts +++ b/samples/openapi/api/v3/extension/image/index.ts @@ -4,14 +4,14 @@ import type * as Types from '../../../../@types' export type Methods = { post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 200 /** OK */ resBody: { id: string - width?: number - height?: number + width?: number | undefined + height?: number | undefined } reqFormat: FormData diff --git a/samples/openapi/api/v3/extension/parse/index.ts b/samples/openapi/api/v3/extension/parse/index.ts index 6dfd6126..1cf38227 100644 --- a/samples/openapi/api/v3/extension/parse/index.ts +++ b/samples/openapi/api/v3/extension/parse/index.ts @@ -3,20 +3,20 @@ import type * as Types from '../../../../@types' export type Methods = { post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader | undefined status: 200 /** OK */ resBody: { type: Types.CardEnumModel url: string - sourceName?: string - abstract?: string - quotePerson?: string - quotePersonHandle?: string - quote?: string - quoteSource?: string - quoteCreated?: string + sourceName?: string | undefined + abstract?: string | undefined + quotePerson?: string | undefined + quotePersonHandle?: string | undefined + quote?: string | undefined + quoteSource?: string | undefined + quoteCreated?: string | undefined } reqBody: { diff --git a/samples/openapi/api/v3/extension/story/_storyId@string/audio/index.ts b/samples/openapi/api/v3/extension/story/_storyId@string/audio/index.ts index af92a504..f58742ea 100644 --- a/samples/openapi/api/v3/extension/story/_storyId@string/audio/index.ts +++ b/samples/openapi/api/v3/extension/story/_storyId@string/audio/index.ts @@ -4,7 +4,7 @@ import type * as Types from '../../../../../../@types' export type Methods = { post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 200 /** OK */ @@ -17,11 +17,11 @@ export type Methods = { reqBody: { /** Audio to upload. */ file: (File | ReadStream) - caption?: string - headline?: string - text?: string - imageId?: string - published?: boolean + caption?: string | undefined + headline?: string | undefined + text?: string | undefined + imageId?: string | undefined + published?: boolean | undefined } } } diff --git a/samples/openapi/api/v3/extension/story/_storyId@string/image/index.ts b/samples/openapi/api/v3/extension/story/_storyId@string/image/index.ts index 05d6d16a..0d9beb38 100644 --- a/samples/openapi/api/v3/extension/story/_storyId@string/image/index.ts +++ b/samples/openapi/api/v3/extension/story/_storyId@string/image/index.ts @@ -4,7 +4,7 @@ import type * as Types from '../../../../../../@types' export type Methods = { post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 200 /** OK */ @@ -17,10 +17,10 @@ export type Methods = { reqBody: { /** Image to upload. */ file: (File | ReadStream) - caption?: string - headline?: string - text?: string - published?: boolean + caption?: string | undefined + headline?: string | undefined + text?: string | undefined + published?: boolean | undefined } } } diff --git a/samples/openapi/api/v3/extension/story/_storyId@string/index.ts b/samples/openapi/api/v3/extension/story/_storyId@string/index.ts index 6cd8390f..6f107b9c 100644 --- a/samples/openapi/api/v3/extension/story/_storyId@string/index.ts +++ b/samples/openapi/api/v3/extension/story/_storyId@string/index.ts @@ -4,7 +4,7 @@ import type * as Types from '../../../../../@types' export type Methods = { post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 200 /** OK */ @@ -16,27 +16,27 @@ export type Methods = { reqBody: { type: Types.CardEnumModel - caption?: string - title?: string - abstract?: string - sourceName?: string - image?: string - imageId?: number - quotePerson?: string - quote?: string - url?: string - quotePersonImageId?: number - quotePersonImage?: string - quoteSource?: string - quotePersonHandle?: string - videoId?: number - video?: (File | ReadStream) - audioId?: number - audio?: (File | ReadStream) - text?: string - headline?: string - quoteCreated?: string - published?: boolean + caption?: string | undefined + title?: string | undefined + abstract?: string | undefined + sourceName?: string | undefined + image?: string | undefined + imageId?: number | undefined + quotePerson?: string | undefined + quote?: string | undefined + url?: string | undefined + quotePersonImageId?: number | undefined + quotePersonImage?: string | undefined + quoteSource?: string | undefined + quotePersonHandle?: string | undefined + videoId?: number | undefined + video?: (File | ReadStream) | undefined + audioId?: number | undefined + audio?: (File | ReadStream) | undefined + text?: string | undefined + headline?: string | undefined + quoteCreated?: string | undefined + published?: boolean | undefined } } } diff --git a/samples/openapi/api/v3/extension/story/_storyId@string/video/index.ts b/samples/openapi/api/v3/extension/story/_storyId@string/video/index.ts index a7e96852..498574d3 100644 --- a/samples/openapi/api/v3/extension/story/_storyId@string/video/index.ts +++ b/samples/openapi/api/v3/extension/story/_storyId@string/video/index.ts @@ -4,7 +4,7 @@ import type * as Types from '../../../../../../@types' export type Methods = { post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 200 /** OK */ @@ -17,10 +17,10 @@ export type Methods = { reqBody: { /** Video to upload. */ file: (File | ReadStream) - caption?: string - headline?: string - text?: string - published?: boolean + caption?: string | undefined + headline?: string | undefined + text?: string | undefined + published?: boolean | undefined } } } diff --git a/samples/openapi/api/v3/extension/video/index.ts b/samples/openapi/api/v3/extension/video/index.ts index 21cfcf7e..5606030a 100644 --- a/samples/openapi/api/v3/extension/video/index.ts +++ b/samples/openapi/api/v3/extension/video/index.ts @@ -4,14 +4,14 @@ import type * as Types from '../../../../@types' export type Methods = { post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 200 /** OK */ resBody: { id: string - width?: number - height?: number + width?: number | undefined + height?: number | undefined } reqFormat: FormData diff --git a/samples/openapi/api/v3/fcm_token/index.ts b/samples/openapi/api/v3/fcm_token/index.ts index b42b5cc6..d1d4d6f3 100644 --- a/samples/openapi/api/v3/fcm_token/index.ts +++ b/samples/openapi/api/v3/fcm_token/index.ts @@ -4,12 +4,12 @@ import type * as Types from '../../../@types' export type Methods = { /** Save newly updated firebase cloud messaging device token */ post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 204 reqBody: { fcmToken: string - deviceToken?: string + deviceToken?: string | undefined } } } diff --git a/samples/openapi/api/v3/info/index.ts b/samples/openapi/api/v3/info/index.ts index 43bb47e5..7d0b88fc 100644 --- a/samples/openapi/api/v3/info/index.ts +++ b/samples/openapi/api/v3/info/index.ts @@ -4,7 +4,7 @@ import type * as Types from '../../../@types' export type Methods = { /** Send in to about app to server. If app is to old and need be force updated in responce you have link to new app */ get: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader | undefined status: 200 /** OK */ diff --git a/samples/openapi/api/v3/login/index.ts b/samples/openapi/api/v3/login/index.ts index cd1368a4..3403eaa4 100644 --- a/samples/openapi/api/v3/login/index.ts +++ b/samples/openapi/api/v3/login/index.ts @@ -3,21 +3,21 @@ import type * as Types from '../../../@types' export type Methods = { post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 200 /** OK */ resBody: Types.UserInfo & { token: string - settings?: Types.$200_UserSettings + settings?: Types.$200_UserSettings | undefined } reqBody: { pwd: string email: string - fcmToken?: string - deviceToken?: string - otp?: number + fcmToken?: string | undefined + deviceToken?: string | undefined + otp?: number | undefined } } } diff --git a/samples/openapi/api/v3/logout/index.ts b/samples/openapi/api/v3/logout/index.ts index 74a00753..b1f5cd68 100644 --- a/samples/openapi/api/v3/logout/index.ts +++ b/samples/openapi/api/v3/logout/index.ts @@ -3,7 +3,7 @@ import type * as Types from '../../../@types' export type Methods = { post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 204 reqBody: { diff --git a/samples/openapi/api/v3/me/index.ts b/samples/openapi/api/v3/me/index.ts index b56bbe4b..55f13788 100644 --- a/samples/openapi/api/v3/me/index.ts +++ b/samples/openapi/api/v3/me/index.ts @@ -3,12 +3,12 @@ import type * as Types from '../../../@types' export type Methods = { get: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 200 /** OK */ resBody: Types.UserInfo & { - settings?: Types.$200_UserSettings + settings?: Types.$200_UserSettings | undefined } } } diff --git a/samples/openapi/api/v3/organisation/index.ts b/samples/openapi/api/v3/organisation/index.ts index b4cb0aa2..f200d0e2 100644 --- a/samples/openapi/api/v3/organisation/index.ts +++ b/samples/openapi/api/v3/organisation/index.ts @@ -3,7 +3,7 @@ import type * as Types from '../../../@types' export type Methods = { get: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationTokenRequired + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationTokenRequired | undefined status: 200 /** OK */ resBody: Types.OrganisationModel diff --git a/samples/openapi/api/v3/organisation/users/index.ts b/samples/openapi/api/v3/organisation/users/index.ts index fcf28143..072ff155 100644 --- a/samples/openapi/api/v3/organisation/users/index.ts +++ b/samples/openapi/api/v3/organisation/users/index.ts @@ -3,11 +3,11 @@ import type * as Types from '../../../../@types' export type Methods = { get: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationTokenRequired + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationTokenRequired | undefined query: { search: string - offset?: number + offset?: number | undefined } status: 200 @@ -15,7 +15,7 @@ export type Methods = { /** OK */ resBody: { count: number - offset?: number + offset?: number | undefined data: { email: string id: number diff --git a/samples/openapi/api/v3/stories/_storyId@number/items/_itemId@number/index.ts b/samples/openapi/api/v3/stories/_storyId@number/items/_itemId@number/index.ts index e6197afd..ac749725 100644 --- a/samples/openapi/api/v3/stories/_storyId@number/items/_itemId@number/index.ts +++ b/samples/openapi/api/v3/stories/_storyId@number/items/_itemId@number/index.ts @@ -3,7 +3,7 @@ import type * as Types from '../../../../../../@types' export type Methods = { get: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken & Types.UserInstanceIdHeader + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken & Types.UserInstanceIdHeader | undefined status: 200 /** OK */ resBody: Types.ModelCard diff --git a/samples/openapi/api/v3/stories/_storyId@number/items/_itemId@number/reaction/index.ts b/samples/openapi/api/v3/stories/_storyId@number/items/_itemId@number/reaction/index.ts index efa1136a..5a1e6b24 100644 --- a/samples/openapi/api/v3/stories/_storyId@number/items/_itemId@number/reaction/index.ts +++ b/samples/openapi/api/v3/stories/_storyId@number/items/_itemId@number/reaction/index.ts @@ -3,7 +3,7 @@ import type * as Types from '../../../../../../../@types' export type Methods = { post: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken & Types.UserInstanceIdHeader + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken & Types.UserInstanceIdHeader | undefined status: 200 /** OK */ @@ -19,7 +19,7 @@ export type Methods = { } reqBody: { - reaction?: Types.ReactionEnumModel + reaction?: Types.ReactionEnumModel | undefined } } } diff --git a/samples/openapi/api/v3/stories/_storyId@number/items/index.ts b/samples/openapi/api/v3/stories/_storyId@number/items/index.ts index 3aeb69a1..49f0429f 100644 --- a/samples/openapi/api/v3/stories/_storyId@number/items/index.ts +++ b/samples/openapi/api/v3/stories/_storyId@number/items/index.ts @@ -4,11 +4,11 @@ import type * as Types from '../../../../../@types' export type Methods = { /** Returns a story content with support pagination */ get: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken & Types.UserInstanceIdHeader + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken & Types.UserInstanceIdHeader | undefined query?: { - offset?: number - } + offset?: number | undefined + } | undefined status: 200 diff --git a/samples/openapi/api/v3/user/_userId@string/index.ts b/samples/openapi/api/v3/user/_userId@string/index.ts index b4919d39..54da67b1 100644 --- a/samples/openapi/api/v3/user/_userId@string/index.ts +++ b/samples/openapi/api/v3/user/_userId@string/index.ts @@ -3,7 +3,7 @@ import type * as Types from '../../../../@types' export type Methods = { get: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 200 /** OK */ resBody: Types.UserInfo diff --git a/samples/openapi/api/v3/user/index.ts b/samples/openapi/api/v3/user/index.ts index c7cd73b4..5408fd9e 100644 --- a/samples/openapi/api/v3/user/index.ts +++ b/samples/openapi/api/v3/user/index.ts @@ -3,7 +3,7 @@ import type * as Types from '../../../@types' export type Methods = { get: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader & Types.AppOrganisationToken | undefined status: 200 /** OK */ resBody: Types.UserInfo[] diff --git a/samples/openapi/api/v3/user/profile/index.ts b/samples/openapi/api/v3/user/profile/index.ts index 8adb5bbe..6428b086 100644 --- a/samples/openapi/api/v3/user/profile/index.ts +++ b/samples/openapi/api/v3/user/profile/index.ts @@ -4,7 +4,7 @@ import type * as Types from '../../../../@types' export type Methods = { put: { - reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader + reqHeaders?: Types.AppIdHeader & Types.AppPlatformHeader & Types.AppVersionHeader | undefined status: 204 reqFormat: FormData diff --git a/samples/path-at-mark/@types/index.ts b/samples/path-at-mark/@types/index.ts index 5ab4e2bd..b83abcef 100644 --- a/samples/path-at-mark/@types/index.ts +++ b/samples/path-at-mark/@types/index.ts @@ -1,4 +1,4 @@ /* eslint-disable */ export type User = { - id?: string + id?: string | undefined } diff --git a/samples/simple/@types/index.ts b/samples/simple/@types/index.ts index 25efe561..2077da46 100644 --- a/samples/simple/@types/index.ts +++ b/samples/simple/@types/index.ts @@ -2,11 +2,11 @@ /** Customer */ export type Customer = { /** ID */ - id?: number + id?: number | undefined /** NAME */ - name?: string + name?: string | undefined /** Type of pet 1:dog 2:cat 3:other */ - pet?: 1 | 2 | 3 + pet?: 1 | 2 | 3 | undefined } /** Customer */ @@ -16,7 +16,7 @@ export type Customer2 = { /** NAME */ name: string /** Type of pet 1:dog 2:cat 3:other */ - pet?: 1 | 2 | 3 + pet?: 1 | 2 | 3 | undefined } /** Customer */ diff --git a/samples/simple/dummy/_id@number/query/index.ts b/samples/simple/dummy/_id@number/query/index.ts index a0028355..6a49bbfb 100644 --- a/samples/simple/dummy/_id@number/query/index.ts +++ b/samples/simple/dummy/_id@number/query/index.ts @@ -3,8 +3,8 @@ export type Methods = { put: { query?: { /** query */ - q?: string - } + q?: string | undefined + } | undefined status: 202 } diff --git a/samples/simple/file/_id@number/upload/index.ts b/samples/simple/file/_id@number/upload/index.ts index 7ec7b30f..3fb9cde9 100644 --- a/samples/simple/file/_id@number/upload/index.ts +++ b/samples/simple/file/_id@number/upload/index.ts @@ -4,8 +4,8 @@ import type { ReadStream } from 'fs' export type Methods = { post: { query?: { - path?: string - } + path?: string | undefined + } | undefined status: 204 reqBody: (File | ReadStream) diff --git a/samples/simple/user/_id@number/2/index.ts b/samples/simple/user/_id@number/2/index.ts index 42f77c45..f1405166 100644 --- a/samples/simple/user/_id@number/2/index.ts +++ b/samples/simple/user/_id@number/2/index.ts @@ -3,7 +3,7 @@ export type Methods = { get: { query: { path: string - '123456789123456789123456789123456789'?: string + '123456789123456789123456789123456789'?: string | undefined } status: 200 @@ -20,7 +20,7 @@ export type Methods = { post: { query: { path: string - '123456789123456789123456789123456789'?: string + '123456789123456789123456789123456789'?: string | undefined } status: 200 @@ -30,7 +30,7 @@ export type Methods = { /** ID */ id: number /** NAME */ - name?: string + name?: string | undefined } } } diff --git a/samples/simple/user/_id@number/abc/index.ts b/samples/simple/user/_id@number/abc/index.ts index bfae934b..0705886c 100644 --- a/samples/simple/user/_id@number/abc/index.ts +++ b/samples/simple/user/_id@number/abc/index.ts @@ -2,8 +2,8 @@ export type Methods = { get: { query?: { - q?: string - } + q?: string | undefined + } | undefined status: 202 } diff --git a/samples/strapi/@types/index.ts b/samples/strapi/@types/index.ts index d24a1827..e2b3e789 100644 --- a/samples/strapi/@types/index.ts +++ b/samples/strapi/@types/index.ts @@ -2,65 +2,65 @@ export type Users_PermissionsRole = { id: string name: string - description?: string - type?: string + description?: string | undefined + type?: string | undefined permissions?: { id: string type: string controller: string action: string enabled: boolean - policy?: string - role?: string - }[] + policy?: string | undefined + role?: string | undefined + }[] | undefined users?: { id: string username: string email: string - provider?: string - password?: string - resetPasswordToken?: string - confirmed?: boolean - blocked?: boolean - role?: string - }[] + provider?: string | undefined + password?: string | undefined + resetPasswordToken?: string | undefined + confirmed?: boolean | undefined + blocked?: boolean | undefined + role?: string | undefined + }[] | undefined } export type NewUsers_PermissionsRole = { name: string - description?: string - type?: string - permissions?: string[] - users?: string[] + description?: string | undefined + type?: string | undefined + permissions?: string[] | undefined + users?: string[] | undefined } export type Users_PermissionsUser = { id: string username: string email: string - provider?: string - confirmed?: boolean - blocked?: boolean + provider?: string | undefined + confirmed?: boolean | undefined + blocked?: boolean | undefined role?: { id: string name: string - description?: string - type?: string - permissions?: string[] - users?: string[] - } + description?: string | undefined + type?: string | undefined + permissions?: string[] | undefined + users?: string[] | undefined + } | undefined } export type NewUsers_PermissionsUser = { username: string email: string - provider?: string - password?: string - resetPasswordToken?: string - confirmed?: boolean - blocked?: boolean - role?: string + provider?: string | undefined + password?: string | undefined + resetPasswordToken?: string | undefined + confirmed?: boolean | undefined + blocked?: boolean | undefined + role?: string | undefined } export type Error = { diff --git a/samples/strapi/users-permissions/roles/index.ts b/samples/strapi/users-permissions/roles/index.ts index e569fc63..ac17eb97 100644 --- a/samples/strapi/users-permissions/roles/index.ts +++ b/samples/strapi/users-permissions/roles/index.ts @@ -6,32 +6,32 @@ export type Methods = { get: { query?: { /** Maximum number of results possible */ - _limit?: number + _limit?: number | undefined /** Sort according to a specific field. */ - _sort?: string + _sort?: string | undefined /** Skip a specific number of entries (especially useful for pagination) */ - _start?: number + _start?: number | undefined /** Get entries that matches exactly your input */ - '='?: string + '='?: string | undefined /** Get records that are not equals to something */ - _ne?: string + _ne?: string | undefined /** Get record that are lower than a value */ - _lt?: string + _lt?: string | undefined /** Get records that are lower than or equal to a value */ - _lte?: string + _lte?: string | undefined /** Get records that are greater than a value */ - _gt?: string + _gt?: string | undefined /** Get records that are greater than or equal a value */ - _gte?: string + _gte?: string | undefined /** Get records that contains a value */ - _contains?: string + _contains?: string | undefined /** Get records that contains (case sensitive) a value */ - _containss?: string + _containss?: string | undefined /** Get records that matches any value in the array of values */ - _in?: string[] + _in?: string[] | undefined /** Get records that doesn't match any value in the array of values */ - _nin?: string[] - } + _nin?: string[] | undefined + } | undefined status: 200 /** response */ diff --git a/samples/strapi/users-permissions/search/_id@string/index.ts b/samples/strapi/users-permissions/search/_id@string/index.ts index 756b0625..15b4845d 100644 --- a/samples/strapi/users-permissions/search/_id@string/index.ts +++ b/samples/strapi/users-permissions/search/_id@string/index.ts @@ -6,32 +6,32 @@ export type Methods = { get: { query?: { /** Maximum number of results possible */ - _limit?: number + _limit?: number | undefined /** Sort according to a specific field. */ - _sort?: string + _sort?: string | undefined /** Skip a specific number of entries (especially useful for pagination) */ - _start?: number + _start?: number | undefined /** Get entries that matches exactly your input */ - '='?: string + '='?: string | undefined /** Get records that are not equals to something */ - _ne?: string + _ne?: string | undefined /** Get record that are lower than a value */ - _lt?: string + _lt?: string | undefined /** Get records that are lower than or equal to a value */ - _lte?: string + _lte?: string | undefined /** Get records that are greater than a value */ - _gt?: string + _gt?: string | undefined /** Get records that are greater than or equal a value */ - _gte?: string + _gte?: string | undefined /** Get records that contains a value */ - _contains?: string + _contains?: string | undefined /** Get records that contains (case sensitive) a value */ - _containss?: string + _containss?: string | undefined /** Get records that matches any value in the array of values */ - _in?: string[] + _in?: string[] | undefined /** Get records that doesn't match any value in the array of values */ - _nin?: string[] - } + _nin?: string[] | undefined + } | undefined status: 200 /** response */ diff --git a/samples/strapi/users/index.ts b/samples/strapi/users/index.ts index 1f11ce43..b33eb3f5 100644 --- a/samples/strapi/users/index.ts +++ b/samples/strapi/users/index.ts @@ -6,32 +6,32 @@ export type Methods = { get: { query?: { /** Maximum number of results possible */ - _limit?: number + _limit?: number | undefined /** Sort according to a specific field. */ - _sort?: string + _sort?: string | undefined /** Skip a specific number of entries (especially useful for pagination) */ - _start?: number + _start?: number | undefined /** Get entries that matches exactly your input */ - '='?: string + '='?: string | undefined /** Get records that are not equals to something */ - _ne?: string + _ne?: string | undefined /** Get record that are lower than a value */ - _lt?: string + _lt?: string | undefined /** Get records that are lower than or equal to a value */ - _lte?: string + _lte?: string | undefined /** Get records that are greater than a value */ - _gt?: string + _gt?: string | undefined /** Get records that are greater than or equal a value */ - _gte?: string + _gte?: string | undefined /** Get records that contains a value */ - _contains?: string + _contains?: string | undefined /** Get records that contains (case sensitive) a value */ - _containss?: string + _containss?: string | undefined /** Get records that matches any value in the array of values */ - _in?: string[] + _in?: string[] | undefined /** Get records that doesn't match any value in the array of values */ - _nin?: string[] - } + _nin?: string[] | undefined + } | undefined status: 200 /** response */ diff --git a/samples/swagger/@types/index.ts b/samples/swagger/@types/index.ts index 32ef7f8b..443093e5 100644 --- a/samples/swagger/@types/index.ts +++ b/samples/swagger/@types/index.ts @@ -1,48 +1,48 @@ /* eslint-disable */ export type Category = { - id?: number - name?: string + id?: number | undefined + name?: string | undefined } export type Pet = { - id?: number - category?: Category + id?: number | undefined + category?: Category | undefined name: string photoUrls: string[] - tags?: Tag[] + tags?: Tag[] | undefined /** pet status in the store */ - status?: 'available' | 'pending' | 'sold' + status?: 'available' | 'pending' | 'sold' | undefined } export type Tag = { - id?: number - name?: string + id?: number | undefined + name?: string | undefined } export type ApiResponse = { - code?: number - type?: string - message?: string + code?: number | undefined + type?: string | undefined + message?: string | undefined } export type Order = { - id?: number - petId?: number - quantity?: number - shipDate?: string + id?: number | undefined + petId?: number | undefined + quantity?: number | undefined + shipDate?: string | undefined /** Order Status */ - status?: 'placed' | 'approved' | 'delivered' - complete?: boolean + status?: 'placed' | 'approved' | 'delivered' | undefined + complete?: boolean | undefined } export type User = { - id?: number - username?: string - firstName?: string - lastName?: string - email?: string - password?: string - phone?: string + id?: number | undefined + username?: string | undefined + firstName?: string | undefined + lastName?: string | undefined + email?: string | undefined + password?: string | undefined + phone?: string | undefined /** User Status */ - userStatus?: number + userStatus?: number | undefined } diff --git a/samples/swagger/hello/index.ts b/samples/swagger/hello/index.ts index 9117656c..228eb08b 100644 --- a/samples/swagger/hello/index.ts +++ b/samples/swagger/hello/index.ts @@ -3,8 +3,8 @@ export type Methods = { get: { query?: { /** defaults to World if not given */ - name?: string - } + name?: string | undefined + } | undefined status: 200 /** returns a greeting */ diff --git a/samples/swagger/pet/_petId@number/index.ts b/samples/swagger/pet/_petId@number/index.ts index 25069ce3..d43a31e0 100644 --- a/samples/swagger/pet/_petId@number/index.ts +++ b/samples/swagger/pet/_petId@number/index.ts @@ -22,7 +22,7 @@ export type Methods = { delete: { reqHeaders?: { - api_key?: string - } + api_key?: string | undefined + } | undefined } } diff --git a/src/builderUtils/props2String.ts b/src/builderUtils/props2String.ts index 8c830426..7859ba66 100644 --- a/src/builderUtils/props2String.ts +++ b/src/builderUtils/props2String.ts @@ -56,14 +56,14 @@ export const description2Doc = (desc: string | null, indent: string) => { export const props2String = (props: Prop[], indent: string) => `{\n${props - .map( - (p, i) => + .map((p, i) => + (opt => `${description2Doc(p.description, ` ${indent}`)} ${indent}${p.name}${ - p.required ? '' : '?' - }: ${values2String(p.values, undefined, indent)}${ + opt ? '?' : '' + }: ${values2String(p.values, undefined, indent)}${opt ? ' | undefined' : ''}${ props.length - 1 === i || isMultiLine(p.values) || isMultiLine(props[i + 1].values) ? '\n' : '' - }` + }`)(!p.required) ) .join('\n')}${indent}}`