@opusdns/api 0.87.0 → 0.89.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/src/schema.d.ts CHANGED
@@ -282,7 +282,7 @@ export interface paths {
282
282
  patch: operations["patch_zone_rrsets_v1_dns__zone_name__rrsets_patch"];
283
283
  trace?: never;
284
284
  };
285
- "/v1/domain-forwards": {
285
+ "/v1/domain-forwards/{zone_name}/disable": {
286
286
  parameters: {
287
287
  query?: never;
288
288
  header?: never;
@@ -295,31 +295,11 @@ export interface paths {
295
295
  delete?: never;
296
296
  options?: never;
297
297
  head?: never;
298
- /** Patch Redirects */
299
- patch: operations["patch_redirects_v1_domain_forwards_patch"];
300
- trace?: never;
301
- };
302
- "/v1/domain-forwards/{zone_name}": {
303
- parameters: {
304
- query?: never;
305
- header?: never;
306
- path?: never;
307
- cookie?: never;
308
- };
309
- /** Get Redirects */
310
- get: operations["get_redirects_v1_domain_forwards__zone_name__get"];
311
- /** Update Redirects */
312
- put: operations["update_redirects_v1_domain_forwards__zone_name__put"];
313
- /** Create Redirects */
314
- post: operations["create_redirects_v1_domain_forwards__zone_name__post"];
315
- /** Delete Redirects */
316
- delete: operations["delete_redirects_v1_domain_forwards__zone_name__delete"];
317
- options?: never;
318
- head?: never;
319
- patch?: never;
298
+ /** Disable Domain Forward */
299
+ patch: operations["disable_domain_forward_v1_domain_forwards__zone_name__disable_patch"];
320
300
  trace?: never;
321
301
  };
322
- "/v1/domain-forwards/{zone_name}/disable": {
302
+ "/v1/domain-forwards/{zone_name}/enable": {
323
303
  parameters: {
324
304
  query?: never;
325
305
  header?: never;
@@ -332,25 +312,28 @@ export interface paths {
332
312
  delete?: never;
333
313
  options?: never;
334
314
  head?: never;
335
- /** Disable Domain Forward */
336
- patch: operations["disable_domain_forward_v1_domain_forwards__zone_name__disable_patch"];
315
+ /** Enable Domain Forward */
316
+ patch: operations["enable_domain_forward_v1_domain_forwards__zone_name__enable_patch"];
337
317
  trace?: never;
338
318
  };
339
- "/v1/domain-forwards/{zone_name}/enable": {
319
+ "/v1/domain-forwards/{zone_name}/{request_protocol}": {
340
320
  parameters: {
341
321
  query?: never;
342
322
  header?: never;
343
323
  path?: never;
344
324
  cookie?: never;
345
325
  };
346
- get?: never;
347
- put?: never;
348
- post?: never;
349
- delete?: never;
326
+ /** Get Domain Forward */
327
+ get: operations["get_domain_forward_v1_domain_forwards__zone_name___request_protocol__get"];
328
+ /** Update Domain Forward */
329
+ put: operations["update_domain_forward_v1_domain_forwards__zone_name___request_protocol__put"];
330
+ /** Create Domain Forward */
331
+ post: operations["create_domain_forward_v1_domain_forwards__zone_name___request_protocol__post"];
332
+ /** Delete Domain Forward */
333
+ delete: operations["delete_domain_forward_v1_domain_forwards__zone_name___request_protocol__delete"];
350
334
  options?: never;
351
335
  head?: never;
352
- /** Enable Domain Forward */
353
- patch: operations["enable_domain_forward_v1_domain_forwards__zone_name__enable_patch"];
336
+ patch?: never;
354
337
  trace?: never;
355
338
  };
356
339
  "/v1/domain-search/suggest": {
@@ -929,6 +912,26 @@ export interface paths {
929
912
  patch: operations["update_organization_v1_organizations__organization_id__patch"];
930
913
  trace?: never;
931
914
  };
915
+ "/v1/organizations/{organization_id}/billing/invoices": {
916
+ parameters: {
917
+ query?: never;
918
+ header?: never;
919
+ path?: never;
920
+ cookie?: never;
921
+ };
922
+ /**
923
+ * List all invoices for the organization
924
+ * @description Retrieves a paginated list of all invoices for the organization
925
+ */
926
+ get: operations["list_invoices_v1_organizations__organization_id__billing_invoices_get"];
927
+ put?: never;
928
+ post?: never;
929
+ delete?: never;
930
+ options?: never;
931
+ head?: never;
932
+ patch?: never;
933
+ trace?: never;
934
+ };
932
935
  "/v1/organizations/{organization_id}/pricing/product-type/{product_type}": {
933
936
  parameters: {
934
937
  query?: never;
@@ -2248,6 +2251,33 @@ export interface components {
2248
2251
  */
2249
2252
  updated_on?: Date;
2250
2253
  };
2254
+ /** DomainForward */
2255
+ DomainForward: {
2256
+ /**
2257
+ * Created On
2258
+ * Format: date-time
2259
+ */
2260
+ created_on: Date;
2261
+ /** Redirects */
2262
+ redirects: components["schemas"]["HttpRedirect"][];
2263
+ request_protocol: components["schemas"]["HttpProtocol"];
2264
+ /**
2265
+ * Updated On
2266
+ * Format: date-time
2267
+ */
2268
+ updated_on: Date;
2269
+ /** Wildcard */
2270
+ wildcard: boolean;
2271
+ /** Zone Name */
2272
+ zone_name: string;
2273
+ };
2274
+ /** DomainForwardRequest */
2275
+ DomainForwardRequest: {
2276
+ /** Redirects */
2277
+ redirects: components["schemas"]["HttpRedirect"][];
2278
+ /** Wildcard */
2279
+ wildcard: boolean;
2280
+ };
2251
2281
  /** DomainLifecycleBase */
2252
2282
  DomainLifecycleBase: {
2253
2283
  /**
@@ -2864,6 +2894,26 @@ export interface components {
2864
2894
  /** Problem type */
2865
2895
  type: string;
2866
2896
  };
2897
+ /**
2898
+ * HttpProtocol
2899
+ * @enum {string}
2900
+ */
2901
+ HttpProtocol: "http" | "https";
2902
+ /** HttpRedirect */
2903
+ HttpRedirect: {
2904
+ redirect_code: components["schemas"]["RedirectCode"];
2905
+ /** Request Path */
2906
+ request_path: string;
2907
+ /** Request Subdomain */
2908
+ request_subdomain?: string | null;
2909
+ /** Target Domain */
2910
+ target_domain: string;
2911
+ /** Target Path */
2912
+ target_path: string;
2913
+ target_protocol: components["schemas"]["HttpProtocol"];
2914
+ /** Target Subdomain */
2915
+ target_subdomain?: string | null;
2916
+ };
2867
2917
  /** IdnBase */
2868
2918
  IdnBase: {
2869
2919
  /**
@@ -2877,6 +2927,79 @@ export interface components {
2877
2927
  */
2878
2928
  idn_tables?: string[] | null;
2879
2929
  };
2930
+ /** InvoiceResponse */
2931
+ InvoiceResponse: {
2932
+ /**
2933
+ * Amount
2934
+ * @description Total invoice amount
2935
+ */
2936
+ amount: string;
2937
+ /** @description Invoice currency */
2938
+ currency: components["schemas"]["Currency"];
2939
+ /**
2940
+ * External Id
2941
+ * @description Lago ID (external) for this invoice
2942
+ */
2943
+ external_id: string;
2944
+ /**
2945
+ * Fees Amount
2946
+ * @description Fees amount
2947
+ */
2948
+ fees_amount: string;
2949
+ /**
2950
+ * File Url
2951
+ * @description URL to invoice PDF file
2952
+ */
2953
+ file_url: string;
2954
+ /** @description Invoice type */
2955
+ invoice_type: components["schemas"]["InvoiceResponseType"];
2956
+ /**
2957
+ * Issuing Date
2958
+ * Format: date-time
2959
+ * @description Invoice issuing date
2960
+ */
2961
+ issuing_date: Date;
2962
+ /**
2963
+ * Number
2964
+ * @description Invoice number
2965
+ */
2966
+ number: string;
2967
+ /**
2968
+ * Payment Due Date
2969
+ * Format: date-time
2970
+ * @description Payment due date
2971
+ */
2972
+ payment_due_date: Date;
2973
+ /**
2974
+ * Payment Overdue
2975
+ * @description Whether payment is overdue
2976
+ */
2977
+ payment_overdue: boolean;
2978
+ /** @description Payment status */
2979
+ payment_status: components["schemas"]["InvoiceResponsePaymentStatus"];
2980
+ /** @description Invoice status */
2981
+ status: components["schemas"]["InvoiceResponseStatus"];
2982
+ /**
2983
+ * Taxes Amount
2984
+ * @description Taxes amount
2985
+ */
2986
+ taxes_amount: string;
2987
+ };
2988
+ /**
2989
+ * InvoiceResponsePaymentStatus
2990
+ * @enum {string}
2991
+ */
2992
+ InvoiceResponsePaymentStatus: "pending" | "failed" | "succeeded";
2993
+ /**
2994
+ * InvoiceResponseStatus
2995
+ * @enum {string}
2996
+ */
2997
+ InvoiceResponseStatus: "draft" | "finalized" | "failed" | "pending" | "voided";
2998
+ /**
2999
+ * InvoiceResponseType
3000
+ * @enum {string}
3001
+ */
3002
+ InvoiceResponseType: "subscription" | "add_on" | "credit" | "one_off" | "advance_charges" | "progressive_billing";
2880
3003
  /**
2881
3004
  * IpRestrictionCreate
2882
3005
  * @description Create an IP restriction for an organization.
@@ -3561,17 +3684,17 @@ export interface components {
3561
3684
  /** Results */
3562
3685
  results: components["schemas"]["EventResponse"][];
3563
3686
  };
3564
- /** Pagination[Organization] */
3565
- Pagination_Organization_: {
3687
+ /** Pagination[InvoiceResponse] */
3688
+ Pagination_InvoiceResponse_: {
3566
3689
  pagination: components["schemas"]["PaginationMetadata"];
3567
3690
  /** Results */
3568
- results: components["schemas"]["Organization"][];
3691
+ results: components["schemas"]["InvoiceResponse"][];
3569
3692
  };
3570
- /** Pagination[Redirect] */
3571
- Pagination_Redirect_: {
3693
+ /** Pagination[Organization] */
3694
+ Pagination_Organization_: {
3572
3695
  pagination: components["schemas"]["PaginationMetadata"];
3573
3696
  /** Results */
3574
- results: components["schemas"]["Redirect"][];
3697
+ results: components["schemas"]["Organization"][];
3575
3698
  };
3576
3699
  /** Pagination[User] */
3577
3700
  Pagination_User_: {
@@ -3717,73 +3840,11 @@ export interface components {
3717
3840
  */
3718
3841
  rdap_server?: string | null;
3719
3842
  };
3720
- /** Redirect */
3721
- Redirect: {
3722
- /** Redirect Code */
3723
- redirect_code: number;
3724
- /** Request Domain */
3725
- request_domain: string;
3726
- /** Request Path */
3727
- request_path: string;
3728
- /** Request Protocol */
3729
- request_protocol: string;
3730
- /** Request Subdomain */
3731
- request_subdomain: string;
3732
- /** Target Domain */
3733
- target_domain: string;
3734
- /** Target Path */
3735
- target_path: string;
3736
- /** Target Protocol */
3737
- target_protocol: string;
3738
- /** Target Subdomain */
3739
- target_subdomain: string;
3740
- };
3741
- /** RedirectPatchOp */
3742
- RedirectPatchOp: {
3743
- op: components["schemas"]["PatchOp"];
3744
- /** Redirect */
3745
- redirect: components["schemas"]["Redirect"] | components["schemas"]["RedirectRemove"];
3746
- };
3747
- /** RedirectPatchOps */
3748
- RedirectPatchOps: {
3749
- /** Ops */
3750
- ops: components["schemas"]["RedirectPatchOp"][];
3751
- };
3752
- /** RedirectRemove */
3753
- RedirectRemove: {
3754
- /** Request Domain */
3755
- request_domain: string;
3756
- /** Request Path */
3757
- request_path: string;
3758
- /** Request Protocol */
3759
- request_protocol: string;
3760
- /** Request Subdomain */
3761
- request_subdomain: string;
3762
- };
3763
- /** RedirectSet */
3764
- RedirectSet: {
3765
- /** Redirects */
3766
- redirects: components["schemas"]["RedirectUpdate"][];
3767
- };
3768
- /** RedirectUpdate */
3769
- RedirectUpdate: {
3770
- /** Redirect Code */
3771
- redirect_code: number;
3772
- /** Request Path */
3773
- request_path: string;
3774
- /** Request Protocol */
3775
- request_protocol: string;
3776
- /** Request Subdomain */
3777
- request_subdomain: string;
3778
- /** Target Domain */
3779
- target_domain: string;
3780
- /** Target Path */
3781
- target_path: string;
3782
- /** Target Protocol */
3783
- target_protocol: string;
3784
- /** Target Subdomain */
3785
- target_subdomain: string;
3786
- };
3843
+ /**
3844
+ * RedirectCode
3845
+ * @enum {integer}
3846
+ */
3847
+ RedirectCode: 301 | 302 | 307 | 308;
3787
3848
  /**
3788
3849
  * RegistrantChangeType
3789
3850
  * @enum {string}
@@ -5721,18 +5782,17 @@ export interface operations {
5721
5782
  };
5722
5783
  };
5723
5784
  };
5724
- patch_redirects_v1_domain_forwards_patch: {
5785
+ disable_domain_forward_v1_domain_forwards__zone_name__disable_patch: {
5725
5786
  parameters: {
5726
5787
  query?: never;
5727
5788
  header?: never;
5728
- path?: never;
5729
- cookie?: never;
5730
- };
5731
- requestBody: {
5732
- content: {
5733
- "application/json": components["schemas"]["RedirectPatchOps"];
5789
+ path: {
5790
+ /** @description DNS zone name (trailing dot optional) */
5791
+ zone_name: string;
5734
5792
  };
5793
+ cookie?: never;
5735
5794
  };
5795
+ requestBody?: never;
5736
5796
  responses: {
5737
5797
  /** @description Successful Response */
5738
5798
  204: {
@@ -5752,11 +5812,10 @@ export interface operations {
5752
5812
  };
5753
5813
  };
5754
5814
  };
5755
- get_redirects_v1_domain_forwards__zone_name__get: {
5815
+ enable_domain_forward_v1_domain_forwards__zone_name__enable_patch: {
5756
5816
  parameters: {
5757
5817
  query?: {
5758
- page?: number;
5759
- page_size?: number;
5818
+ auto_create_zone?: boolean;
5760
5819
  };
5761
5820
  header?: never;
5762
5821
  path: {
@@ -5768,13 +5827,11 @@ export interface operations {
5768
5827
  requestBody?: never;
5769
5828
  responses: {
5770
5829
  /** @description Successful Response */
5771
- 200: {
5830
+ 204: {
5772
5831
  headers: {
5773
5832
  [name: string]: unknown;
5774
5833
  };
5775
- content: {
5776
- "application/json": components["schemas"]["Pagination_Redirect_"];
5777
- };
5834
+ content?: never;
5778
5835
  };
5779
5836
  /** @description Validation Error */
5780
5837
  422: {
@@ -5787,43 +5844,26 @@ export interface operations {
5787
5844
  };
5788
5845
  };
5789
5846
  };
5790
- update_redirects_v1_domain_forwards__zone_name__put: {
5847
+ get_domain_forward_v1_domain_forwards__zone_name___request_protocol__get: {
5791
5848
  parameters: {
5792
5849
  query?: never;
5793
5850
  header?: never;
5794
5851
  path: {
5852
+ request_protocol: components["schemas"]["HttpProtocol"];
5795
5853
  /** @description DNS zone name (trailing dot optional) */
5796
5854
  zone_name: string;
5797
5855
  };
5798
5856
  cookie?: never;
5799
5857
  };
5800
- requestBody: {
5801
- content: {
5802
- "application/json": components["schemas"]["RedirectSet"];
5803
- };
5804
- };
5858
+ requestBody?: never;
5805
5859
  responses: {
5806
5860
  /** @description Successful Response */
5807
- 204: {
5808
- headers: {
5809
- [name: string]: unknown;
5810
- };
5811
- content?: never;
5812
- };
5813
- /** @description Conflict */
5814
- 409: {
5861
+ 200: {
5815
5862
  headers: {
5816
5863
  [name: string]: unknown;
5817
5864
  };
5818
5865
  content: {
5819
- /** @example {
5820
- * "code": "ERROR_DOMAIN_FORWARD_REDIRECT_NOT_EXISTS",
5821
- * "detail": "Redirect does not exist for A, d, d, i, t, i, o, n, a, l, , e, r, r, o, r, , c, o, n, t, e, x, t, .",
5822
- * "status": 409,
5823
- * "title": "Domain Forward Error",
5824
- * "type": "domain-forward-redirect-not-exists"
5825
- * } */
5826
- "application/problem+json": components["schemas"]["Problem"];
5866
+ "application/json": components["schemas"]["DomainForward"];
5827
5867
  };
5828
5868
  };
5829
5869
  /** @description Validation Error */
@@ -5837,11 +5877,12 @@ export interface operations {
5837
5877
  };
5838
5878
  };
5839
5879
  };
5840
- create_redirects_v1_domain_forwards__zone_name__post: {
5880
+ update_domain_forward_v1_domain_forwards__zone_name___request_protocol__put: {
5841
5881
  parameters: {
5842
5882
  query?: never;
5843
5883
  header?: never;
5844
5884
  path: {
5885
+ request_protocol: components["schemas"]["HttpProtocol"];
5845
5886
  /** @description DNS zone name (trailing dot optional) */
5846
5887
  zone_name: string;
5847
5888
  };
@@ -5849,16 +5890,18 @@ export interface operations {
5849
5890
  };
5850
5891
  requestBody: {
5851
5892
  content: {
5852
- "application/json": components["schemas"]["RedirectSet"];
5893
+ "application/json": components["schemas"]["DomainForwardRequest"];
5853
5894
  };
5854
5895
  };
5855
5896
  responses: {
5856
5897
  /** @description Successful Response */
5857
- 201: {
5898
+ 200: {
5858
5899
  headers: {
5859
5900
  [name: string]: unknown;
5860
5901
  };
5861
- content?: never;
5902
+ content: {
5903
+ "application/json": components["schemas"]["DomainForward"];
5904
+ };
5862
5905
  };
5863
5906
  /** @description Conflict */
5864
5907
  409: {
@@ -5867,11 +5910,11 @@ export interface operations {
5867
5910
  };
5868
5911
  content: {
5869
5912
  /** @example {
5870
- * "code": "ERROR_DOMAIN_FORWARD_REDIRECT_ALREADY_EXISTS",
5871
- * "detail": "Redirect already exists for A, d, d, i, t, i, o, n, a, l, , e, r, r, o, r, , c, o, n, t, e, x, t, .",
5913
+ * "code": "ERROR_DOMAIN_FORWARD_REDIRECT_NOT_EXISTS",
5914
+ * "detail": "Redirect does not exist for A, d, d, i, t, i, o, n, a, l, , e, r, r, o, r, , c, o, n, t, e, x, t, .",
5872
5915
  * "status": 409,
5873
5916
  * "title": "Domain Forward Error",
5874
- * "type": "domain-forward-redirect-already-exists"
5917
+ * "type": "domain-forward-redirect-not-exists"
5875
5918
  * } */
5876
5919
  "application/problem+json": components["schemas"]["Problem"];
5877
5920
  };
@@ -5887,54 +5930,47 @@ export interface operations {
5887
5930
  };
5888
5931
  };
5889
5932
  };
5890
- delete_redirects_v1_domain_forwards__zone_name__delete: {
5933
+ create_domain_forward_v1_domain_forwards__zone_name___request_protocol__post: {
5891
5934
  parameters: {
5892
5935
  query?: never;
5893
5936
  header?: never;
5894
5937
  path: {
5938
+ request_protocol: components["schemas"]["HttpProtocol"];
5895
5939
  /** @description DNS zone name (trailing dot optional) */
5896
5940
  zone_name: string;
5897
5941
  };
5898
5942
  cookie?: never;
5899
5943
  };
5900
- requestBody?: never;
5944
+ requestBody: {
5945
+ content: {
5946
+ "application/json": components["schemas"]["DomainForwardRequest"];
5947
+ };
5948
+ };
5901
5949
  responses: {
5902
5950
  /** @description Successful Response */
5903
- 204: {
5904
- headers: {
5905
- [name: string]: unknown;
5906
- };
5907
- content?: never;
5908
- };
5909
- /** @description Validation Error */
5910
- 422: {
5951
+ 201: {
5911
5952
  headers: {
5912
5953
  [name: string]: unknown;
5913
5954
  };
5914
5955
  content: {
5915
- "application/problem+json": components["schemas"]["HTTPValidationError"];
5956
+ "application/json": components["schemas"]["DomainForward"];
5916
5957
  };
5917
5958
  };
5918
- };
5919
- };
5920
- disable_domain_forward_v1_domain_forwards__zone_name__disable_patch: {
5921
- parameters: {
5922
- query?: never;
5923
- header?: never;
5924
- path: {
5925
- /** @description DNS zone name (trailing dot optional) */
5926
- zone_name: string;
5927
- };
5928
- cookie?: never;
5929
- };
5930
- requestBody?: never;
5931
- responses: {
5932
- /** @description Successful Response */
5933
- 204: {
5959
+ /** @description Conflict */
5960
+ 409: {
5934
5961
  headers: {
5935
5962
  [name: string]: unknown;
5936
5963
  };
5937
- content?: never;
5964
+ content: {
5965
+ /** @example {
5966
+ * "code": "ERROR_DOMAIN_FORWARD_REDIRECT_ALREADY_EXISTS",
5967
+ * "detail": "Redirect already exists for A, d, d, i, t, i, o, n, a, l, , e, r, r, o, r, , c, o, n, t, e, x, t, .",
5968
+ * "status": 409,
5969
+ * "title": "Domain Forward Error",
5970
+ * "type": "domain-forward-redirect-already-exists"
5971
+ * } */
5972
+ "application/problem+json": components["schemas"]["Problem"];
5973
+ };
5938
5974
  };
5939
5975
  /** @description Validation Error */
5940
5976
  422: {
@@ -5947,13 +5983,12 @@ export interface operations {
5947
5983
  };
5948
5984
  };
5949
5985
  };
5950
- enable_domain_forward_v1_domain_forwards__zone_name__enable_patch: {
5986
+ delete_domain_forward_v1_domain_forwards__zone_name___request_protocol__delete: {
5951
5987
  parameters: {
5952
- query?: {
5953
- auto_create_zone?: boolean;
5954
- };
5988
+ query?: never;
5955
5989
  header?: never;
5956
5990
  path: {
5991
+ request_protocol: components["schemas"]["HttpProtocol"];
5957
5992
  /** @description DNS zone name (trailing dot optional) */
5958
5993
  zone_name: string;
5959
5994
  };
@@ -8307,6 +8342,40 @@ export interface operations {
8307
8342
  };
8308
8343
  };
8309
8344
  };
8345
+ list_invoices_v1_organizations__organization_id__billing_invoices_get: {
8346
+ parameters: {
8347
+ query?: {
8348
+ page?: number;
8349
+ page_size?: number;
8350
+ };
8351
+ header?: never;
8352
+ path: {
8353
+ organization_id: TypeId<"organization">;
8354
+ };
8355
+ cookie?: never;
8356
+ };
8357
+ requestBody?: never;
8358
+ responses: {
8359
+ /** @description Successful Response */
8360
+ 200: {
8361
+ headers: {
8362
+ [name: string]: unknown;
8363
+ };
8364
+ content: {
8365
+ "application/json": components["schemas"]["Pagination_InvoiceResponse_"];
8366
+ };
8367
+ };
8368
+ /** @description Validation Error */
8369
+ 422: {
8370
+ headers: {
8371
+ [name: string]: unknown;
8372
+ };
8373
+ content: {
8374
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
8375
+ };
8376
+ };
8377
+ };
8378
+ };
8310
8379
  get_pricing_plans_v1_organizations__organization_id__pricing_product_type__product_type__get: {
8311
8380
  parameters: {
8312
8381
  query?: {