@opusdns/api 0.171.0 → 0.173.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^0.19.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "0.171.0",
6
+ "version": "0.173.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -156,8 +156,12 @@ import { OrganizationToken } from './schemas';
156
156
  import { OrganizationUpdate } from './schemas';
157
157
  import { OrganizationWithBillingData } from './schemas';
158
158
  import { PaginationMetadata } from './schemas';
159
+ import { ParkingAgreementAcceptance } from './schemas';
159
160
  import { ParkingMetrics } from './schemas';
160
161
  import { Parking } from './schemas';
162
+ import { ParkingSignupRequest } from './schemas';
163
+ import { ParkingSignup } from './schemas';
164
+ import { ParkingSignupStatus } from './schemas';
161
165
  import { ParkingStatistics } from './schemas';
162
166
  import { ParkingTotalMetrics } from './schemas';
163
167
  import { PasswordUpdate } from './schemas';
@@ -6771,6 +6775,30 @@ export const KEY_DOMAIN_FORWARD_HTTP: keyof DomainForward = 'http';
6771
6775
  * @see {@link KEYS_DOMAIN_FORWARD} - Array of all keys for this type
6772
6776
  */
6773
6777
  export const KEY_DOMAIN_FORWARD_HTTPS: keyof DomainForward = 'https';
6778
+ /**
6779
+ * Parking Id
6780
+ *
6781
+ *
6782
+ *
6783
+ *
6784
+ * @remarks
6785
+ * This key constant provides type-safe access to the `parking_id` property of DomainForward objects.
6786
+ * Use this constant when you need to access properties dynamically or ensure type safety.
6787
+ *
6788
+ * @example
6789
+ * ```typescript
6790
+ * // Direct property access
6791
+ * const value = domainforward[KEY_DOMAIN_FORWARD_PARKING_ID];
6792
+ *
6793
+ * // Dynamic property access
6794
+ * const propertyName = KEY_DOMAIN_FORWARD_PARKING_ID;
6795
+ * const value = domainforward[propertyName];
6796
+ * ```
6797
+ *
6798
+ * @see {@link DomainForward} - The TypeScript type definition
6799
+ * @see {@link KEYS_DOMAIN_FORWARD} - Array of all keys for this type
6800
+ */
6801
+ export const KEY_DOMAIN_FORWARD_PARKING_ID: keyof DomainForward = 'parking_id';
6774
6802
  /**
6775
6803
  * Updated On
6776
6804
  *
@@ -6823,6 +6851,7 @@ export const KEYS_DOMAIN_FORWARD = [
6823
6851
  KEY_DOMAIN_FORWARD_HOSTNAME,
6824
6852
  KEY_DOMAIN_FORWARD_HTTP,
6825
6853
  KEY_DOMAIN_FORWARD_HTTPS,
6854
+ KEY_DOMAIN_FORWARD_PARKING_ID,
6826
6855
  KEY_DOMAIN_FORWARD_UPDATED_ON,
6827
6856
  ] as const satisfies (keyof DomainForward)[];
6828
6857
 
@@ -19224,6 +19253,111 @@ export const KEYS_PAGINATION_METADATA = [
19224
19253
  KEY_PAGINATION_METADATA_TOTAL_PAGES,
19225
19254
  ] as const satisfies (keyof PaginationMetadata)[];
19226
19255
 
19256
+ /**
19257
+ * Accepted
19258
+ *
19259
+ * Whether the agreement has been accepted
19260
+ *
19261
+ * @type {boolean}
19262
+ *
19263
+ *
19264
+ * @remarks
19265
+ * This key constant provides type-safe access to the `accepted` property of ParkingAgreementAcceptance objects.
19266
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19267
+ *
19268
+ * @example
19269
+ * ```typescript
19270
+ * // Direct property access
19271
+ * const value = parkingagreementacceptance[KEY_PARKING_AGREEMENT_ACCEPTANCE_ACCEPTED];
19272
+ *
19273
+ * // Dynamic property access
19274
+ * const propertyName = KEY_PARKING_AGREEMENT_ACCEPTANCE_ACCEPTED;
19275
+ * const value = parkingagreementacceptance[propertyName];
19276
+ * ```
19277
+ *
19278
+ * @see {@link ParkingAgreementAcceptance} - The TypeScript type definition
19279
+ * @see {@link KEYS_PARKING_AGREEMENT_ACCEPTANCE} - Array of all keys for this type
19280
+ */
19281
+ export const KEY_PARKING_AGREEMENT_ACCEPTANCE_ACCEPTED: keyof ParkingAgreementAcceptance = 'accepted';
19282
+ /**
19283
+ * Url
19284
+ *
19285
+ * URL where the parking agreement can be found
19286
+ *
19287
+ * @type {string}
19288
+ *
19289
+ *
19290
+ * @remarks
19291
+ * This key constant provides type-safe access to the `url` property of ParkingAgreementAcceptance objects.
19292
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19293
+ *
19294
+ * @example
19295
+ * ```typescript
19296
+ * // Direct property access
19297
+ * const value = parkingagreementacceptance[KEY_PARKING_AGREEMENT_ACCEPTANCE_URL];
19298
+ *
19299
+ * // Dynamic property access
19300
+ * const propertyName = KEY_PARKING_AGREEMENT_ACCEPTANCE_URL;
19301
+ * const value = parkingagreementacceptance[propertyName];
19302
+ * ```
19303
+ *
19304
+ * @see {@link ParkingAgreementAcceptance} - The TypeScript type definition
19305
+ * @see {@link KEYS_PARKING_AGREEMENT_ACCEPTANCE} - Array of all keys for this type
19306
+ */
19307
+ export const KEY_PARKING_AGREEMENT_ACCEPTANCE_URL: keyof ParkingAgreementAcceptance = 'url';
19308
+ /**
19309
+ * Version
19310
+ *
19311
+ * Version of the parking agreement being accepted
19312
+ *
19313
+ * @type {string}
19314
+ *
19315
+ *
19316
+ * @remarks
19317
+ * This key constant provides type-safe access to the `version` property of ParkingAgreementAcceptance objects.
19318
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19319
+ *
19320
+ * @example
19321
+ * ```typescript
19322
+ * // Direct property access
19323
+ * const value = parkingagreementacceptance[KEY_PARKING_AGREEMENT_ACCEPTANCE_VERSION];
19324
+ *
19325
+ * // Dynamic property access
19326
+ * const propertyName = KEY_PARKING_AGREEMENT_ACCEPTANCE_VERSION;
19327
+ * const value = parkingagreementacceptance[propertyName];
19328
+ * ```
19329
+ *
19330
+ * @see {@link ParkingAgreementAcceptance} - The TypeScript type definition
19331
+ * @see {@link KEYS_PARKING_AGREEMENT_ACCEPTANCE} - Array of all keys for this type
19332
+ */
19333
+ export const KEY_PARKING_AGREEMENT_ACCEPTANCE_VERSION: keyof ParkingAgreementAcceptance = 'version';
19334
+
19335
+ /**
19336
+ * Array of all ParkingAgreementAcceptance property keys
19337
+ *
19338
+ * @remarks
19339
+ * This constant provides a readonly array containing all valid property keys for ParkingAgreementAcceptance objects.
19340
+ * Useful for iteration, validation, and generating dynamic UI components.
19341
+ *
19342
+ * @example
19343
+ * ```typescript
19344
+ * // Iterating through all keys
19345
+ * for (const key of KEYS_PARKING_AGREEMENT_ACCEPTANCE) {
19346
+ * console.log(`Property: ${key}, Value: ${parkingagreementacceptance[key]}`);
19347
+ * }
19348
+ *
19349
+ * // Validation
19350
+ * const isValidKey = KEYS_PARKING_AGREEMENT_ACCEPTANCE.includes(someKey);
19351
+ * ```
19352
+ *
19353
+ * @see {@link ParkingAgreementAcceptance} - The TypeScript type definition
19354
+ */
19355
+ export const KEYS_PARKING_AGREEMENT_ACCEPTANCE = [
19356
+ KEY_PARKING_AGREEMENT_ACCEPTANCE_ACCEPTED,
19357
+ KEY_PARKING_AGREEMENT_ACCEPTANCE_URL,
19358
+ KEY_PARKING_AGREEMENT_ACCEPTANCE_VERSION,
19359
+ ] as const satisfies (keyof ParkingAgreementAcceptance)[];
19360
+
19227
19361
  /**
19228
19362
  * metrics property
19229
19363
  *
@@ -19591,6 +19725,237 @@ export const KEYS_PARKING = [
19591
19725
  KEY_PARKING_UPDATED_ON,
19592
19726
  ] as const satisfies (keyof Parking)[];
19593
19727
 
19728
+ /**
19729
+ * agreement property
19730
+ *
19731
+ * Parking agreement acceptance
19732
+ *
19733
+ *
19734
+ *
19735
+ * @remarks
19736
+ * This key constant provides type-safe access to the `agreement` property of ParkingSignupRequest objects.
19737
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19738
+ *
19739
+ * @example
19740
+ * ```typescript
19741
+ * // Direct property access
19742
+ * const value = parkingsignuprequest[KEY_PARKING_SIGNUP_REQUEST_AGREEMENT];
19743
+ *
19744
+ * // Dynamic property access
19745
+ * const propertyName = KEY_PARKING_SIGNUP_REQUEST_AGREEMENT;
19746
+ * const value = parkingsignuprequest[propertyName];
19747
+ * ```
19748
+ *
19749
+ * @see {@link ParkingSignupRequest} - The TypeScript type definition
19750
+ * @see {@link KEYS_PARKING_SIGNUP_REQUEST} - Array of all keys for this type
19751
+ */
19752
+ export const KEY_PARKING_SIGNUP_REQUEST_AGREEMENT: keyof ParkingSignupRequest = 'agreement';
19753
+
19754
+ /**
19755
+ * Array of all ParkingSignupRequest property keys
19756
+ *
19757
+ * @remarks
19758
+ * This constant provides a readonly array containing all valid property keys for ParkingSignupRequest objects.
19759
+ * Useful for iteration, validation, and generating dynamic UI components.
19760
+ *
19761
+ * @example
19762
+ * ```typescript
19763
+ * // Iterating through all keys
19764
+ * for (const key of KEYS_PARKING_SIGNUP_REQUEST) {
19765
+ * console.log(`Property: ${key}, Value: ${parkingsignuprequest[key]}`);
19766
+ * }
19767
+ *
19768
+ * // Validation
19769
+ * const isValidKey = KEYS_PARKING_SIGNUP_REQUEST.includes(someKey);
19770
+ * ```
19771
+ *
19772
+ * @see {@link ParkingSignupRequest} - The TypeScript type definition
19773
+ */
19774
+ export const KEYS_PARKING_SIGNUP_REQUEST = [
19775
+ KEY_PARKING_SIGNUP_REQUEST_AGREEMENT,
19776
+ ] as const satisfies (keyof ParkingSignupRequest)[];
19777
+
19778
+ /**
19779
+ * Agreement Stored
19780
+ *
19781
+ * Whether the agreement acceptance was stored
19782
+ *
19783
+ * @type {boolean}
19784
+ *
19785
+ *
19786
+ * @remarks
19787
+ * This key constant provides type-safe access to the `agreement_stored` property of ParkingSignup objects.
19788
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19789
+ *
19790
+ * @example
19791
+ * ```typescript
19792
+ * // Direct property access
19793
+ * const value = parkingsignup[KEY_PARKING_SIGNUP_AGREEMENT_STORED];
19794
+ *
19795
+ * // Dynamic property access
19796
+ * const propertyName = KEY_PARKING_SIGNUP_AGREEMENT_STORED;
19797
+ * const value = parkingsignup[propertyName];
19798
+ * ```
19799
+ *
19800
+ * @see {@link ParkingSignup} - The TypeScript type definition
19801
+ * @see {@link KEYS_PARKING_SIGNUP} - Array of all keys for this type
19802
+ */
19803
+ export const KEY_PARKING_SIGNUP_AGREEMENT_STORED: keyof ParkingSignup = 'agreement_stored';
19804
+ /**
19805
+ * Success
19806
+ *
19807
+ * Whether the signup was successful
19808
+ *
19809
+ * @type {boolean}
19810
+ *
19811
+ *
19812
+ * @remarks
19813
+ * This key constant provides type-safe access to the `success` property of ParkingSignup objects.
19814
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19815
+ *
19816
+ * @example
19817
+ * ```typescript
19818
+ * // Direct property access
19819
+ * const value = parkingsignup[KEY_PARKING_SIGNUP_SUCCESS];
19820
+ *
19821
+ * // Dynamic property access
19822
+ * const propertyName = KEY_PARKING_SIGNUP_SUCCESS;
19823
+ * const value = parkingsignup[propertyName];
19824
+ * ```
19825
+ *
19826
+ * @see {@link ParkingSignup} - The TypeScript type definition
19827
+ * @see {@link KEYS_PARKING_SIGNUP} - Array of all keys for this type
19828
+ */
19829
+ export const KEY_PARKING_SIGNUP_SUCCESS: keyof ParkingSignup = 'success';
19830
+
19831
+ /**
19832
+ * Array of all ParkingSignup property keys
19833
+ *
19834
+ * @remarks
19835
+ * This constant provides a readonly array containing all valid property keys for ParkingSignup objects.
19836
+ * Useful for iteration, validation, and generating dynamic UI components.
19837
+ *
19838
+ * @example
19839
+ * ```typescript
19840
+ * // Iterating through all keys
19841
+ * for (const key of KEYS_PARKING_SIGNUP) {
19842
+ * console.log(`Property: ${key}, Value: ${parkingsignup[key]}`);
19843
+ * }
19844
+ *
19845
+ * // Validation
19846
+ * const isValidKey = KEYS_PARKING_SIGNUP.includes(someKey);
19847
+ * ```
19848
+ *
19849
+ * @see {@link ParkingSignup} - The TypeScript type definition
19850
+ */
19851
+ export const KEYS_PARKING_SIGNUP = [
19852
+ KEY_PARKING_SIGNUP_AGREEMENT_STORED,
19853
+ KEY_PARKING_SIGNUP_SUCCESS,
19854
+ ] as const satisfies (keyof ParkingSignup)[];
19855
+
19856
+ /**
19857
+ * Accepted At
19858
+ *
19859
+ * When the agreement was accepted
19860
+ *
19861
+ *
19862
+ *
19863
+ * @remarks
19864
+ * This key constant provides type-safe access to the `accepted_at` property of ParkingSignupStatus objects.
19865
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19866
+ *
19867
+ * @example
19868
+ * ```typescript
19869
+ * // Direct property access
19870
+ * const value = parkingsignupstatus[KEY_PARKING_SIGNUP_STATUS_ACCEPTED_AT];
19871
+ *
19872
+ * // Dynamic property access
19873
+ * const propertyName = KEY_PARKING_SIGNUP_STATUS_ACCEPTED_AT;
19874
+ * const value = parkingsignupstatus[propertyName];
19875
+ * ```
19876
+ *
19877
+ * @see {@link ParkingSignupStatus} - The TypeScript type definition
19878
+ * @see {@link KEYS_PARKING_SIGNUP_STATUS} - Array of all keys for this type
19879
+ */
19880
+ export const KEY_PARKING_SIGNUP_STATUS_ACCEPTED_AT: keyof ParkingSignupStatus = 'accepted_at';
19881
+ /**
19882
+ * Agreement Version
19883
+ *
19884
+ * Version of the accepted agreement
19885
+ *
19886
+ *
19887
+ *
19888
+ * @remarks
19889
+ * This key constant provides type-safe access to the `agreement_version` property of ParkingSignupStatus objects.
19890
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19891
+ *
19892
+ * @example
19893
+ * ```typescript
19894
+ * // Direct property access
19895
+ * const value = parkingsignupstatus[KEY_PARKING_SIGNUP_STATUS_AGREEMENT_VERSION];
19896
+ *
19897
+ * // Dynamic property access
19898
+ * const propertyName = KEY_PARKING_SIGNUP_STATUS_AGREEMENT_VERSION;
19899
+ * const value = parkingsignupstatus[propertyName];
19900
+ * ```
19901
+ *
19902
+ * @see {@link ParkingSignupStatus} - The TypeScript type definition
19903
+ * @see {@link KEYS_PARKING_SIGNUP_STATUS} - Array of all keys for this type
19904
+ */
19905
+ export const KEY_PARKING_SIGNUP_STATUS_AGREEMENT_VERSION: keyof ParkingSignupStatus = 'agreement_version';
19906
+ /**
19907
+ * Has Accepted Agreement
19908
+ *
19909
+ * Whether the organization has accepted the parking agreement
19910
+ *
19911
+ * @type {boolean}
19912
+ *
19913
+ *
19914
+ * @remarks
19915
+ * This key constant provides type-safe access to the `has_accepted_agreement` property of ParkingSignupStatus objects.
19916
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19917
+ *
19918
+ * @example
19919
+ * ```typescript
19920
+ * // Direct property access
19921
+ * const value = parkingsignupstatus[KEY_PARKING_SIGNUP_STATUS_HAS_ACCEPTED_AGREEMENT];
19922
+ *
19923
+ * // Dynamic property access
19924
+ * const propertyName = KEY_PARKING_SIGNUP_STATUS_HAS_ACCEPTED_AGREEMENT;
19925
+ * const value = parkingsignupstatus[propertyName];
19926
+ * ```
19927
+ *
19928
+ * @see {@link ParkingSignupStatus} - The TypeScript type definition
19929
+ * @see {@link KEYS_PARKING_SIGNUP_STATUS} - Array of all keys for this type
19930
+ */
19931
+ export const KEY_PARKING_SIGNUP_STATUS_HAS_ACCEPTED_AGREEMENT: keyof ParkingSignupStatus = 'has_accepted_agreement';
19932
+
19933
+ /**
19934
+ * Array of all ParkingSignupStatus property keys
19935
+ *
19936
+ * @remarks
19937
+ * This constant provides a readonly array containing all valid property keys for ParkingSignupStatus objects.
19938
+ * Useful for iteration, validation, and generating dynamic UI components.
19939
+ *
19940
+ * @example
19941
+ * ```typescript
19942
+ * // Iterating through all keys
19943
+ * for (const key of KEYS_PARKING_SIGNUP_STATUS) {
19944
+ * console.log(`Property: ${key}, Value: ${parkingsignupstatus[key]}`);
19945
+ * }
19946
+ *
19947
+ * // Validation
19948
+ * const isValidKey = KEYS_PARKING_SIGNUP_STATUS.includes(someKey);
19949
+ * ```
19950
+ *
19951
+ * @see {@link ParkingSignupStatus} - The TypeScript type definition
19952
+ */
19953
+ export const KEYS_PARKING_SIGNUP_STATUS = [
19954
+ KEY_PARKING_SIGNUP_STATUS_ACCEPTED_AT,
19955
+ KEY_PARKING_SIGNUP_STATUS_AGREEMENT_VERSION,
19956
+ KEY_PARKING_SIGNUP_STATUS_HAS_ACCEPTED_AGREEMENT,
19957
+ ] as const satisfies (keyof ParkingSignupStatus)[];
19958
+
19594
19959
  /**
19595
19960
  * Conversions
19596
19961
  *
@@ -34,7 +34,7 @@ import { operations } from '../schema';
34
34
 
35
35
  import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
36
36
 
37
- import { ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardCreateRequest, DomainForwardSetCreateRequest, DomainForwardSetRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainWithdrawRequest, DomainTransitRequest, DomainTransferIn, EmailForwardCreate, EmailForwardAliasCreate, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
37
+ import { ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardCreateRequest, DomainForwardSetCreateRequest, DomainForwardSetRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainWithdrawRequest, DomainTransitRequest, DomainTransferIn, EmailForwardCreate, EmailForwardAliasCreate, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, ParkingSignupRequest, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
38
38
 
39
39
  /**
40
40
  * Request type for GET ArchiveEmailForwardLogsAliasesEmailForwardAliasId endpoint
@@ -4764,6 +4764,66 @@ export type GET_ParkingParkingIdMetrics_Request_Query = GET_ParkingParkingIdMetr
4764
4764
  */
4765
4765
  export type GET_ParkingParkingIdMetrics_Request_Path = GET_ParkingParkingIdMetrics_Request['parameters']['path'];
4766
4766
 
4767
+ /**
4768
+ * Request type for POST ParkingSignup endpoint
4769
+ *
4770
+ * Sign up for parking
4771
+ * Accept the parking agreement to enable parking features for your organization.
4772
+ *
4773
+ * @remarks
4774
+ * This type defines the complete request structure for the POST ParkingSignup endpoint.
4775
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
4776
+ * Use this type to ensure type safety when making API requests to this endpoint.
4777
+ *
4778
+ * @example
4779
+ * Use this type to ensure type safety when making API requests to this endpoint.
4780
+ *
4781
+ * @path /v1/parking/signup
4782
+ *
4783
+ * @see {@link POST_ParkingSignup_Request_Query} - Query parameters type
4784
+ * @see {@link POST_ParkingSignup_Request_Path} - Path parameters type
4785
+ * @see {@link POST_ParkingSignup_Request_Body} - Request body type
4786
+ */
4787
+ export type POST_ParkingSignup_Request = {
4788
+ requestBody: ParkingSignupRequest;
4789
+ }
4790
+ /**
4791
+ * Request body for POST /v1/parking/signup
4792
+ *
4793
+ * @remarks
4794
+ * This type defines the request body structure for the POST /v1/parking/signup endpoint.
4795
+ * It provides type safety for the request body as defined in the OpenAPI specification.
4796
+ *
4797
+ * @example
4798
+ * Use this type to ensure type safety for request body structure.
4799
+ *
4800
+ * @path /v1/parking/signup
4801
+ */
4802
+ export type POST_ParkingSignup_Request_Body = POST_ParkingSignup_Request['requestBody'];
4803
+
4804
+ /**
4805
+ * Request type for GET ParkingSignupStatus endpoint
4806
+ *
4807
+ * Get parking signup status
4808
+ * Check if your organization has accepted the parking agreement.
4809
+ *
4810
+ * @remarks
4811
+ * This type defines the complete request structure for the GET ParkingSignupStatus endpoint.
4812
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
4813
+ * Use this type to ensure type safety when making API requests to this endpoint.
4814
+ *
4815
+ * @example
4816
+ * Use this type to ensure type safety when making API requests to this endpoint.
4817
+ *
4818
+ * @path /v1/parking/signup/status
4819
+ *
4820
+ * @see {@link GET_ParkingSignupStatus_Request_Query} - Query parameters type
4821
+ * @see {@link GET_ParkingSignupStatus_Request_Path} - Path parameters type
4822
+ * @see {@link GET_ParkingSignupStatus_Request_Body} - Request body type
4823
+ */
4824
+ export type GET_ParkingSignupStatus_Request = {
4825
+ }
4826
+
4767
4827
  /**
4768
4828
  * Request type for GET Tlds endpoint
4769
4829
  *
@@ -34,7 +34,7 @@
34
34
 
35
35
  import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
36
36
 
37
- import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, Pagination_Parking, ParkingMetrics, ParkingTotalMetrics, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
37
+ import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, EmailForwardMetrics, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, Pagination_Parking, ParkingMetrics, ParkingTotalMetrics, ParkingSignup, ParkingSignupStatus, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
38
38
 
39
39
  /**
40
40
  * Response types for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
@@ -9146,6 +9146,190 @@ export type GET_ParkingMetrics_Response_403 = Problem
9146
9146
  */
9147
9147
  export type GET_ParkingMetrics_Response_422 = HTTPValidationError
9148
9148
 
9149
+ /**
9150
+ * Response types for POST ParkingSignup endpoint
9151
+ *
9152
+ * Sign up for parking
9153
+ * Accept the parking agreement to enable parking features for your organization.
9154
+ *
9155
+ * @remarks
9156
+ * This type defines all possible response structures for the POST ParkingSignup endpoint.
9157
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
9158
+ * Use this type to ensure type safety when handling API responses from this endpoint.
9159
+ *
9160
+
9161
+ *
9162
+ * @path /v1/parking/signup
9163
+ *
9164
+ * @see {@link POST_ParkingSignup_Response_200} - 200 response type
9165
+ * @see {@link POST_ParkingSignup_Response_401} - 401 response type
9166
+ * @see {@link POST_ParkingSignup_Response_403} - 403 response type
9167
+ * @see {@link POST_ParkingSignup_Response_422} - 422 response type
9168
+ *
9169
+
9170
+ */
9171
+ export type POST_ParkingSignup_Response = POST_ParkingSignup_Response_200 | POST_ParkingSignup_Response_401 | POST_ParkingSignup_Response_403 | POST_ParkingSignup_Response_422;
9172
+
9173
+ /**
9174
+ * 200 response for POST ParkingSignup endpoint
9175
+ *
9176
+ * @remarks
9177
+ * This type defines the response structure for the 200 status code
9178
+ * of the POST ParkingSignup endpoint.
9179
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
9180
+ *
9181
+
9182
+ *
9183
+ * @path /v1/parking/signup
9184
+ *
9185
+ * @see {@link POST_ParkingSignup_Response} - The main response type definition
9186
+ * @see {@link ParkingSignup} - The actual schema type definition
9187
+ */
9188
+ export type POST_ParkingSignup_Response_200 = ParkingSignup
9189
+
9190
+ /**
9191
+ * 401 response for POST ParkingSignup endpoint
9192
+ *
9193
+ * @remarks
9194
+ * This type defines the response structure for the 401 status code
9195
+ * of the POST ParkingSignup endpoint.
9196
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
9197
+ *
9198
+
9199
+ *
9200
+ * @path /v1/parking/signup
9201
+ *
9202
+ * @see {@link POST_ParkingSignup_Response} - The main response type definition
9203
+ * @see {@link Problem} - The actual schema type definition
9204
+ */
9205
+ export type POST_ParkingSignup_Response_401 = Problem
9206
+
9207
+ /**
9208
+ * 403 response for POST ParkingSignup endpoint
9209
+ *
9210
+ * @remarks
9211
+ * This type defines the response structure for the 403 status code
9212
+ * of the POST ParkingSignup endpoint.
9213
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
9214
+ *
9215
+
9216
+ *
9217
+ * @path /v1/parking/signup
9218
+ *
9219
+ * @see {@link POST_ParkingSignup_Response} - The main response type definition
9220
+ * @see {@link Problem} - The actual schema type definition
9221
+ */
9222
+ export type POST_ParkingSignup_Response_403 = Problem
9223
+
9224
+ /**
9225
+ * 422 response for POST ParkingSignup endpoint
9226
+ *
9227
+ * @remarks
9228
+ * This type defines the response structure for the 422 status code
9229
+ * of the POST ParkingSignup endpoint.
9230
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
9231
+ *
9232
+
9233
+ *
9234
+ * @path /v1/parking/signup
9235
+ *
9236
+ * @see {@link POST_ParkingSignup_Response} - The main response type definition
9237
+ * @see {@link HTTPValidationError} - The actual schema type definition
9238
+ */
9239
+ export type POST_ParkingSignup_Response_422 = HTTPValidationError
9240
+
9241
+ /**
9242
+ * Response types for GET ParkingSignupStatus endpoint
9243
+ *
9244
+ * Get parking signup status
9245
+ * Check if your organization has accepted the parking agreement.
9246
+ *
9247
+ * @remarks
9248
+ * This type defines all possible response structures for the GET ParkingSignupStatus endpoint.
9249
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
9250
+ * Use this type to ensure type safety when handling API responses from this endpoint.
9251
+ *
9252
+
9253
+ *
9254
+ * @path /v1/parking/signup/status
9255
+ *
9256
+ * @see {@link GET_ParkingSignupStatus_Response_200} - 200 response type
9257
+ * @see {@link GET_ParkingSignupStatus_Response_401} - 401 response type
9258
+ * @see {@link GET_ParkingSignupStatus_Response_403} - 403 response type
9259
+ * @see {@link GET_ParkingSignupStatus_Response_422} - 422 response type
9260
+ *
9261
+
9262
+ */
9263
+ export type GET_ParkingSignupStatus_Response = GET_ParkingSignupStatus_Response_200 | GET_ParkingSignupStatus_Response_401 | GET_ParkingSignupStatus_Response_403 | GET_ParkingSignupStatus_Response_422;
9264
+
9265
+ /**
9266
+ * 200 response for GET ParkingSignupStatus endpoint
9267
+ *
9268
+ * @remarks
9269
+ * This type defines the response structure for the 200 status code
9270
+ * of the GET ParkingSignupStatus endpoint.
9271
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
9272
+ *
9273
+
9274
+ *
9275
+ * @path /v1/parking/signup/status
9276
+ *
9277
+ * @see {@link GET_ParkingSignupStatus_Response} - The main response type definition
9278
+ * @see {@link ParkingSignupStatus} - The actual schema type definition
9279
+ */
9280
+ export type GET_ParkingSignupStatus_Response_200 = ParkingSignupStatus
9281
+
9282
+ /**
9283
+ * 401 response for GET ParkingSignupStatus endpoint
9284
+ *
9285
+ * @remarks
9286
+ * This type defines the response structure for the 401 status code
9287
+ * of the GET ParkingSignupStatus endpoint.
9288
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
9289
+ *
9290
+
9291
+ *
9292
+ * @path /v1/parking/signup/status
9293
+ *
9294
+ * @see {@link GET_ParkingSignupStatus_Response} - The main response type definition
9295
+ * @see {@link Problem} - The actual schema type definition
9296
+ */
9297
+ export type GET_ParkingSignupStatus_Response_401 = Problem
9298
+
9299
+ /**
9300
+ * 403 response for GET ParkingSignupStatus endpoint
9301
+ *
9302
+ * @remarks
9303
+ * This type defines the response structure for the 403 status code
9304
+ * of the GET ParkingSignupStatus endpoint.
9305
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
9306
+ *
9307
+
9308
+ *
9309
+ * @path /v1/parking/signup/status
9310
+ *
9311
+ * @see {@link GET_ParkingSignupStatus_Response} - The main response type definition
9312
+ * @see {@link Problem} - The actual schema type definition
9313
+ */
9314
+ export type GET_ParkingSignupStatus_Response_403 = Problem
9315
+
9316
+ /**
9317
+ * 422 response for GET ParkingSignupStatus endpoint
9318
+ *
9319
+ * @remarks
9320
+ * This type defines the response structure for the 422 status code
9321
+ * of the GET ParkingSignupStatus endpoint.
9322
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
9323
+ *
9324
+
9325
+ *
9326
+ * @path /v1/parking/signup/status
9327
+ *
9328
+ * @see {@link GET_ParkingSignupStatus_Response} - The main response type definition
9329
+ * @see {@link HTTPValidationError} - The actual schema type definition
9330
+ */
9331
+ export type GET_ParkingSignupStatus_Response_422 = HTTPValidationError
9332
+
9149
9333
  /**
9150
9334
  * Response types for GET Tlds endpoint
9151
9335
  *
@@ -3135,6 +3135,22 @@ export type Pagination_RequestHistory = components['schemas']['Pagination_Reques
3135
3135
  * @see {@link components} - The OpenAPI components schema definition
3136
3136
  */
3137
3137
  export type Pagination_UserPublic = components['schemas']['Pagination_UserPublic_'];
3138
+ /**
3139
+ * ParkingAgreementAcceptance. Parking agreement acceptance details.
3140
+ *
3141
+ * @remarks
3142
+ * Type alias for the `ParkingAgreementAcceptance` OpenAPI schema.
3143
+ * This type represents parkingagreementacceptance data structures used in API requests and responses.
3144
+ *
3145
+ * @example
3146
+ * ```typescript
3147
+ * const response = await api.getParkingAgreementAcceptance();
3148
+ * const item: ParkingAgreementAcceptance = response.results;
3149
+ * ```
3150
+ *
3151
+ * @see {@link components} - The OpenAPI components schema definition
3152
+ */
3153
+ export type ParkingAgreementAcceptance = components['schemas']['ParkingAgreementAcceptance'];
3138
3154
  /**
3139
3155
  * ParkingMetricsResponse
3140
3156
  *
@@ -3167,6 +3183,54 @@ export type ParkingMetrics = components['schemas']['ParkingMetricsResponse'];
3167
3183
  * @see {@link components} - The OpenAPI components schema definition
3168
3184
  */
3169
3185
  export type Parking = components['schemas']['ParkingResponse'];
3186
+ /**
3187
+ * ParkingSignupRequest. Request to sign up for parking (accept parking agreement).
3188
+ *
3189
+ * @remarks
3190
+ * Type alias for the `ParkingSignupRequest` OpenAPI schema.
3191
+ * This type represents parkingsignuprequest data structures used in API requests and responses.
3192
+ *
3193
+ * @example
3194
+ * ```typescript
3195
+ * const response = await api.getParkingSignupRequest();
3196
+ * const item: ParkingSignupRequest = response.results;
3197
+ * ```
3198
+ *
3199
+ * @see {@link components} - The OpenAPI components schema definition
3200
+ */
3201
+ export type ParkingSignupRequest = components['schemas']['ParkingSignupRequest'];
3202
+ /**
3203
+ * ParkingSignupResponse. Response after parking signup.
3204
+ *
3205
+ * @remarks
3206
+ * Type alias for the `ParkingSignupResponse` OpenAPI schema.
3207
+ * This type represents parkingsignupresponse data structures used in API requests and responses.
3208
+ *
3209
+ * @example
3210
+ * ```typescript
3211
+ * const response = await api.getParkingSignup();
3212
+ * const item: ParkingSignup = response.results;
3213
+ * ```
3214
+ *
3215
+ * @see {@link components} - The OpenAPI components schema definition
3216
+ */
3217
+ export type ParkingSignup = components['schemas']['ParkingSignupResponse'];
3218
+ /**
3219
+ * ParkingSignupStatusResponse. Response for checking parking signup status.
3220
+ *
3221
+ * @remarks
3222
+ * Type alias for the `ParkingSignupStatusResponse` OpenAPI schema.
3223
+ * This type represents parkingsignupstatusresponse data structures used in API requests and responses.
3224
+ *
3225
+ * @example
3226
+ * ```typescript
3227
+ * const response = await api.getParkingSignupStatus();
3228
+ * const item: ParkingSignupStatus = response.results;
3229
+ * ```
3230
+ *
3231
+ * @see {@link components} - The OpenAPI components schema definition
3232
+ */
3233
+ export type ParkingSignupStatus = components['schemas']['ParkingSignupStatusResponse'];
3170
3234
  /**
3171
3235
  * ParkingSortField
3172
3236
  *
package/src/openapi.yaml CHANGED
@@ -1621,6 +1621,16 @@ components:
1621
1621
  anyOf:
1622
1622
  - $ref: '#/components/schemas/DomainForwardProtocolSetResponse'
1623
1623
  - type: 'null'
1624
+ parking_id:
1625
+ anyOf:
1626
+ - examples:
1627
+ - parking_01h45ytscbebyvny4gc8cr8ma2
1628
+ format: typeid
1629
+ pattern: ^parking_[0-7][0-9a-hjkmnpq-tv-z]{25}$
1630
+ type: string
1631
+ x-typeid-prefix: parking
1632
+ - type: 'null'
1633
+ title: Parking Id
1624
1634
  updated_on:
1625
1635
  format: date-time
1626
1636
  title: Updated On
@@ -1630,6 +1640,7 @@ components:
1630
1640
  - enabled
1631
1641
  - updated_on
1632
1642
  - created_on
1643
+ - parking_id
1633
1644
  title: DomainForward
1634
1645
  type: object
1635
1646
  DomainForwardBrowserStatsResponse:
@@ -4911,6 +4922,30 @@ components:
4911
4922
  - pagination
4912
4923
  title: Pagination[UserPublic]
4913
4924
  type: object
4925
+ ParkingAgreementAcceptance:
4926
+ description: Parking agreement acceptance details.
4927
+ properties:
4928
+ accepted:
4929
+ description: Whether the agreement has been accepted
4930
+ title: Accepted
4931
+ type: boolean
4932
+ url:
4933
+ description: URL where the parking agreement can be found
4934
+ format: uri
4935
+ maxLength: 2083
4936
+ minLength: 1
4937
+ title: Url
4938
+ type: string
4939
+ version:
4940
+ description: Version of the parking agreement being accepted
4941
+ title: Version
4942
+ type: string
4943
+ required:
4944
+ - version
4945
+ - accepted
4946
+ - url
4947
+ title: ParkingAgreementAcceptance
4948
+ type: object
4914
4949
  ParkingMetricsResponse:
4915
4950
  properties:
4916
4951
  metrics:
@@ -4992,6 +5027,56 @@ components:
4992
5027
  - updated_on
4993
5028
  title: ParkingResponse
4994
5029
  type: object
5030
+ ParkingSignupRequest:
5031
+ description: Request to sign up for parking (accept parking agreement).
5032
+ properties:
5033
+ agreement:
5034
+ $ref: '#/components/schemas/ParkingAgreementAcceptance'
5035
+ description: Parking agreement acceptance
5036
+ required:
5037
+ - agreement
5038
+ title: ParkingSignupRequest
5039
+ type: object
5040
+ ParkingSignupResponse:
5041
+ description: Response after parking signup.
5042
+ properties:
5043
+ agreement_stored:
5044
+ description: Whether the agreement acceptance was stored
5045
+ title: Agreement Stored
5046
+ type: boolean
5047
+ success:
5048
+ description: Whether the signup was successful
5049
+ title: Success
5050
+ type: boolean
5051
+ required:
5052
+ - success
5053
+ - agreement_stored
5054
+ title: ParkingSignupResponse
5055
+ type: object
5056
+ ParkingSignupStatusResponse:
5057
+ description: Response for checking parking signup status.
5058
+ properties:
5059
+ accepted_at:
5060
+ anyOf:
5061
+ - format: date-time
5062
+ type: string
5063
+ - type: 'null'
5064
+ description: When the agreement was accepted
5065
+ title: Accepted At
5066
+ agreement_version:
5067
+ anyOf:
5068
+ - type: string
5069
+ - type: 'null'
5070
+ description: Version of the accepted agreement
5071
+ title: Agreement Version
5072
+ has_accepted_agreement:
5073
+ description: Whether the organization has accepted the parking agreement
5074
+ title: Has Accepted Agreement
5075
+ type: boolean
5076
+ required:
5077
+ - has_accepted_agreement
5078
+ title: ParkingSignupStatusResponse
5079
+ type: object
4995
5080
  ParkingSortField:
4996
5081
  enum:
4997
5082
  - domain
@@ -6835,7 +6920,7 @@ info:
6835
6920
  '
6836
6921
  summary: OpusDNS - your gateway to a seamless domain management experience.
6837
6922
  title: OpusDNS API
6838
- version: 2026-01-26-201029
6923
+ version: 2026-01-27-110709
6839
6924
  x-logo:
6840
6925
  altText: OpusDNS API Reference
6841
6926
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -14908,6 +14993,106 @@ paths:
14908
14993
  summary: Get total metrics for all parking entries
14909
14994
  tags:
14910
14995
  - parking
14996
+ /v1/parking/signup:
14997
+ post:
14998
+ description: Accept the parking agreement to enable parking features for your
14999
+ organization.
15000
+ operationId: signup_for_parking_v1_parking_signup_post
15001
+ requestBody:
15002
+ content:
15003
+ application/json:
15004
+ schema:
15005
+ $ref: '#/components/schemas/ParkingSignupRequest'
15006
+ required: true
15007
+ responses:
15008
+ '200':
15009
+ content:
15010
+ application/json:
15011
+ schema:
15012
+ $ref: '#/components/schemas/ParkingSignupResponse'
15013
+ description: Successful Response
15014
+ '401':
15015
+ content:
15016
+ application/problem+json:
15017
+ example:
15018
+ code: ERROR_AUTHENTICATION
15019
+ detail: Additional error context.
15020
+ status: 401
15021
+ title: Authentication Error
15022
+ type: authentication
15023
+ schema:
15024
+ $ref: '#/components/schemas/Problem'
15025
+ description: Unauthorized
15026
+ '403':
15027
+ content:
15028
+ application/problem+json:
15029
+ example:
15030
+ code: ERROR_PERMISSION_DENIED
15031
+ detail: Insufficient permissions to perform this action
15032
+ status: 403
15033
+ title: Permission Denied
15034
+ type: permission-denied
15035
+ schema:
15036
+ $ref: '#/components/schemas/Problem'
15037
+ description: Forbidden
15038
+ '422':
15039
+ content:
15040
+ application/problem+json:
15041
+ schema:
15042
+ $ref: '#/components/schemas/HTTPValidationError'
15043
+ description: Validation Error
15044
+ security:
15045
+ - OAuth2PasswordBearer: []
15046
+ summary: Sign up for parking
15047
+ tags:
15048
+ - parking
15049
+ /v1/parking/signup/status:
15050
+ get:
15051
+ description: Check if your organization has accepted the parking agreement.
15052
+ operationId: get_parking_signup_status_v1_parking_signup_status_get
15053
+ responses:
15054
+ '200':
15055
+ content:
15056
+ application/json:
15057
+ schema:
15058
+ $ref: '#/components/schemas/ParkingSignupStatusResponse'
15059
+ description: Successful Response
15060
+ '401':
15061
+ content:
15062
+ application/problem+json:
15063
+ example:
15064
+ code: ERROR_AUTHENTICATION
15065
+ detail: Additional error context.
15066
+ status: 401
15067
+ title: Authentication Error
15068
+ type: authentication
15069
+ schema:
15070
+ $ref: '#/components/schemas/Problem'
15071
+ description: Unauthorized
15072
+ '403':
15073
+ content:
15074
+ application/problem+json:
15075
+ example:
15076
+ code: ERROR_PERMISSION_DENIED
15077
+ detail: Insufficient permissions to perform this action
15078
+ status: 403
15079
+ title: Permission Denied
15080
+ type: permission-denied
15081
+ schema:
15082
+ $ref: '#/components/schemas/Problem'
15083
+ description: Forbidden
15084
+ '422':
15085
+ content:
15086
+ application/problem+json:
15087
+ schema:
15088
+ $ref: '#/components/schemas/HTTPValidationError'
15089
+ description: Validation Error
15090
+ security:
15091
+ - OAuth2PasswordBearer: []
15092
+ - APIKeyHeader: []
15093
+ summary: Get parking signup status
15094
+ tags:
15095
+ - parking
14911
15096
  /v1/parking/{parking_id}/metrics:
14912
15097
  get:
14913
15098
  description: Retrieves metrics for a specific parking entry by ID.
package/src/schema.d.ts CHANGED
@@ -1588,6 +1588,46 @@ export interface paths {
1588
1588
  patch?: never;
1589
1589
  trace?: never;
1590
1590
  };
1591
+ "/v1/parking/signup": {
1592
+ parameters: {
1593
+ query?: never;
1594
+ header?: never;
1595
+ path?: never;
1596
+ cookie?: never;
1597
+ };
1598
+ get?: never;
1599
+ put?: never;
1600
+ /**
1601
+ * Sign up for parking
1602
+ * @description Accept the parking agreement to enable parking features for your organization.
1603
+ */
1604
+ post: operations["signup_for_parking_v1_parking_signup_post"];
1605
+ delete?: never;
1606
+ options?: never;
1607
+ head?: never;
1608
+ patch?: never;
1609
+ trace?: never;
1610
+ };
1611
+ "/v1/parking/signup/status": {
1612
+ parameters: {
1613
+ query?: never;
1614
+ header?: never;
1615
+ path?: never;
1616
+ cookie?: never;
1617
+ };
1618
+ /**
1619
+ * Get parking signup status
1620
+ * @description Check if your organization has accepted the parking agreement.
1621
+ */
1622
+ get: operations["get_parking_signup_status_v1_parking_signup_status_get"];
1623
+ put?: never;
1624
+ post?: never;
1625
+ delete?: never;
1626
+ options?: never;
1627
+ head?: never;
1628
+ patch?: never;
1629
+ trace?: never;
1630
+ };
1591
1631
  "/v1/parking/{parking_id}/metrics": {
1592
1632
  parameters: {
1593
1633
  query?: never;
@@ -2916,6 +2956,8 @@ export interface components {
2916
2956
  hostname: string;
2917
2957
  http?: components["schemas"]["DomainForwardProtocolSetResponse"] | null;
2918
2958
  https?: components["schemas"]["DomainForwardProtocolSetResponse"] | null;
2959
+ /** Parking Id */
2960
+ parking_id: TypeId<"parking"> | null;
2919
2961
  /**
2920
2962
  * Updated On
2921
2963
  * Format: date-time
@@ -5059,6 +5101,28 @@ export interface components {
5059
5101
  /** Results */
5060
5102
  results: components["schemas"]["UserPublic"][];
5061
5103
  };
5104
+ /**
5105
+ * ParkingAgreementAcceptance
5106
+ * @description Parking agreement acceptance details.
5107
+ */
5108
+ ParkingAgreementAcceptance: {
5109
+ /**
5110
+ * Accepted
5111
+ * @description Whether the agreement has been accepted
5112
+ */
5113
+ accepted: boolean;
5114
+ /**
5115
+ * Url
5116
+ * Format: uri
5117
+ * @description URL where the parking agreement can be found
5118
+ */
5119
+ url: string;
5120
+ /**
5121
+ * Version
5122
+ * @description Version of the parking agreement being accepted
5123
+ */
5124
+ version: string;
5125
+ };
5062
5126
  /** ParkingMetricsResponse */
5063
5127
  ParkingMetricsResponse: {
5064
5128
  /** @description Metrics for the parking entry */
@@ -5123,6 +5187,51 @@ export interface components {
5123
5187
  */
5124
5188
  updated_on: Date;
5125
5189
  };
5190
+ /**
5191
+ * ParkingSignupRequest
5192
+ * @description Request to sign up for parking (accept parking agreement).
5193
+ */
5194
+ ParkingSignupRequest: {
5195
+ /** @description Parking agreement acceptance */
5196
+ agreement: components["schemas"]["ParkingAgreementAcceptance"];
5197
+ };
5198
+ /**
5199
+ * ParkingSignupResponse
5200
+ * @description Response after parking signup.
5201
+ */
5202
+ ParkingSignupResponse: {
5203
+ /**
5204
+ * Agreement Stored
5205
+ * @description Whether the agreement acceptance was stored
5206
+ */
5207
+ agreement_stored: boolean;
5208
+ /**
5209
+ * Success
5210
+ * @description Whether the signup was successful
5211
+ */
5212
+ success: boolean;
5213
+ };
5214
+ /**
5215
+ * ParkingSignupStatusResponse
5216
+ * @description Response for checking parking signup status.
5217
+ */
5218
+ ParkingSignupStatusResponse: {
5219
+ /**
5220
+ * Accepted At
5221
+ * @description When the agreement was accepted
5222
+ */
5223
+ accepted_at?: Date | null;
5224
+ /**
5225
+ * Agreement Version
5226
+ * @description Version of the accepted agreement
5227
+ */
5228
+ agreement_version?: string | null;
5229
+ /**
5230
+ * Has Accepted Agreement
5231
+ * @description Whether the organization has accepted the parking agreement
5232
+ */
5233
+ has_accepted_agreement: boolean;
5234
+ };
5126
5235
  /**
5127
5236
  * ParkingSortField
5128
5237
  * @enum {string}
@@ -12888,6 +12997,132 @@ export interface operations {
12888
12997
  };
12889
12998
  };
12890
12999
  };
13000
+ signup_for_parking_v1_parking_signup_post: {
13001
+ parameters: {
13002
+ query?: never;
13003
+ header?: never;
13004
+ path?: never;
13005
+ cookie?: never;
13006
+ };
13007
+ requestBody: {
13008
+ content: {
13009
+ "application/json": components["schemas"]["ParkingSignupRequest"];
13010
+ };
13011
+ };
13012
+ responses: {
13013
+ /** @description Successful Response */
13014
+ 200: {
13015
+ headers: {
13016
+ [name: string]: unknown;
13017
+ };
13018
+ content: {
13019
+ "application/json": components["schemas"]["ParkingSignupResponse"];
13020
+ };
13021
+ };
13022
+ /** @description Unauthorized */
13023
+ 401: {
13024
+ headers: {
13025
+ [name: string]: unknown;
13026
+ };
13027
+ content: {
13028
+ /** @example {
13029
+ * "code": "ERROR_AUTHENTICATION",
13030
+ * "detail": "Additional error context.",
13031
+ * "status": 401,
13032
+ * "title": "Authentication Error",
13033
+ * "type": "authentication"
13034
+ * } */
13035
+ "application/problem+json": components["schemas"]["Problem"];
13036
+ };
13037
+ };
13038
+ /** @description Forbidden */
13039
+ 403: {
13040
+ headers: {
13041
+ [name: string]: unknown;
13042
+ };
13043
+ content: {
13044
+ /** @example {
13045
+ * "code": "ERROR_PERMISSION_DENIED",
13046
+ * "detail": "Insufficient permissions to perform this action",
13047
+ * "status": 403,
13048
+ * "title": "Permission Denied",
13049
+ * "type": "permission-denied"
13050
+ * } */
13051
+ "application/problem+json": components["schemas"]["Problem"];
13052
+ };
13053
+ };
13054
+ /** @description Validation Error */
13055
+ 422: {
13056
+ headers: {
13057
+ [name: string]: unknown;
13058
+ };
13059
+ content: {
13060
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
13061
+ };
13062
+ };
13063
+ };
13064
+ };
13065
+ get_parking_signup_status_v1_parking_signup_status_get: {
13066
+ parameters: {
13067
+ query?: never;
13068
+ header?: never;
13069
+ path?: never;
13070
+ cookie?: never;
13071
+ };
13072
+ requestBody?: never;
13073
+ responses: {
13074
+ /** @description Successful Response */
13075
+ 200: {
13076
+ headers: {
13077
+ [name: string]: unknown;
13078
+ };
13079
+ content: {
13080
+ "application/json": components["schemas"]["ParkingSignupStatusResponse"];
13081
+ };
13082
+ };
13083
+ /** @description Unauthorized */
13084
+ 401: {
13085
+ headers: {
13086
+ [name: string]: unknown;
13087
+ };
13088
+ content: {
13089
+ /** @example {
13090
+ * "code": "ERROR_AUTHENTICATION",
13091
+ * "detail": "Additional error context.",
13092
+ * "status": 401,
13093
+ * "title": "Authentication Error",
13094
+ * "type": "authentication"
13095
+ * } */
13096
+ "application/problem+json": components["schemas"]["Problem"];
13097
+ };
13098
+ };
13099
+ /** @description Forbidden */
13100
+ 403: {
13101
+ headers: {
13102
+ [name: string]: unknown;
13103
+ };
13104
+ content: {
13105
+ /** @example {
13106
+ * "code": "ERROR_PERMISSION_DENIED",
13107
+ * "detail": "Insufficient permissions to perform this action",
13108
+ * "status": 403,
13109
+ * "title": "Permission Denied",
13110
+ * "type": "permission-denied"
13111
+ * } */
13112
+ "application/problem+json": components["schemas"]["Problem"];
13113
+ };
13114
+ };
13115
+ /** @description Validation Error */
13116
+ 422: {
13117
+ headers: {
13118
+ [name: string]: unknown;
13119
+ };
13120
+ content: {
13121
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
13122
+ };
13123
+ };
13124
+ };
13125
+ };
12891
13126
  get_parking_metrics_v1_parking__parking_id__metrics_get: {
12892
13127
  parameters: {
12893
13128
  query?: {