api2convert 10.2.1 → 10.3.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.
Files changed (23) hide show
  1. checksums.yaml +4 -4
  2. data/AGENTS.md +1 -1
  3. data/README.md +5 -0
  4. data/docs/SDK_CONTRACT.md +57 -6
  5. data/lib/api2convert/client.rb +29 -5
  6. data/lib/api2convert/cloud_provider.rb +29 -0
  7. data/lib/api2convert/http/net_http_sender.rb +31 -3
  8. data/lib/api2convert/http/request.rb +7 -5
  9. data/lib/api2convert/http/transport.rb +18 -3
  10. data/lib/api2convert/model/cloud_input.rb +108 -0
  11. data/lib/api2convert/model/conversion.rb +7 -3
  12. data/lib/api2convert/model/input_file.rb +8 -3
  13. data/lib/api2convert/model/output_target.rb +78 -0
  14. data/lib/api2convert/resource/jobs.rb +6 -2
  15. data/lib/api2convert/resource/stats.rb +2 -1
  16. data/lib/api2convert/result.rb +51 -20
  17. data/lib/api2convert/support/data.rb +8 -1
  18. data/lib/api2convert/support/redactor.rb +83 -0
  19. data/lib/api2convert/upload/file_uploader.rb +2 -2
  20. data/lib/api2convert/version.rb +1 -1
  21. data/lib/api2convert.rb +4 -0
  22. data/openapi/api2convert.openapi.json +51 -51
  23. metadata +6 -2
data/openapi/api2convert.openapi.json CHANGED
@@ -61,7 +61,7 @@
61
61
  }
62
62
  },
63
63
  {
64
- "name": "X-Oc-Token",
64
+ "name": "X-Api2convert-Token",
65
65
  "in": "header",
66
66
  "description": "Token for authentication for the current job",
67
67
  "required": false,
@@ -71,7 +71,7 @@
71
71
  },
72
72
  {
73
73
  "in": "header",
74
- "name": "X-Oc-Api-Key",
74
+ "name": "X-Api2convert-Api-Key",
75
75
  "description": "Api key for the user to filter.",
76
76
  "required": false,
77
77
  "schema": {
@@ -126,7 +126,7 @@
126
126
  "parameters": [
127
127
  {
128
128
  "in": "header",
129
- "name": "X-Oc-Api-Key",
129
+ "name": "X-Api2convert-Api-Key",
130
130
  "description": "Api key for the user to filter.",
131
131
  "required": true,
132
132
  "schema": {
@@ -134,7 +134,7 @@
134
134
  }
135
135
  },
136
136
  {
137
- "name": "X-Oc-Token",
137
+ "name": "X-Api2convert-Token",
138
138
  "in": "header",
139
139
  "description": "Token for authentication for the current job",
140
140
  "required": false,
@@ -144,7 +144,7 @@
144
144
  },
145
145
  {
146
146
  "in": "header",
147
- "name": "X-Oc-Api-Key",
147
+ "name": "X-Api2convert-Api-Key",
148
148
  "description": "Api key for the user to filter.",
149
149
  "required": false,
150
150
  "schema": {
@@ -237,7 +237,7 @@
237
237
  ],
238
238
  "parameters": [
239
239
  {
240
- "name": "X-Oc-Token",
240
+ "name": "X-Api2convert-Token",
241
241
  "in": "header",
242
242
  "description": "Token for authentication for the current job",
243
243
  "required": false,
@@ -247,7 +247,7 @@
247
247
  },
248
248
  {
249
249
  "in": "header",
250
- "name": "X-Oc-Api-Key",
250
+ "name": "X-Api2convert-Api-Key",
251
251
  "description": "Api key for the user to filter.",
252
252
  "required": false,
253
253
  "schema": {
@@ -304,7 +304,7 @@
304
304
  ],
305
305
  "parameters": [
306
306
  {
307
- "name": "X-Oc-Token",
307
+ "name": "X-Api2convert-Token",
308
308
  "in": "header",
309
309
  "description": "Token for authentication for the current job",
310
310
  "required": false,
@@ -314,7 +314,7 @@
314
314
  },
315
315
  {
316
316
  "in": "header",
317
- "name": "X-Oc-Api-Key",
317
+ "name": "X-Api2convert-Api-Key",
318
318
  "description": "Api key for the user to filter.",
319
319
  "required": false,
320
320
  "schema": {
@@ -384,7 +384,7 @@
384
384
  ],
385
385
  "parameters": [
386
386
  {
387
- "name": "X-Oc-Token",
387
+ "name": "X-Api2convert-Token",
388
388
  "in": "header",
389
389
  "description": "Token for authentication for the current job",
390
390
  "required": false,
@@ -394,7 +394,7 @@
394
394
  },
395
395
  {
396
396
  "in": "header",
397
- "name": "X-Oc-Api-Key",
397
+ "name": "X-Api2convert-Api-Key",
398
398
  "description": "Api key for the user to filter.",
399
399
  "required": false,
400
400
  "schema": {
@@ -456,7 +456,7 @@
456
456
  ],
457
457
  "parameters": [
458
458
  {
459
- "name": "X-Oc-Token",
459
+ "name": "X-Api2convert-Token",
460
460
  "in": "header",
461
461
  "description": "Token for authentication for the current job",
462
462
  "required": false,
@@ -466,7 +466,7 @@
466
466
  },
467
467
  {
468
468
  "in": "header",
469
- "name": "X-Oc-Api-Key",
469
+ "name": "X-Api2convert-Api-Key",
470
470
  "description": "Api key for the user to filter.",
471
471
  "required": false,
472
472
  "schema": {
@@ -526,7 +526,7 @@
526
526
  ],
527
527
  "parameters": [
528
528
  {
529
- "name": "X-Oc-Token",
529
+ "name": "X-Api2convert-Token",
530
530
  "in": "header",
531
531
  "description": "Token for authentication for the current job",
532
532
  "required": false,
@@ -536,7 +536,7 @@
536
536
  },
537
537
  {
538
538
  "in": "header",
539
- "name": "X-Oc-Api-Key",
539
+ "name": "X-Api2convert-Api-Key",
540
540
  "description": "Api key for the user to filter.",
541
541
  "required": false,
542
542
  "schema": {
@@ -616,7 +616,7 @@
616
616
  ],
617
617
  "parameters": [
618
618
  {
619
- "name": "X-Oc-Token",
619
+ "name": "X-Api2convert-Token",
620
620
  "in": "header",
621
621
  "description": "Token for authentication for the current job",
622
622
  "required": false,
@@ -626,7 +626,7 @@
626
626
  },
627
627
  {
628
628
  "in": "header",
629
- "name": "X-Oc-Api-Key",
629
+ "name": "X-Api2convert-Api-Key",
630
630
  "description": "Api key for the user to filter.",
631
631
  "required": false,
632
632
  "schema": {
@@ -692,7 +692,7 @@
692
692
  ],
693
693
  "parameters": [
694
694
  {
695
- "name": "X-Oc-Token",
695
+ "name": "X-Api2convert-Token",
696
696
  "in": "header",
697
697
  "description": "Token for authentication for the current job",
698
698
  "required": false,
@@ -702,7 +702,7 @@
702
702
  },
703
703
  {
704
704
  "in": "header",
705
- "name": "X-Oc-Api-Key",
705
+ "name": "X-Api2convert-Api-Key",
706
706
  "description": "Api key for the user to filter.",
707
707
  "required": false,
708
708
  "schema": {
@@ -771,7 +771,7 @@
771
771
  ],
772
772
  "parameters": [
773
773
  {
774
- "name": "X-Oc-Token",
774
+ "name": "X-Api2convert-Token",
775
775
  "in": "header",
776
776
  "description": "Token for authentication for the current job",
777
777
  "required": false,
@@ -781,7 +781,7 @@
781
781
  },
782
782
  {
783
783
  "in": "header",
784
- "name": "X-Oc-Api-Key",
784
+ "name": "X-Api2convert-Api-Key",
785
785
  "description": "Api key for the user to filter.",
786
786
  "required": false,
787
787
  "schema": {
@@ -881,7 +881,7 @@
881
881
  ],
882
882
  "parameters": [
883
883
  {
884
- "name": "X-Oc-Token",
884
+ "name": "X-Api2convert-Token",
885
885
  "in": "header",
886
886
  "description": "Token for authentication for the current job",
887
887
  "required": false,
@@ -891,7 +891,7 @@
891
891
  },
892
892
  {
893
893
  "in": "header",
894
- "name": "X-Oc-Api-Key",
894
+ "name": "X-Api2convert-Api-Key",
895
895
  "description": "Api key for the user to filter.",
896
896
  "required": false,
897
897
  "schema": {
@@ -961,7 +961,7 @@
961
961
  ],
962
962
  "parameters": [
963
963
  {
964
- "name": "X-Oc-Token",
964
+ "name": "X-Api2convert-Token",
965
965
  "in": "header",
966
966
  "description": "Token for authentication for the current job",
967
967
  "required": false,
@@ -971,7 +971,7 @@
971
971
  },
972
972
  {
973
973
  "in": "header",
974
- "name": "X-Oc-Api-Key",
974
+ "name": "X-Api2convert-Api-Key",
975
975
  "description": "Api key for the user to filter.",
976
976
  "required": false,
977
977
  "schema": {
@@ -1047,7 +1047,7 @@
1047
1047
  ],
1048
1048
  "parameters": [
1049
1049
  {
1050
- "name": "X-Oc-Token",
1050
+ "name": "X-Api2convert-Token",
1051
1051
  "in": "header",
1052
1052
  "description": "Token for authentication for the current job",
1053
1053
  "required": false,
@@ -1057,7 +1057,7 @@
1057
1057
  },
1058
1058
  {
1059
1059
  "in": "header",
1060
- "name": "X-Oc-Api-Key",
1060
+ "name": "X-Api2convert-Api-Key",
1061
1061
  "description": "Api key for the user to filter.",
1062
1062
  "required": false,
1063
1063
  "schema": {
@@ -1141,7 +1141,7 @@
1141
1141
  ],
1142
1142
  "parameters": [
1143
1143
  {
1144
- "name": "X-Oc-Token",
1144
+ "name": "X-Api2convert-Token",
1145
1145
  "in": "header",
1146
1146
  "description": "Token for authentication for the current job",
1147
1147
  "required": false,
@@ -1151,7 +1151,7 @@
1151
1151
  },
1152
1152
  {
1153
1153
  "in": "header",
1154
- "name": "X-Oc-Api-Key",
1154
+ "name": "X-Api2convert-Api-Key",
1155
1155
  "description": "Api key for the user to filter.",
1156
1156
  "required": false,
1157
1157
  "schema": {
@@ -1217,7 +1217,7 @@
1217
1217
  ],
1218
1218
  "parameters": [
1219
1219
  {
1220
- "name": "X-Oc-Token",
1220
+ "name": "X-Api2convert-Token",
1221
1221
  "in": "header",
1222
1222
  "description": "Token for authentication for the current job",
1223
1223
  "required": false,
@@ -1227,7 +1227,7 @@
1227
1227
  },
1228
1228
  {
1229
1229
  "in": "header",
1230
- "name": "X-Oc-Api-Key",
1230
+ "name": "X-Api2convert-Api-Key",
1231
1231
  "description": "Api key for the user to filter.",
1232
1232
  "required": false,
1233
1233
  "schema": {
@@ -1296,7 +1296,7 @@
1296
1296
  ],
1297
1297
  "parameters": [
1298
1298
  {
1299
- "name": "X-Oc-Token",
1299
+ "name": "X-Api2convert-Token",
1300
1300
  "in": "header",
1301
1301
  "description": "Token for authentication for the current job",
1302
1302
  "required": false,
@@ -1306,7 +1306,7 @@
1306
1306
  },
1307
1307
  {
1308
1308
  "in": "header",
1309
- "name": "X-Oc-Api-Key",
1309
+ "name": "X-Api2convert-Api-Key",
1310
1310
  "description": "Api key for the user to filter.",
1311
1311
  "required": false,
1312
1312
  "schema": {
@@ -1411,7 +1411,7 @@
1411
1411
  }
1412
1412
  },
1413
1413
  {
1414
- "name": "X-Oc-Token",
1414
+ "name": "X-Api2convert-Token",
1415
1415
  "in": "header",
1416
1416
  "description": "Token for authentication for the current job",
1417
1417
  "required": false,
@@ -1421,7 +1421,7 @@
1421
1421
  },
1422
1422
  {
1423
1423
  "in": "header",
1424
- "name": "X-Oc-Api-Key",
1424
+ "name": "X-Api2convert-Api-Key",
1425
1425
  "description": "Api key for the user to filter.",
1426
1426
  "required": false,
1427
1427
  "schema": {
@@ -1481,7 +1481,7 @@
1481
1481
  ],
1482
1482
  "parameters": [
1483
1483
  {
1484
- "name": "X-Oc-Token",
1484
+ "name": "X-Api2convert-Token",
1485
1485
  "in": "header",
1486
1486
  "description": "Token for authentication for the current job",
1487
1487
  "required": false,
@@ -1491,7 +1491,7 @@
1491
1491
  },
1492
1492
  {
1493
1493
  "in": "header",
1494
- "name": "X-Oc-Api-Key",
1494
+ "name": "X-Api2convert-Api-Key",
1495
1495
  "description": "Api key for the user to filter.",
1496
1496
  "required": false,
1497
1497
  "schema": {
@@ -1566,7 +1566,7 @@
1566
1566
  ],
1567
1567
  "parameters": [
1568
1568
  {
1569
- "name": "X-Oc-Token",
1569
+ "name": "X-Api2convert-Token",
1570
1570
  "in": "header",
1571
1571
  "description": "Token for authentication for the current job",
1572
1572
  "required": false,
@@ -1576,7 +1576,7 @@
1576
1576
  },
1577
1577
  {
1578
1578
  "in": "header",
1579
- "name": "X-Oc-Api-Key",
1579
+ "name": "X-Api2convert-Api-Key",
1580
1580
  "description": "Api key for the user to filter.",
1581
1581
  "required": false,
1582
1582
  "schema": {
@@ -1642,7 +1642,7 @@
1642
1642
  ],
1643
1643
  "parameters": [
1644
1644
  {
1645
- "name": "X-Oc-Token",
1645
+ "name": "X-Api2convert-Token",
1646
1646
  "in": "header",
1647
1647
  "description": "Token for authentication for the current job",
1648
1648
  "required": false,
@@ -1652,7 +1652,7 @@
1652
1652
  },
1653
1653
  {
1654
1654
  "in": "header",
1655
- "name": "X-Oc-Api-Key",
1655
+ "name": "X-Api2convert-Api-Key",
1656
1656
  "description": "Api key for the user to filter.",
1657
1657
  "required": false,
1658
1658
  "schema": {
@@ -1711,7 +1711,7 @@
1711
1711
  ],
1712
1712
  "parameters": [
1713
1713
  {
1714
- "name": "X-Oc-Token",
1714
+ "name": "X-Api2convert-Token",
1715
1715
  "in": "header",
1716
1716
  "description": "Token for authentication for the current job",
1717
1717
  "required": false,
@@ -1721,7 +1721,7 @@
1721
1721
  },
1722
1722
  {
1723
1723
  "in": "header",
1724
- "name": "X-Oc-Api-Key",
1724
+ "name": "X-Api2convert-Api-Key",
1725
1725
  "description": "Api key for the user to filter.",
1726
1726
  "required": false,
1727
1727
  "schema": {
@@ -1802,7 +1802,7 @@
1802
1802
  ],
1803
1803
  "parameters": [
1804
1804
  {
1805
- "name": "X-Oc-Token",
1805
+ "name": "X-Api2convert-Token",
1806
1806
  "in": "header",
1807
1807
  "description": "Token for authentication for the current job",
1808
1808
  "required": false,
@@ -1812,7 +1812,7 @@
1812
1812
  },
1813
1813
  {
1814
1814
  "in": "header",
1815
- "name": "X-Oc-Api-Key",
1815
+ "name": "X-Api2convert-Api-Key",
1816
1816
  "description": "Api key for the user to filter.",
1817
1817
  "required": false,
1818
1818
  "schema": {
@@ -1874,7 +1874,7 @@
1874
1874
  ],
1875
1875
  "parameters": [
1876
1876
  {
1877
- "name": "X-Oc-Token",
1877
+ "name": "X-Api2convert-Token",
1878
1878
  "in": "header",
1879
1879
  "description": "Token for authentication for the current job",
1880
1880
  "required": false,
@@ -1884,7 +1884,7 @@
1884
1884
  },
1885
1885
  {
1886
1886
  "in": "header",
1887
- "name": "X-Oc-Api-Key",
1887
+ "name": "X-Api2convert-Api-Key",
1888
1888
  "description": "Api key for the user to filter.",
1889
1889
  "required": false,
1890
1890
  "schema": {
@@ -2026,7 +2026,7 @@
2026
2026
  "parameters": [
2027
2027
  {
2028
2028
  "in": "header",
2029
- "name": "x-oc-api-key",
2029
+ "name": "x-api2convert-api-key",
2030
2030
  "description": "Api key for the user to filter.",
2031
2031
  "required": true,
2032
2032
  "schema": {
@@ -2297,7 +2297,7 @@
2297
2297
  "parameters": [
2298
2298
  {
2299
2299
  "in": "header",
2300
- "name": "x-oc-api-key",
2300
+ "name": "x-api2convert-api-key",
2301
2301
  "description": "Api key for the user to filter.",
2302
2302
  "required": true,
2303
2303
  "schema": {
@@ -2372,7 +2372,7 @@
2372
2372
  "parameters": [
2373
2373
  {
2374
2374
  "in": "header",
2375
- "name": "x-oc-api-key",
2375
+ "name": "x-api2convert-api-key",
2376
2376
  "description": "Api key for the user to filter.",
2377
2377
  "required": true,
2378
2378
  "schema": {
@@ -2447,7 +2447,7 @@
2447
2447
  "parameters": [
2448
2448
  {
2449
2449
  "in": "header",
2450
- "name": "x-oc-api-key",
2450
+ "name": "x-api2convert-api-key",
2451
2451
  "description": "Api key for the user to filter.",
2452
2452
  "required": true,
2453
2453
  "schema": {
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: api2convert
3
3
  version: !ruby/object:Gem::Version
4
- version: 10.2.1
4
+ version: 10.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Qaamgo Media GmbH
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-07-08 00:00:00.000000000 Z
11
+ date: 2026-07-12 00:00:00.000000000 Z
12
12
  dependencies: []
13
13
  description: Convert, compress and transform images, documents, audio, video, ebooks,
14
14
  archives and CAD — and run operations like OCR, merge, thumbnail and website capture
@@ -46,6 +46,7 @@ files:
46
46
  - examples/webhooks.rb
47
47
  - lib/api2convert.rb
48
48
  - lib/api2convert/client.rb
49
+ - lib/api2convert/cloud_provider.rb
49
50
  - lib/api2convert/config.rb
50
51
  - lib/api2convert/errors.rb
51
52
  - lib/api2convert/http/net_http_sender.rb
@@ -54,11 +55,13 @@ files:
54
55
  - lib/api2convert/http/transport.rb
55
56
  - lib/api2convert/input_type.rb
56
57
  - lib/api2convert/job_status.rb
58
+ - lib/api2convert/model/cloud_input.rb
57
59
  - lib/api2convert/model/conversion.rb
58
60
  - lib/api2convert/model/input_file.rb
59
61
  - lib/api2convert/model/job.rb
60
62
  - lib/api2convert/model/job_message.rb
61
63
  - lib/api2convert/model/output_file.rb
64
+ - lib/api2convert/model/output_target.rb
62
65
  - lib/api2convert/model/preset.rb
63
66
  - lib/api2convert/model/status.rb
64
67
  - lib/api2convert/resource/contracts.rb
@@ -68,6 +71,7 @@ files:
68
71
  - lib/api2convert/resource/stats.rb
69
72
  - lib/api2convert/result.rb
70
73
  - lib/api2convert/support/data.rb
74
+ - lib/api2convert/support/redactor.rb
71
75
  - lib/api2convert/support/secret.rb
72
76
  - lib/api2convert/upload/file_uploader.rb
73
77
  - lib/api2convert/upload/multipart_stream.rb