@wevion/cli 1.0.3230 → 1.0.3244
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/openapi.json +2897 -643
- package/package.json +1 -1
package/openapi.json
CHANGED
|
@@ -26225,7 +26225,7 @@
|
|
|
26225
26225
|
"tags": [
|
|
26226
26226
|
"auth"
|
|
26227
26227
|
],
|
|
26228
|
-
"description": "Returns the authenticated user profile. Requires a valid JWT token. Includes `is_internal`: true when the profile is outside the clean analytics cohort (internal/staff e-mail domain, Gold/ULTRA, comped, allowlisted, backoffice staff role, or the demo account) — the same population every backoffice dashboard excludes. Used by the SPA to tag the session cohort in analytics; it carries no entitlement and grants nothing.",
|
|
26228
|
+
"description": "Returns the authenticated user profile. Requires a valid JWT token. Includes `is_internal`: true when the profile is outside the clean analytics cohort (internal/staff e-mail domain, Gold/ULTRA, comped, allowlisted, backoffice staff role, or the demo account) — the same population every backoffice dashboard excludes. Used by the SPA to tag the session cohort in analytics; it carries no entitlement and grants nothing. Also includes `organization_id` (the backoffice `organization.id`), used by the SPA to tag the Clarity Live session for a direct backoffice lookup.",
|
|
26229
26229
|
"security": [
|
|
26230
26230
|
{
|
|
26231
26231
|
"bearerAuth": []
|
|
@@ -26547,6 +26547,17 @@
|
|
|
26547
26547
|
"is_internal": {
|
|
26548
26548
|
"type": "boolean"
|
|
26549
26549
|
},
|
|
26550
|
+
"organization_id": {
|
|
26551
|
+
"anyOf": [
|
|
26552
|
+
{
|
|
26553
|
+
"format": "uuid",
|
|
26554
|
+
"type": "string"
|
|
26555
|
+
},
|
|
26556
|
+
{
|
|
26557
|
+
"type": "null"
|
|
26558
|
+
}
|
|
26559
|
+
]
|
|
26560
|
+
},
|
|
26550
26561
|
"subscription": {
|
|
26551
26562
|
"type": "object",
|
|
26552
26563
|
"required": [
|
|
@@ -27552,6 +27563,17 @@
|
|
|
27552
27563
|
"is_internal": {
|
|
27553
27564
|
"type": "boolean"
|
|
27554
27565
|
},
|
|
27566
|
+
"organization_id": {
|
|
27567
|
+
"anyOf": [
|
|
27568
|
+
{
|
|
27569
|
+
"format": "uuid",
|
|
27570
|
+
"type": "string"
|
|
27571
|
+
},
|
|
27572
|
+
{
|
|
27573
|
+
"type": "null"
|
|
27574
|
+
}
|
|
27575
|
+
]
|
|
27576
|
+
},
|
|
27555
27577
|
"subscription": {
|
|
27556
27578
|
"type": "object",
|
|
27557
27579
|
"required": [
|
|
@@ -28400,6 +28422,17 @@
|
|
|
28400
28422
|
"is_internal": {
|
|
28401
28423
|
"type": "boolean"
|
|
28402
28424
|
},
|
|
28425
|
+
"organization_id": {
|
|
28426
|
+
"anyOf": [
|
|
28427
|
+
{
|
|
28428
|
+
"format": "uuid",
|
|
28429
|
+
"type": "string"
|
|
28430
|
+
},
|
|
28431
|
+
{
|
|
28432
|
+
"type": "null"
|
|
28433
|
+
}
|
|
28434
|
+
]
|
|
28435
|
+
},
|
|
28403
28436
|
"subscription": {
|
|
28404
28437
|
"type": "object",
|
|
28405
28438
|
"required": [
|
|
@@ -104571,236 +104604,9 @@
|
|
|
104571
104604
|
"error"
|
|
104572
104605
|
],
|
|
104573
104606
|
"properties": {
|
|
104574
|
-
"
|
|
104575
|
-
"type": "string"
|
|
104576
|
-
},
|
|
104577
|
-
"message": {
|
|
104578
|
-
"type": "string"
|
|
104579
|
-
}
|
|
104580
|
-
}
|
|
104581
|
-
}
|
|
104582
|
-
}
|
|
104583
|
-
}
|
|
104584
|
-
},
|
|
104585
|
-
"403": {
|
|
104586
|
-
"description": "Forbidden - caller lacks the required role/permission",
|
|
104587
|
-
"content": {
|
|
104588
|
-
"application/json": {
|
|
104589
|
-
"schema": {
|
|
104590
|
-
"additionalProperties": false,
|
|
104591
|
-
"type": "object",
|
|
104592
|
-
"required": [
|
|
104593
|
-
"error"
|
|
104594
|
-
],
|
|
104595
|
-
"properties": {
|
|
104596
|
-
"error": {
|
|
104597
|
-
"type": "string"
|
|
104598
|
-
},
|
|
104599
|
-
"message": {
|
|
104600
|
-
"type": "string"
|
|
104601
|
-
}
|
|
104602
|
-
}
|
|
104603
|
-
}
|
|
104604
|
-
}
|
|
104605
|
-
}
|
|
104606
|
-
},
|
|
104607
|
-
"404": {
|
|
104608
|
-
"description": "Resource not found",
|
|
104609
|
-
"content": {
|
|
104610
|
-
"application/json": {
|
|
104611
|
-
"schema": {
|
|
104612
|
-
"additionalProperties": false,
|
|
104613
|
-
"type": "object",
|
|
104614
|
-
"required": [
|
|
104615
|
-
"error"
|
|
104616
|
-
],
|
|
104617
|
-
"properties": {
|
|
104618
|
-
"error": {
|
|
104619
|
-
"type": "string"
|
|
104620
|
-
},
|
|
104621
|
-
"message": {
|
|
104622
|
-
"type": "string"
|
|
104623
|
-
}
|
|
104624
|
-
}
|
|
104625
|
-
}
|
|
104626
|
-
}
|
|
104627
|
-
}
|
|
104628
|
-
}
|
|
104629
|
-
}
|
|
104630
|
-
},
|
|
104631
|
-
"post": {
|
|
104632
|
-
"operationId": "postApiV1CreativeHubAvatars",
|
|
104633
|
-
"summary": "Create Creative Hub avatar",
|
|
104634
|
-
"tags": [
|
|
104635
|
-
"creative-hub"
|
|
104636
|
-
],
|
|
104637
|
-
"description": "Queues a custom text-to-avatar or photo-to-avatar generation job.",
|
|
104638
|
-
"requestBody": {
|
|
104639
|
-
"required": true,
|
|
104640
|
-
"content": {
|
|
104641
|
-
"application/json": {
|
|
104642
|
-
"schema": {
|
|
104643
|
-
"additionalProperties": false,
|
|
104644
|
-
"type": "object",
|
|
104645
|
-
"required": [
|
|
104646
|
-
"mode",
|
|
104647
|
-
"name"
|
|
104648
|
-
],
|
|
104649
|
-
"properties": {
|
|
104650
|
-
"mode": {
|
|
104651
|
-
"anyOf": [
|
|
104652
|
-
{
|
|
104653
|
-
"type": "string",
|
|
104654
|
-
"enum": [
|
|
104655
|
-
"text"
|
|
104656
|
-
]
|
|
104657
|
-
},
|
|
104658
|
-
{
|
|
104659
|
-
"type": "string",
|
|
104660
|
-
"enum": [
|
|
104661
|
-
"photo"
|
|
104662
|
-
]
|
|
104663
|
-
}
|
|
104664
|
-
]
|
|
104665
|
-
},
|
|
104666
|
-
"name": {
|
|
104667
|
-
"minLength": 1,
|
|
104668
|
-
"maxLength": 120,
|
|
104669
|
-
"type": "string"
|
|
104670
|
-
},
|
|
104671
|
-
"prompt": {
|
|
104672
|
-
"maxLength": 2000,
|
|
104673
|
-
"type": "string"
|
|
104674
|
-
},
|
|
104675
|
-
"template_avatar_id": {
|
|
104676
|
-
"type": "string"
|
|
104677
|
-
},
|
|
104678
|
-
"source_image_url": {
|
|
104679
|
-
"type": "string"
|
|
104680
|
-
},
|
|
104681
|
-
"gender": {
|
|
104682
|
-
"maxLength": 20,
|
|
104683
|
-
"type": "string"
|
|
104684
|
-
},
|
|
104685
|
-
"age_bracket": {
|
|
104686
|
-
"maxLength": 20,
|
|
104687
|
-
"type": "string"
|
|
104688
|
-
},
|
|
104689
|
-
"scenario": {
|
|
104690
|
-
"maxLength": 40,
|
|
104691
|
-
"type": "string"
|
|
104692
|
-
},
|
|
104693
|
-
"voice_id": {
|
|
104694
|
-
"type": "string"
|
|
104695
|
-
}
|
|
104696
|
-
}
|
|
104697
|
-
}
|
|
104698
|
-
}
|
|
104699
|
-
}
|
|
104700
|
-
},
|
|
104701
|
-
"security": [
|
|
104702
|
-
{
|
|
104703
|
-
"bearerAuth": []
|
|
104704
|
-
},
|
|
104705
|
-
{
|
|
104706
|
-
"apiKeyAuth": []
|
|
104707
|
-
}
|
|
104708
|
-
],
|
|
104709
|
-
"responses": {
|
|
104710
|
-
"202": {
|
|
104711
|
-
"description": "Accepted - processing asynchronously",
|
|
104712
|
-
"content": {
|
|
104713
|
-
"application/json": {
|
|
104714
|
-
"schema": {
|
|
104715
|
-
"additionalProperties": false,
|
|
104716
|
-
"type": "object",
|
|
104717
|
-
"required": [
|
|
104718
|
-
"avatar_id",
|
|
104719
|
-
"generation_id",
|
|
104720
|
-
"status",
|
|
104721
|
-
"estimated_credits",
|
|
104722
|
-
"polling_interval_ms"
|
|
104723
|
-
],
|
|
104724
|
-
"properties": {
|
|
104725
|
-
"avatar_id": {
|
|
104726
|
-
"format": "uuid",
|
|
104727
|
-
"type": "string"
|
|
104728
|
-
},
|
|
104729
|
-
"generation_id": {
|
|
104730
|
-
"format": "uuid",
|
|
104731
|
-
"type": "string"
|
|
104732
|
-
},
|
|
104733
|
-
"status": {
|
|
104734
|
-
"type": "string"
|
|
104735
|
-
},
|
|
104736
|
-
"estimated_credits": {
|
|
104737
|
-
"minimum": 0,
|
|
104738
|
-
"type": "integer"
|
|
104739
|
-
},
|
|
104740
|
-
"polling_interval_ms": {
|
|
104741
|
-
"minimum": 1,
|
|
104742
|
-
"type": "integer"
|
|
104743
|
-
}
|
|
104744
|
-
}
|
|
104745
|
-
}
|
|
104746
|
-
}
|
|
104747
|
-
}
|
|
104748
|
-
},
|
|
104749
|
-
"400": {
|
|
104750
|
-
"description": "Invalid request - schema validation failed",
|
|
104751
|
-
"content": {
|
|
104752
|
-
"application/json": {
|
|
104753
|
-
"schema": {
|
|
104754
|
-
"additionalProperties": false,
|
|
104755
|
-
"type": "object",
|
|
104756
|
-
"required": [
|
|
104757
|
-
"error"
|
|
104758
|
-
],
|
|
104759
|
-
"properties": {
|
|
104760
|
-
"error": {
|
|
104761
|
-
"type": "string"
|
|
104762
|
-
},
|
|
104763
|
-
"message": {
|
|
104764
|
-
"type": "string"
|
|
104765
|
-
}
|
|
104766
|
-
}
|
|
104767
|
-
}
|
|
104768
|
-
}
|
|
104769
|
-
}
|
|
104770
|
-
},
|
|
104771
|
-
"401": {
|
|
104772
|
-
"description": "Unauthorized - missing or invalid bearer token",
|
|
104773
|
-
"content": {
|
|
104774
|
-
"application/json": {
|
|
104775
|
-
"schema": {
|
|
104776
|
-
"additionalProperties": false,
|
|
104777
|
-
"type": "object",
|
|
104778
|
-
"required": [
|
|
104779
|
-
"error"
|
|
104780
|
-
],
|
|
104781
|
-
"properties": {
|
|
104782
|
-
"error": {
|
|
104607
|
+
"code": {
|
|
104783
104608
|
"type": "string"
|
|
104784
104609
|
},
|
|
104785
|
-
"message": {
|
|
104786
|
-
"type": "string"
|
|
104787
|
-
}
|
|
104788
|
-
}
|
|
104789
|
-
}
|
|
104790
|
-
}
|
|
104791
|
-
}
|
|
104792
|
-
},
|
|
104793
|
-
"402": {
|
|
104794
|
-
"description": "Response 402",
|
|
104795
|
-
"content": {
|
|
104796
|
-
"application/json": {
|
|
104797
|
-
"schema": {
|
|
104798
|
-
"additionalProperties": false,
|
|
104799
|
-
"type": "object",
|
|
104800
|
-
"required": [
|
|
104801
|
-
"error"
|
|
104802
|
-
],
|
|
104803
|
-
"properties": {
|
|
104804
104610
|
"error": {
|
|
104805
104611
|
"type": "string"
|
|
104806
104612
|
},
|
|
@@ -104823,6 +104629,9 @@
|
|
|
104823
104629
|
"error"
|
|
104824
104630
|
],
|
|
104825
104631
|
"properties": {
|
|
104632
|
+
"code": {
|
|
104633
|
+
"type": "string"
|
|
104634
|
+
},
|
|
104826
104635
|
"error": {
|
|
104827
104636
|
"type": "string"
|
|
104828
104637
|
},
|
|
@@ -104845,6 +104654,279 @@
|
|
|
104845
104654
|
"error"
|
|
104846
104655
|
],
|
|
104847
104656
|
"properties": {
|
|
104657
|
+
"code": {
|
|
104658
|
+
"type": "string"
|
|
104659
|
+
},
|
|
104660
|
+
"error": {
|
|
104661
|
+
"type": "string"
|
|
104662
|
+
},
|
|
104663
|
+
"message": {
|
|
104664
|
+
"type": "string"
|
|
104665
|
+
}
|
|
104666
|
+
}
|
|
104667
|
+
}
|
|
104668
|
+
}
|
|
104669
|
+
}
|
|
104670
|
+
}
|
|
104671
|
+
}
|
|
104672
|
+
},
|
|
104673
|
+
"post": {
|
|
104674
|
+
"operationId": "postApiV1CreativeHubAvatars",
|
|
104675
|
+
"summary": "Create Creative Hub avatar",
|
|
104676
|
+
"tags": [
|
|
104677
|
+
"creative-hub"
|
|
104678
|
+
],
|
|
104679
|
+
"description": "Queues a custom text-to-avatar or photo-to-avatar generation job.",
|
|
104680
|
+
"requestBody": {
|
|
104681
|
+
"required": true,
|
|
104682
|
+
"content": {
|
|
104683
|
+
"application/json": {
|
|
104684
|
+
"schema": {
|
|
104685
|
+
"additionalProperties": false,
|
|
104686
|
+
"type": "object",
|
|
104687
|
+
"required": [
|
|
104688
|
+
"mode",
|
|
104689
|
+
"name"
|
|
104690
|
+
],
|
|
104691
|
+
"properties": {
|
|
104692
|
+
"mode": {
|
|
104693
|
+
"anyOf": [
|
|
104694
|
+
{
|
|
104695
|
+
"type": "string",
|
|
104696
|
+
"enum": [
|
|
104697
|
+
"text"
|
|
104698
|
+
]
|
|
104699
|
+
},
|
|
104700
|
+
{
|
|
104701
|
+
"type": "string",
|
|
104702
|
+
"enum": [
|
|
104703
|
+
"photo"
|
|
104704
|
+
]
|
|
104705
|
+
}
|
|
104706
|
+
]
|
|
104707
|
+
},
|
|
104708
|
+
"name": {
|
|
104709
|
+
"minLength": 1,
|
|
104710
|
+
"maxLength": 120,
|
|
104711
|
+
"type": "string"
|
|
104712
|
+
},
|
|
104713
|
+
"prompt": {
|
|
104714
|
+
"maxLength": 2000,
|
|
104715
|
+
"type": "string"
|
|
104716
|
+
},
|
|
104717
|
+
"template_avatar_id": {
|
|
104718
|
+
"type": "string"
|
|
104719
|
+
},
|
|
104720
|
+
"source_image_url": {
|
|
104721
|
+
"type": "string"
|
|
104722
|
+
},
|
|
104723
|
+
"gender": {
|
|
104724
|
+
"maxLength": 20,
|
|
104725
|
+
"type": "string"
|
|
104726
|
+
},
|
|
104727
|
+
"age_bracket": {
|
|
104728
|
+
"maxLength": 20,
|
|
104729
|
+
"type": "string"
|
|
104730
|
+
},
|
|
104731
|
+
"scenario": {
|
|
104732
|
+
"maxLength": 40,
|
|
104733
|
+
"type": "string"
|
|
104734
|
+
},
|
|
104735
|
+
"voice_id": {
|
|
104736
|
+
"type": "string"
|
|
104737
|
+
}
|
|
104738
|
+
}
|
|
104739
|
+
}
|
|
104740
|
+
}
|
|
104741
|
+
}
|
|
104742
|
+
},
|
|
104743
|
+
"security": [
|
|
104744
|
+
{
|
|
104745
|
+
"bearerAuth": []
|
|
104746
|
+
},
|
|
104747
|
+
{
|
|
104748
|
+
"apiKeyAuth": []
|
|
104749
|
+
}
|
|
104750
|
+
],
|
|
104751
|
+
"responses": {
|
|
104752
|
+
"202": {
|
|
104753
|
+
"description": "Accepted - processing asynchronously",
|
|
104754
|
+
"content": {
|
|
104755
|
+
"application/json": {
|
|
104756
|
+
"schema": {
|
|
104757
|
+
"additionalProperties": false,
|
|
104758
|
+
"type": "object",
|
|
104759
|
+
"required": [
|
|
104760
|
+
"avatar_id",
|
|
104761
|
+
"generation_id",
|
|
104762
|
+
"status",
|
|
104763
|
+
"estimated_credits",
|
|
104764
|
+
"polling_interval_ms"
|
|
104765
|
+
],
|
|
104766
|
+
"properties": {
|
|
104767
|
+
"avatar_id": {
|
|
104768
|
+
"format": "uuid",
|
|
104769
|
+
"type": "string"
|
|
104770
|
+
},
|
|
104771
|
+
"generation_id": {
|
|
104772
|
+
"format": "uuid",
|
|
104773
|
+
"type": "string"
|
|
104774
|
+
},
|
|
104775
|
+
"status": {
|
|
104776
|
+
"type": "string"
|
|
104777
|
+
},
|
|
104778
|
+
"estimated_credits": {
|
|
104779
|
+
"minimum": 0,
|
|
104780
|
+
"type": "integer"
|
|
104781
|
+
},
|
|
104782
|
+
"polling_interval_ms": {
|
|
104783
|
+
"minimum": 1,
|
|
104784
|
+
"type": "integer"
|
|
104785
|
+
}
|
|
104786
|
+
}
|
|
104787
|
+
}
|
|
104788
|
+
}
|
|
104789
|
+
}
|
|
104790
|
+
},
|
|
104791
|
+
"400": {
|
|
104792
|
+
"description": "Invalid request - schema validation failed",
|
|
104793
|
+
"content": {
|
|
104794
|
+
"application/json": {
|
|
104795
|
+
"schema": {
|
|
104796
|
+
"additionalProperties": false,
|
|
104797
|
+
"type": "object",
|
|
104798
|
+
"required": [
|
|
104799
|
+
"error"
|
|
104800
|
+
],
|
|
104801
|
+
"properties": {
|
|
104802
|
+
"code": {
|
|
104803
|
+
"type": "string"
|
|
104804
|
+
},
|
|
104805
|
+
"error": {
|
|
104806
|
+
"type": "string"
|
|
104807
|
+
},
|
|
104808
|
+
"message": {
|
|
104809
|
+
"type": "string"
|
|
104810
|
+
}
|
|
104811
|
+
}
|
|
104812
|
+
}
|
|
104813
|
+
}
|
|
104814
|
+
}
|
|
104815
|
+
},
|
|
104816
|
+
"401": {
|
|
104817
|
+
"description": "Unauthorized - missing or invalid bearer token",
|
|
104818
|
+
"content": {
|
|
104819
|
+
"application/json": {
|
|
104820
|
+
"schema": {
|
|
104821
|
+
"additionalProperties": false,
|
|
104822
|
+
"type": "object",
|
|
104823
|
+
"required": [
|
|
104824
|
+
"error"
|
|
104825
|
+
],
|
|
104826
|
+
"properties": {
|
|
104827
|
+
"code": {
|
|
104828
|
+
"type": "string"
|
|
104829
|
+
},
|
|
104830
|
+
"error": {
|
|
104831
|
+
"type": "string"
|
|
104832
|
+
},
|
|
104833
|
+
"message": {
|
|
104834
|
+
"type": "string"
|
|
104835
|
+
}
|
|
104836
|
+
}
|
|
104837
|
+
}
|
|
104838
|
+
}
|
|
104839
|
+
}
|
|
104840
|
+
},
|
|
104841
|
+
"402": {
|
|
104842
|
+
"description": "Response 402",
|
|
104843
|
+
"content": {
|
|
104844
|
+
"application/json": {
|
|
104845
|
+
"schema": {
|
|
104846
|
+
"additionalProperties": false,
|
|
104847
|
+
"type": "object",
|
|
104848
|
+
"required": [
|
|
104849
|
+
"error"
|
|
104850
|
+
],
|
|
104851
|
+
"properties": {
|
|
104852
|
+
"code": {
|
|
104853
|
+
"type": "string"
|
|
104854
|
+
},
|
|
104855
|
+
"error": {
|
|
104856
|
+
"type": "string"
|
|
104857
|
+
},
|
|
104858
|
+
"message": {
|
|
104859
|
+
"type": "string"
|
|
104860
|
+
}
|
|
104861
|
+
}
|
|
104862
|
+
}
|
|
104863
|
+
}
|
|
104864
|
+
}
|
|
104865
|
+
},
|
|
104866
|
+
"403": {
|
|
104867
|
+
"description": "Forbidden - caller lacks the required role/permission",
|
|
104868
|
+
"content": {
|
|
104869
|
+
"application/json": {
|
|
104870
|
+
"schema": {
|
|
104871
|
+
"additionalProperties": false,
|
|
104872
|
+
"type": "object",
|
|
104873
|
+
"required": [
|
|
104874
|
+
"error"
|
|
104875
|
+
],
|
|
104876
|
+
"properties": {
|
|
104877
|
+
"code": {
|
|
104878
|
+
"type": "string"
|
|
104879
|
+
},
|
|
104880
|
+
"error": {
|
|
104881
|
+
"type": "string"
|
|
104882
|
+
},
|
|
104883
|
+
"message": {
|
|
104884
|
+
"type": "string"
|
|
104885
|
+
}
|
|
104886
|
+
}
|
|
104887
|
+
}
|
|
104888
|
+
}
|
|
104889
|
+
}
|
|
104890
|
+
},
|
|
104891
|
+
"404": {
|
|
104892
|
+
"description": "Resource not found",
|
|
104893
|
+
"content": {
|
|
104894
|
+
"application/json": {
|
|
104895
|
+
"schema": {
|
|
104896
|
+
"additionalProperties": false,
|
|
104897
|
+
"type": "object",
|
|
104898
|
+
"required": [
|
|
104899
|
+
"error"
|
|
104900
|
+
],
|
|
104901
|
+
"properties": {
|
|
104902
|
+
"code": {
|
|
104903
|
+
"type": "string"
|
|
104904
|
+
},
|
|
104905
|
+
"error": {
|
|
104906
|
+
"type": "string"
|
|
104907
|
+
},
|
|
104908
|
+
"message": {
|
|
104909
|
+
"type": "string"
|
|
104910
|
+
}
|
|
104911
|
+
}
|
|
104912
|
+
}
|
|
104913
|
+
}
|
|
104914
|
+
}
|
|
104915
|
+
},
|
|
104916
|
+
"429": {
|
|
104917
|
+
"description": "Too many requests - rate limit exceeded",
|
|
104918
|
+
"content": {
|
|
104919
|
+
"application/json": {
|
|
104920
|
+
"schema": {
|
|
104921
|
+
"additionalProperties": false,
|
|
104922
|
+
"type": "object",
|
|
104923
|
+
"required": [
|
|
104924
|
+
"error"
|
|
104925
|
+
],
|
|
104926
|
+
"properties": {
|
|
104927
|
+
"code": {
|
|
104928
|
+
"type": "string"
|
|
104929
|
+
},
|
|
104848
104930
|
"error": {
|
|
104849
104931
|
"type": "string"
|
|
104850
104932
|
},
|
|
@@ -104867,6 +104949,34 @@
|
|
|
104867
104949
|
"error"
|
|
104868
104950
|
],
|
|
104869
104951
|
"properties": {
|
|
104952
|
+
"code": {
|
|
104953
|
+
"type": "string"
|
|
104954
|
+
},
|
|
104955
|
+
"error": {
|
|
104956
|
+
"type": "string"
|
|
104957
|
+
},
|
|
104958
|
+
"message": {
|
|
104959
|
+
"type": "string"
|
|
104960
|
+
}
|
|
104961
|
+
}
|
|
104962
|
+
}
|
|
104963
|
+
}
|
|
104964
|
+
}
|
|
104965
|
+
},
|
|
104966
|
+
"503": {
|
|
104967
|
+
"description": "Service unavailable",
|
|
104968
|
+
"content": {
|
|
104969
|
+
"application/json": {
|
|
104970
|
+
"schema": {
|
|
104971
|
+
"additionalProperties": false,
|
|
104972
|
+
"type": "object",
|
|
104973
|
+
"required": [
|
|
104974
|
+
"error"
|
|
104975
|
+
],
|
|
104976
|
+
"properties": {
|
|
104977
|
+
"code": {
|
|
104978
|
+
"type": "string"
|
|
104979
|
+
},
|
|
104870
104980
|
"error": {
|
|
104871
104981
|
"type": "string"
|
|
104872
104982
|
},
|
|
@@ -105130,6 +105240,9 @@
|
|
|
105130
105240
|
"error"
|
|
105131
105241
|
],
|
|
105132
105242
|
"properties": {
|
|
105243
|
+
"code": {
|
|
105244
|
+
"type": "string"
|
|
105245
|
+
},
|
|
105133
105246
|
"error": {
|
|
105134
105247
|
"type": "string"
|
|
105135
105248
|
},
|
|
@@ -105152,6 +105265,9 @@
|
|
|
105152
105265
|
"error"
|
|
105153
105266
|
],
|
|
105154
105267
|
"properties": {
|
|
105268
|
+
"code": {
|
|
105269
|
+
"type": "string"
|
|
105270
|
+
},
|
|
105155
105271
|
"error": {
|
|
105156
105272
|
"type": "string"
|
|
105157
105273
|
},
|
|
@@ -105174,6 +105290,9 @@
|
|
|
105174
105290
|
"error"
|
|
105175
105291
|
],
|
|
105176
105292
|
"properties": {
|
|
105293
|
+
"code": {
|
|
105294
|
+
"type": "string"
|
|
105295
|
+
},
|
|
105177
105296
|
"error": {
|
|
105178
105297
|
"type": "string"
|
|
105179
105298
|
},
|
|
@@ -105196,6 +105315,9 @@
|
|
|
105196
105315
|
"error"
|
|
105197
105316
|
],
|
|
105198
105317
|
"properties": {
|
|
105318
|
+
"code": {
|
|
105319
|
+
"type": "string"
|
|
105320
|
+
},
|
|
105199
105321
|
"error": {
|
|
105200
105322
|
"type": "string"
|
|
105201
105323
|
},
|
|
@@ -105250,6 +105372,9 @@
|
|
|
105250
105372
|
"error"
|
|
105251
105373
|
],
|
|
105252
105374
|
"properties": {
|
|
105375
|
+
"code": {
|
|
105376
|
+
"type": "string"
|
|
105377
|
+
},
|
|
105253
105378
|
"error": {
|
|
105254
105379
|
"type": "string"
|
|
105255
105380
|
},
|
|
@@ -105272,6 +105397,9 @@
|
|
|
105272
105397
|
"error"
|
|
105273
105398
|
],
|
|
105274
105399
|
"properties": {
|
|
105400
|
+
"code": {
|
|
105401
|
+
"type": "string"
|
|
105402
|
+
},
|
|
105275
105403
|
"error": {
|
|
105276
105404
|
"type": "string"
|
|
105277
105405
|
},
|
|
@@ -105294,6 +105422,9 @@
|
|
|
105294
105422
|
"error"
|
|
105295
105423
|
],
|
|
105296
105424
|
"properties": {
|
|
105425
|
+
"code": {
|
|
105426
|
+
"type": "string"
|
|
105427
|
+
},
|
|
105297
105428
|
"error": {
|
|
105298
105429
|
"type": "string"
|
|
105299
105430
|
},
|
|
@@ -105495,6 +105626,9 @@
|
|
|
105495
105626
|
"error"
|
|
105496
105627
|
],
|
|
105497
105628
|
"properties": {
|
|
105629
|
+
"code": {
|
|
105630
|
+
"type": "string"
|
|
105631
|
+
},
|
|
105498
105632
|
"error": {
|
|
105499
105633
|
"type": "string"
|
|
105500
105634
|
},
|
|
@@ -105517,6 +105651,9 @@
|
|
|
105517
105651
|
"error"
|
|
105518
105652
|
],
|
|
105519
105653
|
"properties": {
|
|
105654
|
+
"code": {
|
|
105655
|
+
"type": "string"
|
|
105656
|
+
},
|
|
105520
105657
|
"error": {
|
|
105521
105658
|
"type": "string"
|
|
105522
105659
|
},
|
|
@@ -105539,6 +105676,9 @@
|
|
|
105539
105676
|
"error"
|
|
105540
105677
|
],
|
|
105541
105678
|
"properties": {
|
|
105679
|
+
"code": {
|
|
105680
|
+
"type": "string"
|
|
105681
|
+
},
|
|
105542
105682
|
"error": {
|
|
105543
105683
|
"type": "string"
|
|
105544
105684
|
},
|
|
@@ -105918,6 +106058,9 @@
|
|
|
105918
106058
|
"error"
|
|
105919
106059
|
],
|
|
105920
106060
|
"properties": {
|
|
106061
|
+
"code": {
|
|
106062
|
+
"type": "string"
|
|
106063
|
+
},
|
|
105921
106064
|
"error": {
|
|
105922
106065
|
"type": "string"
|
|
105923
106066
|
},
|
|
@@ -105940,6 +106083,9 @@
|
|
|
105940
106083
|
"error"
|
|
105941
106084
|
],
|
|
105942
106085
|
"properties": {
|
|
106086
|
+
"code": {
|
|
106087
|
+
"type": "string"
|
|
106088
|
+
},
|
|
105943
106089
|
"error": {
|
|
105944
106090
|
"type": "string"
|
|
105945
106091
|
},
|
|
@@ -105962,6 +106108,9 @@
|
|
|
105962
106108
|
"error"
|
|
105963
106109
|
],
|
|
105964
106110
|
"properties": {
|
|
106111
|
+
"code": {
|
|
106112
|
+
"type": "string"
|
|
106113
|
+
},
|
|
105965
106114
|
"error": {
|
|
105966
106115
|
"type": "string"
|
|
105967
106116
|
},
|
|
@@ -105984,6 +106133,9 @@
|
|
|
105984
106133
|
"error"
|
|
105985
106134
|
],
|
|
105986
106135
|
"properties": {
|
|
106136
|
+
"code": {
|
|
106137
|
+
"type": "string"
|
|
106138
|
+
},
|
|
105987
106139
|
"error": {
|
|
105988
106140
|
"type": "string"
|
|
105989
106141
|
},
|
|
@@ -106373,6 +106525,9 @@
|
|
|
106373
106525
|
"error"
|
|
106374
106526
|
],
|
|
106375
106527
|
"properties": {
|
|
106528
|
+
"code": {
|
|
106529
|
+
"type": "string"
|
|
106530
|
+
},
|
|
106376
106531
|
"error": {
|
|
106377
106532
|
"type": "string"
|
|
106378
106533
|
},
|
|
@@ -106395,6 +106550,9 @@
|
|
|
106395
106550
|
"error"
|
|
106396
106551
|
],
|
|
106397
106552
|
"properties": {
|
|
106553
|
+
"code": {
|
|
106554
|
+
"type": "string"
|
|
106555
|
+
},
|
|
106398
106556
|
"error": {
|
|
106399
106557
|
"type": "string"
|
|
106400
106558
|
},
|
|
@@ -106417,6 +106575,9 @@
|
|
|
106417
106575
|
"error"
|
|
106418
106576
|
],
|
|
106419
106577
|
"properties": {
|
|
106578
|
+
"code": {
|
|
106579
|
+
"type": "string"
|
|
106580
|
+
},
|
|
106420
106581
|
"error": {
|
|
106421
106582
|
"type": "string"
|
|
106422
106583
|
},
|
|
@@ -106439,6 +106600,9 @@
|
|
|
106439
106600
|
"error"
|
|
106440
106601
|
],
|
|
106441
106602
|
"properties": {
|
|
106603
|
+
"code": {
|
|
106604
|
+
"type": "string"
|
|
106605
|
+
},
|
|
106442
106606
|
"error": {
|
|
106443
106607
|
"type": "string"
|
|
106444
106608
|
},
|
|
@@ -106493,6 +106657,9 @@
|
|
|
106493
106657
|
"error"
|
|
106494
106658
|
],
|
|
106495
106659
|
"properties": {
|
|
106660
|
+
"code": {
|
|
106661
|
+
"type": "string"
|
|
106662
|
+
},
|
|
106496
106663
|
"error": {
|
|
106497
106664
|
"type": "string"
|
|
106498
106665
|
},
|
|
@@ -106515,6 +106682,9 @@
|
|
|
106515
106682
|
"error"
|
|
106516
106683
|
],
|
|
106517
106684
|
"properties": {
|
|
106685
|
+
"code": {
|
|
106686
|
+
"type": "string"
|
|
106687
|
+
},
|
|
106518
106688
|
"error": {
|
|
106519
106689
|
"type": "string"
|
|
106520
106690
|
},
|
|
@@ -106537,6 +106707,9 @@
|
|
|
106537
106707
|
"error"
|
|
106538
106708
|
],
|
|
106539
106709
|
"properties": {
|
|
106710
|
+
"code": {
|
|
106711
|
+
"type": "string"
|
|
106712
|
+
},
|
|
106540
106713
|
"error": {
|
|
106541
106714
|
"type": "string"
|
|
106542
106715
|
},
|
|
@@ -106727,6 +106900,9 @@
|
|
|
106727
106900
|
"error"
|
|
106728
106901
|
],
|
|
106729
106902
|
"properties": {
|
|
106903
|
+
"code": {
|
|
106904
|
+
"type": "string"
|
|
106905
|
+
},
|
|
106730
106906
|
"error": {
|
|
106731
106907
|
"type": "string"
|
|
106732
106908
|
},
|
|
@@ -106749,6 +106925,59 @@
|
|
|
106749
106925
|
"error"
|
|
106750
106926
|
],
|
|
106751
106927
|
"properties": {
|
|
106928
|
+
"code": {
|
|
106929
|
+
"type": "string"
|
|
106930
|
+
},
|
|
106931
|
+
"error": {
|
|
106932
|
+
"type": "string"
|
|
106933
|
+
},
|
|
106934
|
+
"message": {
|
|
106935
|
+
"type": "string"
|
|
106936
|
+
}
|
|
106937
|
+
}
|
|
106938
|
+
}
|
|
106939
|
+
}
|
|
106940
|
+
}
|
|
106941
|
+
},
|
|
106942
|
+
"429": {
|
|
106943
|
+
"description": "Too many requests - rate limit exceeded",
|
|
106944
|
+
"content": {
|
|
106945
|
+
"application/json": {
|
|
106946
|
+
"schema": {
|
|
106947
|
+
"additionalProperties": false,
|
|
106948
|
+
"type": "object",
|
|
106949
|
+
"required": [
|
|
106950
|
+
"error"
|
|
106951
|
+
],
|
|
106952
|
+
"properties": {
|
|
106953
|
+
"code": {
|
|
106954
|
+
"type": "string"
|
|
106955
|
+
},
|
|
106956
|
+
"error": {
|
|
106957
|
+
"type": "string"
|
|
106958
|
+
},
|
|
106959
|
+
"message": {
|
|
106960
|
+
"type": "string"
|
|
106961
|
+
}
|
|
106962
|
+
}
|
|
106963
|
+
}
|
|
106964
|
+
}
|
|
106965
|
+
}
|
|
106966
|
+
},
|
|
106967
|
+
"503": {
|
|
106968
|
+
"description": "Service unavailable",
|
|
106969
|
+
"content": {
|
|
106970
|
+
"application/json": {
|
|
106971
|
+
"schema": {
|
|
106972
|
+
"additionalProperties": false,
|
|
106973
|
+
"type": "object",
|
|
106974
|
+
"required": [
|
|
106975
|
+
"error"
|
|
106976
|
+
],
|
|
106977
|
+
"properties": {
|
|
106978
|
+
"code": {
|
|
106979
|
+
"type": "string"
|
|
106980
|
+
},
|
|
106752
106981
|
"error": {
|
|
106753
106982
|
"type": "string"
|
|
106754
106983
|
},
|
|
@@ -109542,6 +109771,28 @@
|
|
|
109542
109771
|
}
|
|
109543
109772
|
}
|
|
109544
109773
|
}
|
|
109774
|
+
},
|
|
109775
|
+
"503": {
|
|
109776
|
+
"description": "Service unavailable",
|
|
109777
|
+
"content": {
|
|
109778
|
+
"application/json": {
|
|
109779
|
+
"schema": {
|
|
109780
|
+
"additionalProperties": false,
|
|
109781
|
+
"type": "object",
|
|
109782
|
+
"required": [
|
|
109783
|
+
"error"
|
|
109784
|
+
],
|
|
109785
|
+
"properties": {
|
|
109786
|
+
"code": {
|
|
109787
|
+
"type": "string"
|
|
109788
|
+
},
|
|
109789
|
+
"error": {
|
|
109790
|
+
"type": "string"
|
|
109791
|
+
}
|
|
109792
|
+
}
|
|
109793
|
+
}
|
|
109794
|
+
}
|
|
109795
|
+
}
|
|
109545
109796
|
}
|
|
109546
109797
|
}
|
|
109547
109798
|
}
|
|
@@ -109753,6 +110004,28 @@
|
|
|
109753
110004
|
}
|
|
109754
110005
|
}
|
|
109755
110006
|
}
|
|
110007
|
+
},
|
|
110008
|
+
"503": {
|
|
110009
|
+
"description": "Service unavailable",
|
|
110010
|
+
"content": {
|
|
110011
|
+
"application/json": {
|
|
110012
|
+
"schema": {
|
|
110013
|
+
"additionalProperties": false,
|
|
110014
|
+
"type": "object",
|
|
110015
|
+
"required": [
|
|
110016
|
+
"error"
|
|
110017
|
+
],
|
|
110018
|
+
"properties": {
|
|
110019
|
+
"code": {
|
|
110020
|
+
"type": "string"
|
|
110021
|
+
},
|
|
110022
|
+
"error": {
|
|
110023
|
+
"type": "string"
|
|
110024
|
+
}
|
|
110025
|
+
}
|
|
110026
|
+
}
|
|
110027
|
+
}
|
|
110028
|
+
}
|
|
109756
110029
|
}
|
|
109757
110030
|
}
|
|
109758
110031
|
}
|
|
@@ -109942,186 +110215,208 @@
|
|
|
109942
110215
|
}
|
|
109943
110216
|
}
|
|
109944
110217
|
}
|
|
109945
|
-
}
|
|
109946
|
-
|
|
109947
|
-
|
|
109948
|
-
|
|
109949
|
-
|
|
109950
|
-
|
|
109951
|
-
|
|
109952
|
-
|
|
109953
|
-
|
|
109954
|
-
|
|
109955
|
-
|
|
109956
|
-
|
|
109957
|
-
|
|
109958
|
-
|
|
109959
|
-
|
|
109960
|
-
|
|
109961
|
-
|
|
109962
|
-
|
|
109963
|
-
|
|
109964
|
-
|
|
109965
|
-
|
|
109966
|
-
|
|
109967
|
-
|
|
109968
|
-
|
|
109969
|
-
|
|
109970
|
-
|
|
109971
|
-
|
|
109972
|
-
|
|
109973
|
-
|
|
109974
|
-
|
|
109975
|
-
|
|
109976
|
-
|
|
109977
|
-
|
|
109978
|
-
|
|
109979
|
-
|
|
109980
|
-
|
|
109981
|
-
|
|
109982
|
-
|
|
109983
|
-
|
|
109984
|
-
|
|
109985
|
-
|
|
109986
|
-
|
|
109987
|
-
|
|
109988
|
-
|
|
109989
|
-
|
|
109990
|
-
|
|
109991
|
-
|
|
109992
|
-
|
|
109993
|
-
|
|
109994
|
-
},
|
|
109995
|
-
"
|
|
109996
|
-
"type": "string"
|
|
109997
|
-
}
|
|
109998
|
-
|
|
109999
|
-
|
|
110000
|
-
|
|
110001
|
-
|
|
110002
|
-
|
|
110003
|
-
|
|
110004
|
-
|
|
110005
|
-
|
|
110006
|
-
|
|
110007
|
-
|
|
110008
|
-
|
|
110009
|
-
|
|
110010
|
-
|
|
110011
|
-
|
|
110012
|
-
|
|
110013
|
-
|
|
110014
|
-
|
|
110015
|
-
|
|
110016
|
-
|
|
110017
|
-
"
|
|
110018
|
-
|
|
110019
|
-
|
|
110020
|
-
|
|
110021
|
-
|
|
110022
|
-
|
|
110023
|
-
|
|
110024
|
-
|
|
110025
|
-
|
|
110026
|
-
|
|
110027
|
-
|
|
110028
|
-
|
|
110029
|
-
|
|
110030
|
-
|
|
110031
|
-
|
|
110032
|
-
|
|
110033
|
-
|
|
110034
|
-
|
|
110035
|
-
|
|
110036
|
-
|
|
110037
|
-
|
|
110038
|
-
|
|
110039
|
-
|
|
110040
|
-
|
|
110041
|
-
"
|
|
110042
|
-
|
|
110043
|
-
|
|
110044
|
-
|
|
110045
|
-
|
|
110046
|
-
|
|
110047
|
-
|
|
110048
|
-
|
|
110049
|
-
|
|
110050
|
-
|
|
110051
|
-
|
|
110052
|
-
|
|
110053
|
-
|
|
110054
|
-
|
|
110055
|
-
|
|
110056
|
-
|
|
110057
|
-
|
|
110058
|
-
|
|
110059
|
-
|
|
110060
|
-
|
|
110061
|
-
|
|
110062
|
-
|
|
110063
|
-
|
|
110064
|
-
|
|
110065
|
-
|
|
110066
|
-
|
|
110067
|
-
|
|
110068
|
-
|
|
110069
|
-
|
|
110070
|
-
|
|
110071
|
-
|
|
110072
|
-
|
|
110073
|
-
|
|
110074
|
-
|
|
110075
|
-
|
|
110076
|
-
|
|
110077
|
-
|
|
110078
|
-
}
|
|
110079
|
-
}
|
|
110080
|
-
}
|
|
110081
|
-
},
|
|
110082
|
-
"
|
|
110083
|
-
"description": "
|
|
110084
|
-
"content": {
|
|
110085
|
-
"application/json": {
|
|
110086
|
-
"schema": {
|
|
110087
|
-
"additionalProperties": false,
|
|
110088
|
-
"type": "object",
|
|
110089
|
-
"required": [
|
|
110090
|
-
"error"
|
|
110091
|
-
],
|
|
110092
|
-
"properties": {
|
|
110093
|
-
"code": {
|
|
110094
|
-
"type": "string"
|
|
110095
|
-
},
|
|
110096
|
-
"error": {
|
|
110097
|
-
"type": "string"
|
|
110098
|
-
}
|
|
110099
|
-
}
|
|
110100
|
-
}
|
|
110101
|
-
}
|
|
110102
|
-
}
|
|
110103
|
-
},
|
|
110104
|
-
"
|
|
110105
|
-
"description": "
|
|
110106
|
-
"content": {
|
|
110107
|
-
"application/json": {
|
|
110108
|
-
"schema": {
|
|
110109
|
-
"additionalProperties": false,
|
|
110110
|
-
"type": "object",
|
|
110111
|
-
"required": [
|
|
110112
|
-
"error"
|
|
110113
|
-
],
|
|
110114
|
-
"properties": {
|
|
110115
|
-
"code": {
|
|
110116
|
-
"type": "string"
|
|
110117
|
-
},
|
|
110118
|
-
"error": {
|
|
110119
|
-
"type": "string"
|
|
110120
|
-
}
|
|
110121
|
-
}
|
|
110122
|
-
}
|
|
110123
|
-
}
|
|
110124
|
-
}
|
|
110218
|
+
},
|
|
110219
|
+
"503": {
|
|
110220
|
+
"description": "Service unavailable",
|
|
110221
|
+
"content": {
|
|
110222
|
+
"application/json": {
|
|
110223
|
+
"schema": {
|
|
110224
|
+
"additionalProperties": false,
|
|
110225
|
+
"type": "object",
|
|
110226
|
+
"required": [
|
|
110227
|
+
"error"
|
|
110228
|
+
],
|
|
110229
|
+
"properties": {
|
|
110230
|
+
"code": {
|
|
110231
|
+
"type": "string"
|
|
110232
|
+
},
|
|
110233
|
+
"error": {
|
|
110234
|
+
"type": "string"
|
|
110235
|
+
}
|
|
110236
|
+
}
|
|
110237
|
+
}
|
|
110238
|
+
}
|
|
110239
|
+
}
|
|
110240
|
+
}
|
|
110241
|
+
}
|
|
110242
|
+
}
|
|
110243
|
+
},
|
|
110244
|
+
"/api/v1/creative-hub/generate/tts": {
|
|
110245
|
+
"post": {
|
|
110246
|
+
"operationId": "creativeHubGenerateTTS",
|
|
110247
|
+
"summary": "Generate text-to-speech audio",
|
|
110248
|
+
"tags": [
|
|
110249
|
+
"creative-hub",
|
|
110250
|
+
"creative-generation"
|
|
110251
|
+
],
|
|
110252
|
+
"description": "Queues a TTS audio generation job via ElevenLabs or OpenAI. Returns 202 Accepted with an async-job handle; poll GET /api/v1/creative-hub/generate/jobs/:id to retrieve the result.",
|
|
110253
|
+
"requestBody": {
|
|
110254
|
+
"required": true,
|
|
110255
|
+
"content": {
|
|
110256
|
+
"application/json": {
|
|
110257
|
+
"schema": {
|
|
110258
|
+
"type": "object",
|
|
110259
|
+
"required": [
|
|
110260
|
+
"text"
|
|
110261
|
+
],
|
|
110262
|
+
"properties": {
|
|
110263
|
+
"text": {
|
|
110264
|
+
"minLength": 1,
|
|
110265
|
+
"maxLength": 5000,
|
|
110266
|
+
"type": "string"
|
|
110267
|
+
},
|
|
110268
|
+
"voice_id": {
|
|
110269
|
+
"type": "string"
|
|
110270
|
+
},
|
|
110271
|
+
"language": {
|
|
110272
|
+
"type": "string"
|
|
110273
|
+
},
|
|
110274
|
+
"provider": {
|
|
110275
|
+
"anyOf": [
|
|
110276
|
+
{
|
|
110277
|
+
"type": "string",
|
|
110278
|
+
"enum": [
|
|
110279
|
+
"elevenlabs"
|
|
110280
|
+
]
|
|
110281
|
+
},
|
|
110282
|
+
{
|
|
110283
|
+
"type": "string",
|
|
110284
|
+
"enum": [
|
|
110285
|
+
"openai_tts"
|
|
110286
|
+
]
|
|
110287
|
+
}
|
|
110288
|
+
]
|
|
110289
|
+
},
|
|
110290
|
+
"drive_folder_id": {
|
|
110291
|
+
"type": "string"
|
|
110292
|
+
}
|
|
110293
|
+
}
|
|
110294
|
+
}
|
|
110295
|
+
}
|
|
110296
|
+
}
|
|
110297
|
+
},
|
|
110298
|
+
"security": [
|
|
110299
|
+
{
|
|
110300
|
+
"bearerAuth": []
|
|
110301
|
+
},
|
|
110302
|
+
{
|
|
110303
|
+
"apiKeyAuth": []
|
|
110304
|
+
}
|
|
110305
|
+
],
|
|
110306
|
+
"responses": {
|
|
110307
|
+
"202": {
|
|
110308
|
+
"description": "Accepted - processing asynchronously",
|
|
110309
|
+
"content": {
|
|
110310
|
+
"application/json": {
|
|
110311
|
+
"schema": {
|
|
110312
|
+
"type": "object",
|
|
110313
|
+
"required": [
|
|
110314
|
+
"job_id",
|
|
110315
|
+
"status",
|
|
110316
|
+
"polling_interval_ms",
|
|
110317
|
+
"created_at"
|
|
110318
|
+
],
|
|
110319
|
+
"properties": {
|
|
110320
|
+
"job_id": {
|
|
110321
|
+
"description": "ID of the queued creative_job row",
|
|
110322
|
+
"type": "string"
|
|
110323
|
+
},
|
|
110324
|
+
"status": {
|
|
110325
|
+
"description": "Initial job status (always \"pending\" right after enqueue)",
|
|
110326
|
+
"type": "string"
|
|
110327
|
+
},
|
|
110328
|
+
"polling_interval_ms": {
|
|
110329
|
+
"description": "Suggested polling interval for GET /generate/jobs/:id",
|
|
110330
|
+
"type": "integer"
|
|
110331
|
+
},
|
|
110332
|
+
"estimated_wait_ms": {
|
|
110333
|
+
"description": "Rough estimated completion wait (provider-dependent)",
|
|
110334
|
+
"type": "integer"
|
|
110335
|
+
},
|
|
110336
|
+
"created_at": {
|
|
110337
|
+
"format": "date-time",
|
|
110338
|
+
"type": "string"
|
|
110339
|
+
}
|
|
110340
|
+
}
|
|
110341
|
+
}
|
|
110342
|
+
}
|
|
110343
|
+
}
|
|
110344
|
+
},
|
|
110345
|
+
"401": {
|
|
110346
|
+
"description": "Unauthorized - missing or invalid bearer token",
|
|
110347
|
+
"content": {
|
|
110348
|
+
"application/json": {
|
|
110349
|
+
"schema": {
|
|
110350
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
110351
|
+
}
|
|
110352
|
+
}
|
|
110353
|
+
}
|
|
110354
|
+
},
|
|
110355
|
+
"402": {
|
|
110356
|
+
"description": "Response 402",
|
|
110357
|
+
"content": {
|
|
110358
|
+
"application/json": {
|
|
110359
|
+
"schema": {
|
|
110360
|
+
"additionalProperties": false,
|
|
110361
|
+
"type": "object",
|
|
110362
|
+
"required": [
|
|
110363
|
+
"error"
|
|
110364
|
+
],
|
|
110365
|
+
"properties": {
|
|
110366
|
+
"code": {
|
|
110367
|
+
"type": "string"
|
|
110368
|
+
},
|
|
110369
|
+
"error": {
|
|
110370
|
+
"type": "string"
|
|
110371
|
+
}
|
|
110372
|
+
}
|
|
110373
|
+
}
|
|
110374
|
+
}
|
|
110375
|
+
}
|
|
110376
|
+
},
|
|
110377
|
+
"403": {
|
|
110378
|
+
"description": "Forbidden - caller lacks the required role/permission",
|
|
110379
|
+
"content": {
|
|
110380
|
+
"application/json": {
|
|
110381
|
+
"schema": {
|
|
110382
|
+
"additionalProperties": false,
|
|
110383
|
+
"type": "object",
|
|
110384
|
+
"required": [
|
|
110385
|
+
"error"
|
|
110386
|
+
],
|
|
110387
|
+
"properties": {
|
|
110388
|
+
"code": {
|
|
110389
|
+
"type": "string"
|
|
110390
|
+
},
|
|
110391
|
+
"error": {
|
|
110392
|
+
"type": "string"
|
|
110393
|
+
}
|
|
110394
|
+
}
|
|
110395
|
+
}
|
|
110396
|
+
}
|
|
110397
|
+
}
|
|
110398
|
+
},
|
|
110399
|
+
"404": {
|
|
110400
|
+
"description": "Resource not found",
|
|
110401
|
+
"content": {
|
|
110402
|
+
"application/json": {
|
|
110403
|
+
"schema": {
|
|
110404
|
+
"additionalProperties": false,
|
|
110405
|
+
"type": "object",
|
|
110406
|
+
"required": [
|
|
110407
|
+
"error"
|
|
110408
|
+
],
|
|
110409
|
+
"properties": {
|
|
110410
|
+
"code": {
|
|
110411
|
+
"type": "string"
|
|
110412
|
+
},
|
|
110413
|
+
"error": {
|
|
110414
|
+
"type": "string"
|
|
110415
|
+
}
|
|
110416
|
+
}
|
|
110417
|
+
}
|
|
110418
|
+
}
|
|
110419
|
+
}
|
|
110125
110420
|
},
|
|
110126
110421
|
"429": {
|
|
110127
110422
|
"description": "Too many requests - rate limit exceeded",
|
|
@@ -110144,6 +110439,28 @@
|
|
|
110144
110439
|
}
|
|
110145
110440
|
}
|
|
110146
110441
|
}
|
|
110442
|
+
},
|
|
110443
|
+
"503": {
|
|
110444
|
+
"description": "Service unavailable",
|
|
110445
|
+
"content": {
|
|
110446
|
+
"application/json": {
|
|
110447
|
+
"schema": {
|
|
110448
|
+
"additionalProperties": false,
|
|
110449
|
+
"type": "object",
|
|
110450
|
+
"required": [
|
|
110451
|
+
"error"
|
|
110452
|
+
],
|
|
110453
|
+
"properties": {
|
|
110454
|
+
"code": {
|
|
110455
|
+
"type": "string"
|
|
110456
|
+
},
|
|
110457
|
+
"error": {
|
|
110458
|
+
"type": "string"
|
|
110459
|
+
}
|
|
110460
|
+
}
|
|
110461
|
+
}
|
|
110462
|
+
}
|
|
110463
|
+
}
|
|
110147
110464
|
}
|
|
110148
110465
|
}
|
|
110149
110466
|
}
|
|
@@ -110403,6 +110720,28 @@
|
|
|
110403
110720
|
}
|
|
110404
110721
|
}
|
|
110405
110722
|
}
|
|
110723
|
+
},
|
|
110724
|
+
"503": {
|
|
110725
|
+
"description": "Service unavailable",
|
|
110726
|
+
"content": {
|
|
110727
|
+
"application/json": {
|
|
110728
|
+
"schema": {
|
|
110729
|
+
"additionalProperties": false,
|
|
110730
|
+
"type": "object",
|
|
110731
|
+
"required": [
|
|
110732
|
+
"error"
|
|
110733
|
+
],
|
|
110734
|
+
"properties": {
|
|
110735
|
+
"code": {
|
|
110736
|
+
"type": "string"
|
|
110737
|
+
},
|
|
110738
|
+
"error": {
|
|
110739
|
+
"type": "string"
|
|
110740
|
+
}
|
|
110741
|
+
}
|
|
110742
|
+
}
|
|
110743
|
+
}
|
|
110744
|
+
}
|
|
110406
110745
|
}
|
|
110407
110746
|
}
|
|
110408
110747
|
}
|
|
@@ -111219,6 +111558,31 @@
|
|
|
111219
111558
|
}
|
|
111220
111559
|
}
|
|
111221
111560
|
}
|
|
111561
|
+
},
|
|
111562
|
+
"503": {
|
|
111563
|
+
"description": "Service unavailable",
|
|
111564
|
+
"content": {
|
|
111565
|
+
"application/json": {
|
|
111566
|
+
"schema": {
|
|
111567
|
+
"additionalProperties": false,
|
|
111568
|
+
"type": "object",
|
|
111569
|
+
"required": [
|
|
111570
|
+
"error"
|
|
111571
|
+
],
|
|
111572
|
+
"properties": {
|
|
111573
|
+
"code": {
|
|
111574
|
+
"type": "string"
|
|
111575
|
+
},
|
|
111576
|
+
"error": {
|
|
111577
|
+
"type": "string"
|
|
111578
|
+
},
|
|
111579
|
+
"message": {
|
|
111580
|
+
"type": "string"
|
|
111581
|
+
}
|
|
111582
|
+
}
|
|
111583
|
+
}
|
|
111584
|
+
}
|
|
111585
|
+
}
|
|
111222
111586
|
}
|
|
111223
111587
|
}
|
|
111224
111588
|
}
|
|
@@ -112834,6 +113198,164 @@
|
|
|
112834
113198
|
}
|
|
112835
113199
|
}
|
|
112836
113200
|
}
|
|
113201
|
+
},
|
|
113202
|
+
"503": {
|
|
113203
|
+
"description": "Service unavailable",
|
|
113204
|
+
"content": {
|
|
113205
|
+
"application/json": {
|
|
113206
|
+
"schema": {
|
|
113207
|
+
"additionalProperties": false,
|
|
113208
|
+
"type": "object",
|
|
113209
|
+
"required": [
|
|
113210
|
+
"error"
|
|
113211
|
+
],
|
|
113212
|
+
"properties": {
|
|
113213
|
+
"code": {
|
|
113214
|
+
"type": "string"
|
|
113215
|
+
},
|
|
113216
|
+
"error": {
|
|
113217
|
+
"type": "string"
|
|
113218
|
+
},
|
|
113219
|
+
"message": {
|
|
113220
|
+
"type": "string"
|
|
113221
|
+
}
|
|
113222
|
+
}
|
|
113223
|
+
}
|
|
113224
|
+
}
|
|
113225
|
+
}
|
|
113226
|
+
}
|
|
113227
|
+
}
|
|
113228
|
+
}
|
|
113229
|
+
},
|
|
113230
|
+
"/api/v1/creative-hub/image-studio/estimate": {
|
|
113231
|
+
"post": {
|
|
113232
|
+
"operationId": "creativeHubEstimateCinematicImage",
|
|
113233
|
+
"summary": "Estimate cinematic image generation credit cost",
|
|
113234
|
+
"tags": [
|
|
113235
|
+
"creative-hub",
|
|
113236
|
+
"creative-generation"
|
|
113237
|
+
],
|
|
113238
|
+
"description": "Returns the deterministic credit hold estimate for a cinematic image generation. The estimate resolves the SAME catalog model the generation will run on, so the style preset (which routes to different, differently-priced models) and any reference image are both reflected in the amount.",
|
|
113239
|
+
"requestBody": {
|
|
113240
|
+
"required": true,
|
|
113241
|
+
"content": {
|
|
113242
|
+
"application/json": {
|
|
113243
|
+
"schema": {
|
|
113244
|
+
"additionalProperties": false,
|
|
113245
|
+
"type": "object",
|
|
113246
|
+
"required": [
|
|
113247
|
+
"num_variants"
|
|
113248
|
+
],
|
|
113249
|
+
"properties": {
|
|
113250
|
+
"num_variants": {
|
|
113251
|
+
"minimum": 1,
|
|
113252
|
+
"maximum": 4,
|
|
113253
|
+
"type": "integer"
|
|
113254
|
+
},
|
|
113255
|
+
"resolution": {
|
|
113256
|
+
"anyOf": [
|
|
113257
|
+
{
|
|
113258
|
+
"type": "string",
|
|
113259
|
+
"enum": [
|
|
113260
|
+
"720p"
|
|
113261
|
+
]
|
|
113262
|
+
},
|
|
113263
|
+
{
|
|
113264
|
+
"type": "string",
|
|
113265
|
+
"enum": [
|
|
113266
|
+
"1080p"
|
|
113267
|
+
]
|
|
113268
|
+
}
|
|
113269
|
+
]
|
|
113270
|
+
},
|
|
113271
|
+
"style": {
|
|
113272
|
+
"maxLength": 64,
|
|
113273
|
+
"type": "string"
|
|
113274
|
+
},
|
|
113275
|
+
"reference_image_url": {
|
|
113276
|
+
"maxLength": 2000,
|
|
113277
|
+
"type": "string"
|
|
113278
|
+
},
|
|
113279
|
+
"reference_image_urls": {
|
|
113280
|
+
"maxItems": 4,
|
|
113281
|
+
"type": "array",
|
|
113282
|
+
"items": {
|
|
113283
|
+
"maxLength": 2000,
|
|
113284
|
+
"type": "string"
|
|
113285
|
+
}
|
|
113286
|
+
}
|
|
113287
|
+
}
|
|
113288
|
+
}
|
|
113289
|
+
}
|
|
113290
|
+
}
|
|
113291
|
+
},
|
|
113292
|
+
"security": [
|
|
113293
|
+
{
|
|
113294
|
+
"bearerAuth": []
|
|
113295
|
+
},
|
|
113296
|
+
{
|
|
113297
|
+
"apiKeyAuth": []
|
|
113298
|
+
}
|
|
113299
|
+
],
|
|
113300
|
+
"responses": {
|
|
113301
|
+
"200": {
|
|
113302
|
+
"description": "Successful response",
|
|
113303
|
+
"content": {
|
|
113304
|
+
"application/json": {
|
|
113305
|
+
"schema": {
|
|
113306
|
+
"additionalProperties": false,
|
|
113307
|
+
"type": "object",
|
|
113308
|
+
"required": [
|
|
113309
|
+
"credits",
|
|
113310
|
+
"model_id"
|
|
113311
|
+
],
|
|
113312
|
+
"properties": {
|
|
113313
|
+
"credits": {
|
|
113314
|
+
"type": "integer"
|
|
113315
|
+
},
|
|
113316
|
+
"model_id": {
|
|
113317
|
+
"description": "Catalog model the generation will be priced and run on.",
|
|
113318
|
+
"type": "string"
|
|
113319
|
+
}
|
|
113320
|
+
}
|
|
113321
|
+
}
|
|
113322
|
+
}
|
|
113323
|
+
}
|
|
113324
|
+
},
|
|
113325
|
+
"400": {
|
|
113326
|
+
"description": "Invalid request - schema validation failed",
|
|
113327
|
+
"content": {
|
|
113328
|
+
"application/json": {
|
|
113329
|
+
"schema": {
|
|
113330
|
+
"additionalProperties": false,
|
|
113331
|
+
"type": "object",
|
|
113332
|
+
"required": [
|
|
113333
|
+
"error"
|
|
113334
|
+
],
|
|
113335
|
+
"properties": {
|
|
113336
|
+
"code": {
|
|
113337
|
+
"type": "string"
|
|
113338
|
+
},
|
|
113339
|
+
"error": {
|
|
113340
|
+
"type": "string"
|
|
113341
|
+
},
|
|
113342
|
+
"message": {
|
|
113343
|
+
"type": "string"
|
|
113344
|
+
}
|
|
113345
|
+
}
|
|
113346
|
+
}
|
|
113347
|
+
}
|
|
113348
|
+
}
|
|
113349
|
+
},
|
|
113350
|
+
"401": {
|
|
113351
|
+
"description": "Unauthorized - missing or invalid bearer token",
|
|
113352
|
+
"content": {
|
|
113353
|
+
"application/json": {
|
|
113354
|
+
"schema": {
|
|
113355
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
113356
|
+
}
|
|
113357
|
+
}
|
|
113358
|
+
}
|
|
112837
113359
|
}
|
|
112838
113360
|
}
|
|
112839
113361
|
}
|
|
@@ -118281,6 +118803,9 @@
|
|
|
118281
118803
|
"error"
|
|
118282
118804
|
],
|
|
118283
118805
|
"properties": {
|
|
118806
|
+
"code": {
|
|
118807
|
+
"type": "string"
|
|
118808
|
+
},
|
|
118284
118809
|
"error": {
|
|
118285
118810
|
"type": "string"
|
|
118286
118811
|
},
|
|
@@ -118425,6 +118950,9 @@
|
|
|
118425
118950
|
"error"
|
|
118426
118951
|
],
|
|
118427
118952
|
"properties": {
|
|
118953
|
+
"code": {
|
|
118954
|
+
"type": "string"
|
|
118955
|
+
},
|
|
118428
118956
|
"error": {
|
|
118429
118957
|
"type": "string"
|
|
118430
118958
|
},
|
|
@@ -118457,6 +118985,9 @@
|
|
|
118457
118985
|
"error"
|
|
118458
118986
|
],
|
|
118459
118987
|
"properties": {
|
|
118988
|
+
"code": {
|
|
118989
|
+
"type": "string"
|
|
118990
|
+
},
|
|
118460
118991
|
"error": {
|
|
118461
118992
|
"type": "string"
|
|
118462
118993
|
},
|
|
@@ -118479,6 +119010,9 @@
|
|
|
118479
119010
|
"error"
|
|
118480
119011
|
],
|
|
118481
119012
|
"properties": {
|
|
119013
|
+
"code": {
|
|
119014
|
+
"type": "string"
|
|
119015
|
+
},
|
|
118482
119016
|
"error": {
|
|
118483
119017
|
"type": "string"
|
|
118484
119018
|
},
|
|
@@ -118490,8 +119024,8 @@
|
|
|
118490
119024
|
}
|
|
118491
119025
|
}
|
|
118492
119026
|
},
|
|
118493
|
-
"
|
|
118494
|
-
"description": "
|
|
119027
|
+
"429": {
|
|
119028
|
+
"description": "Too many requests - rate limit exceeded",
|
|
118495
119029
|
"content": {
|
|
118496
119030
|
"application/json": {
|
|
118497
119031
|
"schema": {
|
|
@@ -118501,6 +119035,9 @@
|
|
|
118501
119035
|
"error"
|
|
118502
119036
|
],
|
|
118503
119037
|
"properties": {
|
|
119038
|
+
"code": {
|
|
119039
|
+
"type": "string"
|
|
119040
|
+
},
|
|
118504
119041
|
"error": {
|
|
118505
119042
|
"type": "string"
|
|
118506
119043
|
},
|
|
@@ -118511,120 +119048,25 @@
|
|
|
118511
119048
|
}
|
|
118512
119049
|
}
|
|
118513
119050
|
}
|
|
118514
|
-
}
|
|
118515
|
-
}
|
|
118516
|
-
}
|
|
118517
|
-
},
|
|
118518
|
-
"/api/v1/creative-hub/credits": {
|
|
118519
|
-
"get": {
|
|
118520
|
-
"operationId": "creativeHubGetCredits",
|
|
118521
|
-
"summary": "Creative Hub credit balance",
|
|
118522
|
-
"tags": [
|
|
118523
|
-
"creative-hub"
|
|
118524
|
-
],
|
|
118525
|
-
"description": "Returns spendable AI credits for Creative Hub generation, including purchased credits and weekly grant credits.",
|
|
118526
|
-
"security": [
|
|
118527
|
-
{
|
|
118528
|
-
"bearerAuth": []
|
|
118529
|
-
},
|
|
118530
|
-
{
|
|
118531
|
-
"apiKeyAuth": []
|
|
118532
|
-
}
|
|
118533
|
-
],
|
|
118534
|
-
"responses": {
|
|
118535
|
-
"200": {
|
|
118536
|
-
"description": "Successful response",
|
|
118537
|
-
"content": {
|
|
118538
|
-
"application/json": {
|
|
118539
|
-
"schema": {
|
|
118540
|
-
"type": "object",
|
|
118541
|
-
"required": [
|
|
118542
|
-
"balance",
|
|
118543
|
-
"grant_balance",
|
|
118544
|
-
"monthly_cap",
|
|
118545
|
-
"monthly_used",
|
|
118546
|
-
"spendable",
|
|
118547
|
-
"total_purchased",
|
|
118548
|
-
"total_used"
|
|
118549
|
-
],
|
|
118550
|
-
"properties": {
|
|
118551
|
-
"balance": {
|
|
118552
|
-
"type": "number"
|
|
118553
|
-
},
|
|
118554
|
-
"grant_balance": {
|
|
118555
|
-
"type": "number"
|
|
118556
|
-
},
|
|
118557
|
-
"monthly_cap": {
|
|
118558
|
-
"anyOf": [
|
|
118559
|
-
{
|
|
118560
|
-
"type": "number"
|
|
118561
|
-
},
|
|
118562
|
-
{
|
|
118563
|
-
"type": "null"
|
|
118564
|
-
}
|
|
118565
|
-
]
|
|
118566
|
-
},
|
|
118567
|
-
"monthly_used": {
|
|
118568
|
-
"type": "number"
|
|
118569
|
-
},
|
|
118570
|
-
"spendable": {
|
|
118571
|
-
"type": "number"
|
|
118572
|
-
},
|
|
118573
|
-
"total_purchased": {
|
|
118574
|
-
"type": "number"
|
|
118575
|
-
},
|
|
118576
|
-
"total_used": {
|
|
118577
|
-
"type": "number"
|
|
118578
|
-
}
|
|
118579
|
-
}
|
|
118580
|
-
}
|
|
118581
|
-
}
|
|
118582
|
-
}
|
|
118583
119051
|
},
|
|
118584
|
-
"
|
|
118585
|
-
"description": "
|
|
118586
|
-
"content": {
|
|
118587
|
-
"application/json": {
|
|
118588
|
-
"schema": {
|
|
118589
|
-
"$ref": "#/components/schemas/ErrorResponse"
|
|
118590
|
-
}
|
|
118591
|
-
}
|
|
118592
|
-
}
|
|
118593
|
-
}
|
|
118594
|
-
}
|
|
118595
|
-
}
|
|
118596
|
-
},
|
|
118597
|
-
"/api/v1/creative-hub/ugc/products/upload": {
|
|
118598
|
-
"post": {
|
|
118599
|
-
"operationId": "creativeHubUploadUgcProductImage",
|
|
118600
|
-
"summary": "Upload a product image for UGC product-hand mode",
|
|
118601
|
-
"tags": [
|
|
118602
|
-
"creative-hub",
|
|
118603
|
-
"creative-generation"
|
|
118604
|
-
],
|
|
118605
|
-
"description": "Uploads one JPEG, PNG or WebP product image for the UGC product-hand generation mode and stores it in team-scoped creative asset storage.",
|
|
118606
|
-
"security": [
|
|
118607
|
-
{
|
|
118608
|
-
"bearerAuth": []
|
|
118609
|
-
}
|
|
118610
|
-
],
|
|
118611
|
-
"responses": {
|
|
118612
|
-
"201": {
|
|
118613
|
-
"description": "Resource created",
|
|
119052
|
+
"500": {
|
|
119053
|
+
"description": "Internal server error",
|
|
118614
119054
|
"content": {
|
|
118615
119055
|
"application/json": {
|
|
118616
119056
|
"schema": {
|
|
118617
119057
|
"additionalProperties": false,
|
|
118618
119058
|
"type": "object",
|
|
118619
119059
|
"required": [
|
|
118620
|
-
"
|
|
118621
|
-
"storage_key"
|
|
119060
|
+
"error"
|
|
118622
119061
|
],
|
|
118623
119062
|
"properties": {
|
|
118624
|
-
"
|
|
119063
|
+
"code": {
|
|
118625
119064
|
"type": "string"
|
|
118626
119065
|
},
|
|
118627
|
-
"
|
|
119066
|
+
"error": {
|
|
119067
|
+
"type": "string"
|
|
119068
|
+
},
|
|
119069
|
+
"message": {
|
|
118628
119070
|
"type": "string"
|
|
118629
119071
|
}
|
|
118630
119072
|
}
|
|
@@ -118632,8 +119074,153 @@
|
|
|
118632
119074
|
}
|
|
118633
119075
|
}
|
|
118634
119076
|
},
|
|
118635
|
-
"
|
|
118636
|
-
"description": "
|
|
119077
|
+
"503": {
|
|
119078
|
+
"description": "Service unavailable",
|
|
119079
|
+
"content": {
|
|
119080
|
+
"application/json": {
|
|
119081
|
+
"schema": {
|
|
119082
|
+
"additionalProperties": false,
|
|
119083
|
+
"type": "object",
|
|
119084
|
+
"required": [
|
|
119085
|
+
"error"
|
|
119086
|
+
],
|
|
119087
|
+
"properties": {
|
|
119088
|
+
"code": {
|
|
119089
|
+
"type": "string"
|
|
119090
|
+
},
|
|
119091
|
+
"error": {
|
|
119092
|
+
"type": "string"
|
|
119093
|
+
},
|
|
119094
|
+
"message": {
|
|
119095
|
+
"type": "string"
|
|
119096
|
+
}
|
|
119097
|
+
}
|
|
119098
|
+
}
|
|
119099
|
+
}
|
|
119100
|
+
}
|
|
119101
|
+
}
|
|
119102
|
+
}
|
|
119103
|
+
}
|
|
119104
|
+
},
|
|
119105
|
+
"/api/v1/creative-hub/credits": {
|
|
119106
|
+
"get": {
|
|
119107
|
+
"operationId": "creativeHubGetCredits",
|
|
119108
|
+
"summary": "Creative Hub credit balance",
|
|
119109
|
+
"tags": [
|
|
119110
|
+
"creative-hub"
|
|
119111
|
+
],
|
|
119112
|
+
"description": "Returns spendable AI credits for Creative Hub generation, including purchased credits and weekly grant credits.",
|
|
119113
|
+
"security": [
|
|
119114
|
+
{
|
|
119115
|
+
"bearerAuth": []
|
|
119116
|
+
},
|
|
119117
|
+
{
|
|
119118
|
+
"apiKeyAuth": []
|
|
119119
|
+
}
|
|
119120
|
+
],
|
|
119121
|
+
"responses": {
|
|
119122
|
+
"200": {
|
|
119123
|
+
"description": "Successful response",
|
|
119124
|
+
"content": {
|
|
119125
|
+
"application/json": {
|
|
119126
|
+
"schema": {
|
|
119127
|
+
"type": "object",
|
|
119128
|
+
"required": [
|
|
119129
|
+
"balance",
|
|
119130
|
+
"grant_balance",
|
|
119131
|
+
"monthly_cap",
|
|
119132
|
+
"monthly_used",
|
|
119133
|
+
"spendable",
|
|
119134
|
+
"total_purchased",
|
|
119135
|
+
"total_used"
|
|
119136
|
+
],
|
|
119137
|
+
"properties": {
|
|
119138
|
+
"balance": {
|
|
119139
|
+
"type": "number"
|
|
119140
|
+
},
|
|
119141
|
+
"grant_balance": {
|
|
119142
|
+
"type": "number"
|
|
119143
|
+
},
|
|
119144
|
+
"monthly_cap": {
|
|
119145
|
+
"anyOf": [
|
|
119146
|
+
{
|
|
119147
|
+
"type": "number"
|
|
119148
|
+
},
|
|
119149
|
+
{
|
|
119150
|
+
"type": "null"
|
|
119151
|
+
}
|
|
119152
|
+
]
|
|
119153
|
+
},
|
|
119154
|
+
"monthly_used": {
|
|
119155
|
+
"type": "number"
|
|
119156
|
+
},
|
|
119157
|
+
"spendable": {
|
|
119158
|
+
"type": "number"
|
|
119159
|
+
},
|
|
119160
|
+
"total_purchased": {
|
|
119161
|
+
"type": "number"
|
|
119162
|
+
},
|
|
119163
|
+
"total_used": {
|
|
119164
|
+
"type": "number"
|
|
119165
|
+
}
|
|
119166
|
+
}
|
|
119167
|
+
}
|
|
119168
|
+
}
|
|
119169
|
+
}
|
|
119170
|
+
},
|
|
119171
|
+
"401": {
|
|
119172
|
+
"description": "Unauthorized - missing or invalid bearer token",
|
|
119173
|
+
"content": {
|
|
119174
|
+
"application/json": {
|
|
119175
|
+
"schema": {
|
|
119176
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
119177
|
+
}
|
|
119178
|
+
}
|
|
119179
|
+
}
|
|
119180
|
+
}
|
|
119181
|
+
}
|
|
119182
|
+
}
|
|
119183
|
+
},
|
|
119184
|
+
"/api/v1/creative-hub/ugc/products/upload": {
|
|
119185
|
+
"post": {
|
|
119186
|
+
"operationId": "creativeHubUploadUgcProductImage",
|
|
119187
|
+
"summary": "Upload a product image for UGC product-hand mode",
|
|
119188
|
+
"tags": [
|
|
119189
|
+
"creative-hub",
|
|
119190
|
+
"creative-generation"
|
|
119191
|
+
],
|
|
119192
|
+
"description": "Uploads one JPEG, PNG or WebP product image for the UGC product-hand generation mode and stores it in team-scoped creative asset storage.",
|
|
119193
|
+
"security": [
|
|
119194
|
+
{
|
|
119195
|
+
"bearerAuth": []
|
|
119196
|
+
}
|
|
119197
|
+
],
|
|
119198
|
+
"responses": {
|
|
119199
|
+
"201": {
|
|
119200
|
+
"description": "Resource created",
|
|
119201
|
+
"content": {
|
|
119202
|
+
"application/json": {
|
|
119203
|
+
"schema": {
|
|
119204
|
+
"additionalProperties": false,
|
|
119205
|
+
"type": "object",
|
|
119206
|
+
"required": [
|
|
119207
|
+
"image_url",
|
|
119208
|
+
"storage_key"
|
|
119209
|
+
],
|
|
119210
|
+
"properties": {
|
|
119211
|
+
"image_url": {
|
|
119212
|
+
"type": "string"
|
|
119213
|
+
},
|
|
119214
|
+
"storage_key": {
|
|
119215
|
+
"type": "string"
|
|
119216
|
+
}
|
|
119217
|
+
}
|
|
119218
|
+
}
|
|
119219
|
+
}
|
|
119220
|
+
}
|
|
119221
|
+
},
|
|
119222
|
+
"400": {
|
|
119223
|
+
"description": "Invalid request - schema validation failed",
|
|
118637
119224
|
"content": {
|
|
118638
119225
|
"application/json": {
|
|
118639
119226
|
"schema": {
|
|
@@ -119507,6 +120094,31 @@
|
|
|
119507
120094
|
}
|
|
119508
120095
|
}
|
|
119509
120096
|
}
|
|
120097
|
+
},
|
|
120098
|
+
"503": {
|
|
120099
|
+
"description": "Service unavailable",
|
|
120100
|
+
"content": {
|
|
120101
|
+
"application/json": {
|
|
120102
|
+
"schema": {
|
|
120103
|
+
"additionalProperties": false,
|
|
120104
|
+
"type": "object",
|
|
120105
|
+
"required": [
|
|
120106
|
+
"error"
|
|
120107
|
+
],
|
|
120108
|
+
"properties": {
|
|
120109
|
+
"code": {
|
|
120110
|
+
"type": "string"
|
|
120111
|
+
},
|
|
120112
|
+
"error": {
|
|
120113
|
+
"type": "string"
|
|
120114
|
+
},
|
|
120115
|
+
"message": {
|
|
120116
|
+
"type": "string"
|
|
120117
|
+
}
|
|
120118
|
+
}
|
|
120119
|
+
}
|
|
120120
|
+
}
|
|
120121
|
+
}
|
|
119510
120122
|
}
|
|
119511
120123
|
}
|
|
119512
120124
|
}
|
|
@@ -119519,7 +120131,7 @@
|
|
|
119519
120131
|
"creative-hub",
|
|
119520
120132
|
"creative-generation"
|
|
119521
120133
|
],
|
|
119522
|
-
"description": "Returns the deterministic credit estimate for a UGC generation request without starting a provider job.",
|
|
120134
|
+
"description": "Returns the deterministic credit estimate for a UGC generation request without starting a provider job. The estimate is computed from the SAME resolved billing input the generate endpoint charges from, so it accounts for the two effects that used to make the charge exceed the quote: a spoken script longer than the requested duration extends the billable duration (up to 15s, reported as duration_source), and a product photo adds a product-description line. Supply script_word_count and has_product_image to get the exact amount that will be charged; omitting them yields the floor of that amount.",
|
|
119523
120135
|
"requestBody": {
|
|
119524
120136
|
"required": true,
|
|
119525
120137
|
"content": {
|
|
@@ -119584,7 +120196,19 @@
|
|
|
119584
120196
|
"captions": {
|
|
119585
120197
|
"type": "boolean"
|
|
119586
120198
|
},
|
|
120199
|
+
"has_product_image": {
|
|
120200
|
+
"description": "Whether a product photo will be attached. It triggers a real product-description model call, so it raises the estimate. mode=product_hand implies true (the photo is mandatory there).",
|
|
120201
|
+
"type": "boolean"
|
|
120202
|
+
},
|
|
120203
|
+
"script_word_count": {
|
|
120204
|
+
"minimum": 0,
|
|
120205
|
+
"maximum": 2000,
|
|
120206
|
+
"description": "Word count of the user-supplied script (not the script itself — this endpoint performs no I/O and stores nothing). Used to detect a spoken duration longer than duration_seconds. Ignored for mode=ai_script, where the script is written to fit the requested duration.",
|
|
120207
|
+
"type": "integer"
|
|
120208
|
+
},
|
|
119587
120209
|
"model_id": {
|
|
120210
|
+
"deprecated": true,
|
|
120211
|
+
"description": "DEPRECATED and ignored: the UGC engine model is not caller-selectable. Kept so existing SDK clients that still send it do not start failing schema validation. It will be removed in a future major version.",
|
|
119588
120212
|
"type": "string"
|
|
119589
120213
|
}
|
|
119590
120214
|
}
|
|
@@ -119606,13 +120230,100 @@
|
|
|
119606
120230
|
"content": {
|
|
119607
120231
|
"application/json": {
|
|
119608
120232
|
"schema": {
|
|
120233
|
+
"additionalProperties": false,
|
|
119609
120234
|
"type": "object",
|
|
119610
120235
|
"required": [
|
|
119611
|
-
"credits"
|
|
120236
|
+
"credits",
|
|
120237
|
+
"breakdown",
|
|
120238
|
+
"billable_seconds",
|
|
120239
|
+
"duration_source",
|
|
120240
|
+
"resolution_multiplier",
|
|
120241
|
+
"pricing_version"
|
|
119612
120242
|
],
|
|
119613
120243
|
"properties": {
|
|
119614
120244
|
"credits": {
|
|
120245
|
+
"description": "Total credits that will be held and charged.",
|
|
119615
120246
|
"type": "integer"
|
|
120247
|
+
},
|
|
120248
|
+
"breakdown": {
|
|
120249
|
+
"description": "Per catalog line contribution to the total.",
|
|
120250
|
+
"type": "array",
|
|
120251
|
+
"items": {
|
|
120252
|
+
"additionalProperties": false,
|
|
120253
|
+
"type": "object",
|
|
120254
|
+
"required": [
|
|
120255
|
+
"model_id",
|
|
120256
|
+
"retail_credits",
|
|
120257
|
+
"unit",
|
|
120258
|
+
"units"
|
|
120259
|
+
],
|
|
120260
|
+
"properties": {
|
|
120261
|
+
"model_id": {
|
|
120262
|
+
"type": "string"
|
|
120263
|
+
},
|
|
120264
|
+
"retail_credits": {
|
|
120265
|
+
"type": "integer"
|
|
120266
|
+
},
|
|
120267
|
+
"unit": {
|
|
120268
|
+
"type": "string"
|
|
120269
|
+
},
|
|
120270
|
+
"units": {
|
|
120271
|
+
"type": "number"
|
|
120272
|
+
}
|
|
120273
|
+
}
|
|
120274
|
+
}
|
|
120275
|
+
},
|
|
120276
|
+
"billable_seconds": {
|
|
120277
|
+
"description": "Seconds actually billed (minimum 8s, capped at 15s).",
|
|
120278
|
+
"type": "integer"
|
|
120279
|
+
},
|
|
120280
|
+
"duration_source": {
|
|
120281
|
+
"description": "extended_to_spoken means the spoken script is longer than the requested duration, so the billable duration was raised to fit it.",
|
|
120282
|
+
"anyOf": [
|
|
120283
|
+
{
|
|
120284
|
+
"type": "string",
|
|
120285
|
+
"enum": [
|
|
120286
|
+
"requested"
|
|
120287
|
+
]
|
|
120288
|
+
},
|
|
120289
|
+
{
|
|
120290
|
+
"type": "string",
|
|
120291
|
+
"enum": [
|
|
120292
|
+
"extended_to_spoken"
|
|
120293
|
+
]
|
|
120294
|
+
}
|
|
120295
|
+
]
|
|
120296
|
+
},
|
|
120297
|
+
"resolution_multiplier": {
|
|
120298
|
+
"type": "number"
|
|
120299
|
+
},
|
|
120300
|
+
"pricing_version": {
|
|
120301
|
+
"type": "string"
|
|
120302
|
+
}
|
|
120303
|
+
}
|
|
120304
|
+
}
|
|
120305
|
+
}
|
|
120306
|
+
}
|
|
120307
|
+
},
|
|
120308
|
+
"400": {
|
|
120309
|
+
"description": "Invalid request - schema validation failed",
|
|
120310
|
+
"content": {
|
|
120311
|
+
"application/json": {
|
|
120312
|
+
"schema": {
|
|
120313
|
+
"additionalProperties": false,
|
|
120314
|
+
"type": "object",
|
|
120315
|
+
"required": [
|
|
120316
|
+
"error"
|
|
120317
|
+
],
|
|
120318
|
+
"properties": {
|
|
120319
|
+
"code": {
|
|
120320
|
+
"type": "string"
|
|
120321
|
+
},
|
|
120322
|
+
"error": {
|
|
120323
|
+
"type": "string"
|
|
120324
|
+
},
|
|
120325
|
+
"message": {
|
|
120326
|
+
"type": "string"
|
|
119616
120327
|
}
|
|
119617
120328
|
}
|
|
119618
120329
|
}
|
|
@@ -120591,6 +121302,27 @@
|
|
|
120591
121302
|
}
|
|
120592
121303
|
}
|
|
120593
121304
|
},
|
|
121305
|
+
"429": {
|
|
121306
|
+
"description": "Too many requests - rate limit exceeded",
|
|
121307
|
+
"content": {
|
|
121308
|
+
"application/json": {
|
|
121309
|
+
"schema": {
|
|
121310
|
+
"type": "object",
|
|
121311
|
+
"required": [
|
|
121312
|
+
"error"
|
|
121313
|
+
],
|
|
121314
|
+
"properties": {
|
|
121315
|
+
"error": {
|
|
121316
|
+
"type": "string"
|
|
121317
|
+
},
|
|
121318
|
+
"code": {
|
|
121319
|
+
"type": "string"
|
|
121320
|
+
}
|
|
121321
|
+
}
|
|
121322
|
+
}
|
|
121323
|
+
}
|
|
121324
|
+
}
|
|
121325
|
+
},
|
|
120594
121326
|
"500": {
|
|
120595
121327
|
"description": "Internal server error",
|
|
120596
121328
|
"content": {
|
|
@@ -120608,6 +121340,28 @@
|
|
|
120608
121340
|
}
|
|
120609
121341
|
}
|
|
120610
121342
|
}
|
|
121343
|
+
},
|
|
121344
|
+
"503": {
|
|
121345
|
+
"description": "Service unavailable",
|
|
121346
|
+
"content": {
|
|
121347
|
+
"application/json": {
|
|
121348
|
+
"schema": {
|
|
121349
|
+
"type": "object",
|
|
121350
|
+
"required": [
|
|
121351
|
+
"error",
|
|
121352
|
+
"code"
|
|
121353
|
+
],
|
|
121354
|
+
"properties": {
|
|
121355
|
+
"error": {
|
|
121356
|
+
"type": "string"
|
|
121357
|
+
},
|
|
121358
|
+
"code": {
|
|
121359
|
+
"type": "string"
|
|
121360
|
+
}
|
|
121361
|
+
}
|
|
121362
|
+
}
|
|
121363
|
+
}
|
|
121364
|
+
}
|
|
120611
121365
|
}
|
|
120612
121366
|
}
|
|
120613
121367
|
}
|
|
@@ -120964,6 +121718,175 @@
|
|
|
120964
121718
|
}
|
|
120965
121719
|
}
|
|
120966
121720
|
}
|
|
121721
|
+
},
|
|
121722
|
+
"503": {
|
|
121723
|
+
"description": "Service unavailable",
|
|
121724
|
+
"content": {
|
|
121725
|
+
"application/json": {
|
|
121726
|
+
"schema": {
|
|
121727
|
+
"additionalProperties": false,
|
|
121728
|
+
"type": "object",
|
|
121729
|
+
"required": [
|
|
121730
|
+
"error"
|
|
121731
|
+
],
|
|
121732
|
+
"properties": {
|
|
121733
|
+
"code": {
|
|
121734
|
+
"type": "string"
|
|
121735
|
+
},
|
|
121736
|
+
"error": {
|
|
121737
|
+
"type": "string"
|
|
121738
|
+
},
|
|
121739
|
+
"message": {
|
|
121740
|
+
"type": "string"
|
|
121741
|
+
}
|
|
121742
|
+
}
|
|
121743
|
+
}
|
|
121744
|
+
}
|
|
121745
|
+
}
|
|
121746
|
+
}
|
|
121747
|
+
}
|
|
121748
|
+
}
|
|
121749
|
+
},
|
|
121750
|
+
"/api/v1/creative-hub/video-studio/estimate": {
|
|
121751
|
+
"post": {
|
|
121752
|
+
"operationId": "creativeHubEstimateCinematicVideo",
|
|
121753
|
+
"summary": "Estimate cinematic video generation credit cost",
|
|
121754
|
+
"tags": [
|
|
121755
|
+
"creative-hub",
|
|
121756
|
+
"creative-generation"
|
|
121757
|
+
],
|
|
121758
|
+
"description": "Returns the deterministic credit hold estimate for a cinematic video generation, from the same catalog rates the generation is charged at.",
|
|
121759
|
+
"requestBody": {
|
|
121760
|
+
"required": true,
|
|
121761
|
+
"content": {
|
|
121762
|
+
"application/json": {
|
|
121763
|
+
"schema": {
|
|
121764
|
+
"additionalProperties": false,
|
|
121765
|
+
"type": "object",
|
|
121766
|
+
"properties": {
|
|
121767
|
+
"duration": {
|
|
121768
|
+
"anyOf": [
|
|
121769
|
+
{
|
|
121770
|
+
"type": "number",
|
|
121771
|
+
"enum": [
|
|
121772
|
+
4
|
|
121773
|
+
]
|
|
121774
|
+
},
|
|
121775
|
+
{
|
|
121776
|
+
"type": "number",
|
|
121777
|
+
"enum": [
|
|
121778
|
+
5
|
|
121779
|
+
]
|
|
121780
|
+
},
|
|
121781
|
+
{
|
|
121782
|
+
"type": "number",
|
|
121783
|
+
"enum": [
|
|
121784
|
+
6
|
|
121785
|
+
]
|
|
121786
|
+
},
|
|
121787
|
+
{
|
|
121788
|
+
"type": "number",
|
|
121789
|
+
"enum": [
|
|
121790
|
+
8
|
|
121791
|
+
]
|
|
121792
|
+
},
|
|
121793
|
+
{
|
|
121794
|
+
"type": "number",
|
|
121795
|
+
"enum": [
|
|
121796
|
+
10
|
|
121797
|
+
]
|
|
121798
|
+
}
|
|
121799
|
+
]
|
|
121800
|
+
},
|
|
121801
|
+
"provider": {
|
|
121802
|
+
"anyOf": [
|
|
121803
|
+
{
|
|
121804
|
+
"type": "string",
|
|
121805
|
+
"enum": [
|
|
121806
|
+
"kling_3_0"
|
|
121807
|
+
]
|
|
121808
|
+
},
|
|
121809
|
+
{
|
|
121810
|
+
"type": "string",
|
|
121811
|
+
"enum": [
|
|
121812
|
+
"veo_3_1"
|
|
121813
|
+
]
|
|
121814
|
+
},
|
|
121815
|
+
{
|
|
121816
|
+
"type": "string",
|
|
121817
|
+
"enum": [
|
|
121818
|
+
"seedance_pro"
|
|
121819
|
+
]
|
|
121820
|
+
}
|
|
121821
|
+
]
|
|
121822
|
+
}
|
|
121823
|
+
}
|
|
121824
|
+
}
|
|
121825
|
+
}
|
|
121826
|
+
}
|
|
121827
|
+
},
|
|
121828
|
+
"security": [
|
|
121829
|
+
{
|
|
121830
|
+
"bearerAuth": []
|
|
121831
|
+
},
|
|
121832
|
+
{
|
|
121833
|
+
"apiKeyAuth": []
|
|
121834
|
+
}
|
|
121835
|
+
],
|
|
121836
|
+
"responses": {
|
|
121837
|
+
"200": {
|
|
121838
|
+
"description": "Successful response",
|
|
121839
|
+
"content": {
|
|
121840
|
+
"application/json": {
|
|
121841
|
+
"schema": {
|
|
121842
|
+
"additionalProperties": false,
|
|
121843
|
+
"type": "object",
|
|
121844
|
+
"required": [
|
|
121845
|
+
"credits"
|
|
121846
|
+
],
|
|
121847
|
+
"properties": {
|
|
121848
|
+
"credits": {
|
|
121849
|
+
"type": "integer"
|
|
121850
|
+
}
|
|
121851
|
+
}
|
|
121852
|
+
}
|
|
121853
|
+
}
|
|
121854
|
+
}
|
|
121855
|
+
},
|
|
121856
|
+
"400": {
|
|
121857
|
+
"description": "Invalid request - schema validation failed",
|
|
121858
|
+
"content": {
|
|
121859
|
+
"application/json": {
|
|
121860
|
+
"schema": {
|
|
121861
|
+
"additionalProperties": false,
|
|
121862
|
+
"type": "object",
|
|
121863
|
+
"required": [
|
|
121864
|
+
"error"
|
|
121865
|
+
],
|
|
121866
|
+
"properties": {
|
|
121867
|
+
"code": {
|
|
121868
|
+
"type": "string"
|
|
121869
|
+
},
|
|
121870
|
+
"error": {
|
|
121871
|
+
"type": "string"
|
|
121872
|
+
},
|
|
121873
|
+
"message": {
|
|
121874
|
+
"type": "string"
|
|
121875
|
+
}
|
|
121876
|
+
}
|
|
121877
|
+
}
|
|
121878
|
+
}
|
|
121879
|
+
}
|
|
121880
|
+
},
|
|
121881
|
+
"401": {
|
|
121882
|
+
"description": "Unauthorized - missing or invalid bearer token",
|
|
121883
|
+
"content": {
|
|
121884
|
+
"application/json": {
|
|
121885
|
+
"schema": {
|
|
121886
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
121887
|
+
}
|
|
121888
|
+
}
|
|
121889
|
+
}
|
|
120967
121890
|
}
|
|
120968
121891
|
}
|
|
120969
121892
|
}
|
|
@@ -121892,6 +122815,9 @@
|
|
|
121892
122815
|
"error"
|
|
121893
122816
|
],
|
|
121894
122817
|
"properties": {
|
|
122818
|
+
"code": {
|
|
122819
|
+
"type": "string"
|
|
122820
|
+
},
|
|
121895
122821
|
"error": {
|
|
121896
122822
|
"type": "string"
|
|
121897
122823
|
},
|
|
@@ -121914,6 +122840,9 @@
|
|
|
121914
122840
|
"error"
|
|
121915
122841
|
],
|
|
121916
122842
|
"properties": {
|
|
122843
|
+
"code": {
|
|
122844
|
+
"type": "string"
|
|
122845
|
+
},
|
|
121917
122846
|
"error": {
|
|
121918
122847
|
"type": "string"
|
|
121919
122848
|
},
|
|
@@ -121936,6 +122865,9 @@
|
|
|
121936
122865
|
"error"
|
|
121937
122866
|
],
|
|
121938
122867
|
"properties": {
|
|
122868
|
+
"code": {
|
|
122869
|
+
"type": "string"
|
|
122870
|
+
},
|
|
121939
122871
|
"error": {
|
|
121940
122872
|
"type": "string"
|
|
121941
122873
|
},
|
|
@@ -122018,6 +122950,9 @@
|
|
|
122018
122950
|
"error"
|
|
122019
122951
|
],
|
|
122020
122952
|
"properties": {
|
|
122953
|
+
"code": {
|
|
122954
|
+
"type": "string"
|
|
122955
|
+
},
|
|
122021
122956
|
"error": {
|
|
122022
122957
|
"type": "string"
|
|
122023
122958
|
},
|
|
@@ -122040,6 +122975,34 @@
|
|
|
122040
122975
|
"error"
|
|
122041
122976
|
],
|
|
122042
122977
|
"properties": {
|
|
122978
|
+
"code": {
|
|
122979
|
+
"type": "string"
|
|
122980
|
+
},
|
|
122981
|
+
"error": {
|
|
122982
|
+
"type": "string"
|
|
122983
|
+
},
|
|
122984
|
+
"message": {
|
|
122985
|
+
"type": "string"
|
|
122986
|
+
}
|
|
122987
|
+
}
|
|
122988
|
+
}
|
|
122989
|
+
}
|
|
122990
|
+
}
|
|
122991
|
+
},
|
|
122992
|
+
"429": {
|
|
122993
|
+
"description": "Too many requests - rate limit exceeded",
|
|
122994
|
+
"content": {
|
|
122995
|
+
"application/json": {
|
|
122996
|
+
"schema": {
|
|
122997
|
+
"additionalProperties": false,
|
|
122998
|
+
"type": "object",
|
|
122999
|
+
"required": [
|
|
123000
|
+
"error"
|
|
123001
|
+
],
|
|
123002
|
+
"properties": {
|
|
123003
|
+
"code": {
|
|
123004
|
+
"type": "string"
|
|
123005
|
+
},
|
|
122043
123006
|
"error": {
|
|
122044
123007
|
"type": "string"
|
|
122045
123008
|
},
|
|
@@ -122069,6 +123032,31 @@
|
|
|
122069
123032
|
}
|
|
122070
123033
|
}
|
|
122071
123034
|
}
|
|
123035
|
+
},
|
|
123036
|
+
"503": {
|
|
123037
|
+
"description": "Service unavailable",
|
|
123038
|
+
"content": {
|
|
123039
|
+
"application/json": {
|
|
123040
|
+
"schema": {
|
|
123041
|
+
"additionalProperties": false,
|
|
123042
|
+
"type": "object",
|
|
123043
|
+
"required": [
|
|
123044
|
+
"error"
|
|
123045
|
+
],
|
|
123046
|
+
"properties": {
|
|
123047
|
+
"code": {
|
|
123048
|
+
"type": "string"
|
|
123049
|
+
},
|
|
123050
|
+
"error": {
|
|
123051
|
+
"type": "string"
|
|
123052
|
+
},
|
|
123053
|
+
"message": {
|
|
123054
|
+
"type": "string"
|
|
123055
|
+
}
|
|
123056
|
+
}
|
|
123057
|
+
}
|
|
123058
|
+
}
|
|
123059
|
+
}
|
|
122072
123060
|
}
|
|
122073
123061
|
}
|
|
122074
123062
|
}
|
|
@@ -122184,6 +123172,9 @@
|
|
|
122184
123172
|
"error"
|
|
122185
123173
|
],
|
|
122186
123174
|
"properties": {
|
|
123175
|
+
"code": {
|
|
123176
|
+
"type": "string"
|
|
123177
|
+
},
|
|
122187
123178
|
"error": {
|
|
122188
123179
|
"type": "string"
|
|
122189
123180
|
},
|
|
@@ -122216,6 +123207,9 @@
|
|
|
122216
123207
|
"error"
|
|
122217
123208
|
],
|
|
122218
123209
|
"properties": {
|
|
123210
|
+
"code": {
|
|
123211
|
+
"type": "string"
|
|
123212
|
+
},
|
|
122219
123213
|
"error": {
|
|
122220
123214
|
"type": "string"
|
|
122221
123215
|
},
|
|
@@ -122349,6 +123343,9 @@
|
|
|
122349
123343
|
"error"
|
|
122350
123344
|
],
|
|
122351
123345
|
"properties": {
|
|
123346
|
+
"code": {
|
|
123347
|
+
"type": "string"
|
|
123348
|
+
},
|
|
122352
123349
|
"error": {
|
|
122353
123350
|
"type": "string"
|
|
122354
123351
|
},
|
|
@@ -122381,6 +123378,9 @@
|
|
|
122381
123378
|
"error"
|
|
122382
123379
|
],
|
|
122383
123380
|
"properties": {
|
|
123381
|
+
"code": {
|
|
123382
|
+
"type": "string"
|
|
123383
|
+
},
|
|
122384
123384
|
"error": {
|
|
122385
123385
|
"type": "string"
|
|
122386
123386
|
},
|
|
@@ -122403,6 +123403,9 @@
|
|
|
122403
123403
|
"error"
|
|
122404
123404
|
],
|
|
122405
123405
|
"properties": {
|
|
123406
|
+
"code": {
|
|
123407
|
+
"type": "string"
|
|
123408
|
+
},
|
|
122406
123409
|
"error": {
|
|
122407
123410
|
"type": "string"
|
|
122408
123411
|
},
|
|
@@ -122425,6 +123428,34 @@
|
|
|
122425
123428
|
"error"
|
|
122426
123429
|
],
|
|
122427
123430
|
"properties": {
|
|
123431
|
+
"code": {
|
|
123432
|
+
"type": "string"
|
|
123433
|
+
},
|
|
123434
|
+
"error": {
|
|
123435
|
+
"type": "string"
|
|
123436
|
+
},
|
|
123437
|
+
"message": {
|
|
123438
|
+
"type": "string"
|
|
123439
|
+
}
|
|
123440
|
+
}
|
|
123441
|
+
}
|
|
123442
|
+
}
|
|
123443
|
+
}
|
|
123444
|
+
},
|
|
123445
|
+
"429": {
|
|
123446
|
+
"description": "Too many requests - rate limit exceeded",
|
|
123447
|
+
"content": {
|
|
123448
|
+
"application/json": {
|
|
123449
|
+
"schema": {
|
|
123450
|
+
"additionalProperties": false,
|
|
123451
|
+
"type": "object",
|
|
123452
|
+
"required": [
|
|
123453
|
+
"error"
|
|
123454
|
+
],
|
|
123455
|
+
"properties": {
|
|
123456
|
+
"code": {
|
|
123457
|
+
"type": "string"
|
|
123458
|
+
},
|
|
122428
123459
|
"error": {
|
|
122429
123460
|
"type": "string"
|
|
122430
123461
|
},
|
|
@@ -122447,6 +123478,34 @@
|
|
|
122447
123478
|
"error"
|
|
122448
123479
|
],
|
|
122449
123480
|
"properties": {
|
|
123481
|
+
"code": {
|
|
123482
|
+
"type": "string"
|
|
123483
|
+
},
|
|
123484
|
+
"error": {
|
|
123485
|
+
"type": "string"
|
|
123486
|
+
},
|
|
123487
|
+
"message": {
|
|
123488
|
+
"type": "string"
|
|
123489
|
+
}
|
|
123490
|
+
}
|
|
123491
|
+
}
|
|
123492
|
+
}
|
|
123493
|
+
}
|
|
123494
|
+
},
|
|
123495
|
+
"503": {
|
|
123496
|
+
"description": "Service unavailable",
|
|
123497
|
+
"content": {
|
|
123498
|
+
"application/json": {
|
|
123499
|
+
"schema": {
|
|
123500
|
+
"additionalProperties": false,
|
|
123501
|
+
"type": "object",
|
|
123502
|
+
"required": [
|
|
123503
|
+
"error"
|
|
123504
|
+
],
|
|
123505
|
+
"properties": {
|
|
123506
|
+
"code": {
|
|
123507
|
+
"type": "string"
|
|
123508
|
+
},
|
|
122450
123509
|
"error": {
|
|
122451
123510
|
"type": "string"
|
|
122452
123511
|
},
|
|
@@ -122611,6 +123670,9 @@
|
|
|
122611
123670
|
"error"
|
|
122612
123671
|
],
|
|
122613
123672
|
"properties": {
|
|
123673
|
+
"code": {
|
|
123674
|
+
"type": "string"
|
|
123675
|
+
},
|
|
122614
123676
|
"error": {
|
|
122615
123677
|
"type": "string"
|
|
122616
123678
|
},
|
|
@@ -122633,6 +123695,9 @@
|
|
|
122633
123695
|
"error"
|
|
122634
123696
|
],
|
|
122635
123697
|
"properties": {
|
|
123698
|
+
"code": {
|
|
123699
|
+
"type": "string"
|
|
123700
|
+
},
|
|
122636
123701
|
"error": {
|
|
122637
123702
|
"type": "string"
|
|
122638
123703
|
},
|
|
@@ -159351,6 +160416,7 @@
|
|
|
159351
160416
|
"clocks",
|
|
159352
160417
|
"collection_mode",
|
|
159353
160418
|
"coupon",
|
|
160419
|
+
"credit",
|
|
159354
160420
|
"frozen",
|
|
159355
160421
|
"kyc_level",
|
|
159356
160422
|
"lane",
|
|
@@ -159360,6 +160426,7 @@
|
|
|
159360
160426
|
"payout_ready",
|
|
159361
160427
|
"primary_link",
|
|
159362
160428
|
"public_profile",
|
|
160429
|
+
"reconsent",
|
|
159363
160430
|
"redirector_origin",
|
|
159364
160431
|
"slug_changes_remaining",
|
|
159365
160432
|
"status",
|
|
@@ -159455,6 +160522,70 @@
|
|
|
159455
160522
|
}
|
|
159456
160523
|
]
|
|
159457
160524
|
},
|
|
160525
|
+
"credit": {
|
|
160526
|
+
"description": "Credito di fatturazione del Binario A, `null` per chi non è un cliente-referrer.",
|
|
160527
|
+
"anyOf": [
|
|
160528
|
+
{
|
|
160529
|
+
"additionalProperties": false,
|
|
160530
|
+
"type": "object",
|
|
160531
|
+
"required": [
|
|
160532
|
+
"applied_invoices",
|
|
160533
|
+
"available_minor",
|
|
160534
|
+
"currency",
|
|
160535
|
+
"locked_minor",
|
|
160536
|
+
"next_expiry_at",
|
|
160537
|
+
"pending_review_minor",
|
|
160538
|
+
"reserved_minor"
|
|
160539
|
+
],
|
|
160540
|
+
"properties": {
|
|
160541
|
+
"applied_invoices": {
|
|
160542
|
+
"description": "Fatture DISTINTE che hanno ricevuto il credito. ⚠️ Non è il numero di clienti portati: il pannello mostrava quello, e un cliente con credito 0 leggeva «applicato a 2 fatture».",
|
|
160543
|
+
"minimum": 0,
|
|
160544
|
+
"type": "integer"
|
|
160545
|
+
},
|
|
160546
|
+
"available_minor": {
|
|
160547
|
+
"description": "Spendibile ORA sulla prossima fattura. Minor units (centesimi) come stringa decimale.",
|
|
160548
|
+
"pattern": "^-?[0-9]+$",
|
|
160549
|
+
"type": "string"
|
|
160550
|
+
},
|
|
160551
|
+
"currency": {
|
|
160552
|
+
"description": "Valuta del credito. Il libro del Binario A è EUR.",
|
|
160553
|
+
"type": "string"
|
|
160554
|
+
},
|
|
160555
|
+
"locked_minor": {
|
|
160556
|
+
"description": "Maturato ma non spendibile: nessun abbonamento capace di consumarlo (§2.6). Minor units (centesimi) come stringa decimale.",
|
|
160557
|
+
"pattern": "^-?[0-9]+$",
|
|
160558
|
+
"type": "string"
|
|
160559
|
+
},
|
|
160560
|
+
"next_expiry_at": {
|
|
160561
|
+
"description": "Prima scadenza utile fra le maturazioni ancora coperte dal residuo.",
|
|
160562
|
+
"anyOf": [
|
|
160563
|
+
{
|
|
160564
|
+
"format": "date-time",
|
|
160565
|
+
"type": "string"
|
|
160566
|
+
},
|
|
160567
|
+
{
|
|
160568
|
+
"type": "null"
|
|
160569
|
+
}
|
|
160570
|
+
]
|
|
160571
|
+
},
|
|
160572
|
+
"pending_review_minor": {
|
|
160573
|
+
"description": "Maturato, non revocato, fermo in revisione umana (§6.4 A3). Minor units (centesimi) come stringa decimale.",
|
|
160574
|
+
"pattern": "^-?[0-9]+$",
|
|
160575
|
+
"type": "string"
|
|
160576
|
+
},
|
|
160577
|
+
"reserved_minor": {
|
|
160578
|
+
"description": "Già spinto sul saldo Stripe, non ancora riconciliato. Minor units (centesimi) come stringa decimale.",
|
|
160579
|
+
"pattern": "^-?[0-9]+$",
|
|
160580
|
+
"type": "string"
|
|
160581
|
+
}
|
|
160582
|
+
}
|
|
160583
|
+
},
|
|
160584
|
+
{
|
|
160585
|
+
"type": "null"
|
|
160586
|
+
}
|
|
160587
|
+
]
|
|
160588
|
+
},
|
|
159458
160589
|
"frozen": {
|
|
159459
160590
|
"description": "Kill-switch armato: il denaro è congelato, il tracking no.",
|
|
159460
160591
|
"type": "boolean"
|
|
@@ -159651,6 +160782,118 @@
|
|
|
159651
160782
|
}
|
|
159652
160783
|
}
|
|
159653
160784
|
},
|
|
160785
|
+
"reconsent": {
|
|
160786
|
+
"additionalProperties": false,
|
|
160787
|
+
"description": "Stato del ri-consenso ai termini di programma: cosa manca e se è esigibile.",
|
|
160788
|
+
"type": "object",
|
|
160789
|
+
"required": [
|
|
160790
|
+
"accepted_documents",
|
|
160791
|
+
"accepted_program_version",
|
|
160792
|
+
"current_program_version",
|
|
160793
|
+
"outstanding_documents",
|
|
160794
|
+
"reasons",
|
|
160795
|
+
"required"
|
|
160796
|
+
],
|
|
160797
|
+
"properties": {
|
|
160798
|
+
"accepted_documents": {
|
|
160799
|
+
"additionalProperties": false,
|
|
160800
|
+
"description": "Versione accettata per ciascun documento di programma. Input di `outstandingPartnerDocuments()`.",
|
|
160801
|
+
"type": "object",
|
|
160802
|
+
"properties": {
|
|
160803
|
+
"partnerContentAddendum": {
|
|
160804
|
+
"description": "Versione accettata di partnerContentAddendum. Assente = mai accettato.",
|
|
160805
|
+
"type": "string"
|
|
160806
|
+
},
|
|
160807
|
+
"partnerSelfBilling": {
|
|
160808
|
+
"description": "Versione accettata di partnerSelfBilling. Assente = mai accettato.",
|
|
160809
|
+
"type": "string"
|
|
160810
|
+
},
|
|
160811
|
+
"partnerTerms": {
|
|
160812
|
+
"description": "Versione accettata di partnerTerms. Assente = mai accettato.",
|
|
160813
|
+
"type": "string"
|
|
160814
|
+
},
|
|
160815
|
+
"referralTerms": {
|
|
160816
|
+
"description": "Versione accettata di referralTerms. Assente = mai accettato.",
|
|
160817
|
+
"type": "string"
|
|
160818
|
+
}
|
|
160819
|
+
}
|
|
160820
|
+
},
|
|
160821
|
+
"accepted_program_version": {
|
|
160822
|
+
"description": "Riferimento a una `partner_program_version`, `null` quando non ne esiste una.",
|
|
160823
|
+
"anyOf": [
|
|
160824
|
+
{
|
|
160825
|
+
"additionalProperties": false,
|
|
160826
|
+
"type": "object",
|
|
160827
|
+
"required": [
|
|
160828
|
+
"id",
|
|
160829
|
+
"version"
|
|
160830
|
+
],
|
|
160831
|
+
"properties": {
|
|
160832
|
+
"id": {
|
|
160833
|
+
"description": "Id della versione di programma.",
|
|
160834
|
+
"format": "uuid",
|
|
160835
|
+
"type": "string"
|
|
160836
|
+
},
|
|
160837
|
+
"version": {
|
|
160838
|
+
"description": "Etichetta di versione, es. `1.0`.",
|
|
160839
|
+
"type": "string"
|
|
160840
|
+
}
|
|
160841
|
+
}
|
|
160842
|
+
},
|
|
160843
|
+
{
|
|
160844
|
+
"type": "null"
|
|
160845
|
+
}
|
|
160846
|
+
]
|
|
160847
|
+
},
|
|
160848
|
+
"current_program_version": {
|
|
160849
|
+
"description": "Riferimento a una `partner_program_version`, `null` quando non ne esiste una.",
|
|
160850
|
+
"anyOf": [
|
|
160851
|
+
{
|
|
160852
|
+
"additionalProperties": false,
|
|
160853
|
+
"type": "object",
|
|
160854
|
+
"required": [
|
|
160855
|
+
"id",
|
|
160856
|
+
"version"
|
|
160857
|
+
],
|
|
160858
|
+
"properties": {
|
|
160859
|
+
"id": {
|
|
160860
|
+
"description": "Id della versione di programma.",
|
|
160861
|
+
"format": "uuid",
|
|
160862
|
+
"type": "string"
|
|
160863
|
+
},
|
|
160864
|
+
"version": {
|
|
160865
|
+
"description": "Etichetta di versione, es. `1.0`.",
|
|
160866
|
+
"type": "string"
|
|
160867
|
+
}
|
|
160868
|
+
}
|
|
160869
|
+
},
|
|
160870
|
+
{
|
|
160871
|
+
"type": "null"
|
|
160872
|
+
}
|
|
160873
|
+
]
|
|
160874
|
+
},
|
|
160875
|
+
"outstanding_documents": {
|
|
160876
|
+
"description": "Documenti la cui versione accettata differisce dalla corrente. Rilevamento puro: comprende anche i documenti il cui testo non esiste ancora, perché non accettati lo sono comunque.",
|
|
160877
|
+
"type": "array",
|
|
160878
|
+
"items": {
|
|
160879
|
+
"description": "Id del documento di programma.",
|
|
160880
|
+
"type": "string"
|
|
160881
|
+
}
|
|
160882
|
+
},
|
|
160883
|
+
"reasons": {
|
|
160884
|
+
"description": "Perché il ri-consenso è dovuto. Vuoto quando `required` è false.",
|
|
160885
|
+
"type": "array",
|
|
160886
|
+
"items": {
|
|
160887
|
+
"description": "never_enrolled | program_version_superseded | documents_outdated.",
|
|
160888
|
+
"type": "string"
|
|
160889
|
+
}
|
|
160890
|
+
},
|
|
160891
|
+
"required": {
|
|
160892
|
+
"description": "true solo quando esiste qualcosa che il partner può DAVVERO riaccettare (vedi `reasons`).",
|
|
160893
|
+
"type": "boolean"
|
|
160894
|
+
}
|
|
160895
|
+
}
|
|
160896
|
+
},
|
|
159654
160897
|
"redirector_origin": {
|
|
159655
160898
|
"description": "Origine pubblica del redirector, così stage e produzione non divergono per un build flag (§12.2).",
|
|
159656
160899
|
"type": "string"
|
|
@@ -160377,70 +161620,56 @@
|
|
|
160377
161620
|
}
|
|
160378
161621
|
}
|
|
160379
161622
|
},
|
|
160380
|
-
"/api/v1/partner/
|
|
160381
|
-
"
|
|
160382
|
-
"operationId": "
|
|
160383
|
-
"summary": "
|
|
161623
|
+
"/api/v1/partner/consent": {
|
|
161624
|
+
"post": {
|
|
161625
|
+
"operationId": "recordPartnerConsent",
|
|
161626
|
+
"summary": "Accetta i documenti di programma alla loro versione corrente",
|
|
160384
161627
|
"tags": [
|
|
160385
161628
|
"partner"
|
|
160386
161629
|
],
|
|
160387
|
-
"description": "
|
|
161630
|
+
"description": "Registra l’accettazione dei documenti di programma da parte del partner autenticato: una riga `legal_consent` per documento e, quando esiste una versione di programma pubblicata per il suo binario, una riga `partner_program_enrollment`. L’adesione è APPEND-ONLY (`trg_ppe_append_only`) e unica per versione (`uq_ppe_partner_version`): riaccettare la stessa versione è idempotente e restituisce `enrolled: false`. Una versione di documento diversa da quella corrente è `409`: un client fermo su un testo vecchio si dichiarerebbe in pari senza aver mai visto quello nuovo.",
|
|
160388
161631
|
"requestBody": {
|
|
160389
161632
|
"required": true,
|
|
160390
161633
|
"content": {
|
|
160391
161634
|
"application/json": {
|
|
160392
161635
|
"schema": {
|
|
160393
161636
|
"additionalProperties": false,
|
|
160394
|
-
"description": "Profilo PUBBLICO. Non è `partner_profile`, che è la configurazione a 4 valori della dashboard ed è in sola lettura per il partner (§12.5).",
|
|
160395
161637
|
"type": "object",
|
|
161638
|
+
"required": [
|
|
161639
|
+
"documents"
|
|
161640
|
+
],
|
|
160396
161641
|
"properties": {
|
|
160397
|
-
"
|
|
160398
|
-
"description": "
|
|
160399
|
-
"
|
|
160400
|
-
|
|
160401
|
-
|
|
160402
|
-
|
|
160403
|
-
|
|
160404
|
-
|
|
160405
|
-
|
|
160406
|
-
|
|
160407
|
-
|
|
160408
|
-
|
|
160409
|
-
|
|
160410
|
-
|
|
160411
|
-
|
|
160412
|
-
|
|
160413
|
-
|
|
160414
|
-
|
|
160415
|
-
|
|
160416
|
-
|
|
160417
|
-
|
|
160418
|
-
|
|
160419
|
-
|
|
160420
|
-
|
|
160421
|
-
},
|
|
160422
|
-
{
|
|
160423
|
-
"type": "null"
|
|
160424
|
-
}
|
|
160425
|
-
]
|
|
160426
|
-
},
|
|
160427
|
-
"tagline": {
|
|
160428
|
-
"description": "Una riga di presentazione.",
|
|
160429
|
-
"anyOf": [
|
|
160430
|
-
{
|
|
160431
|
-
"maxLength": 160,
|
|
160432
|
-
"type": "string"
|
|
160433
|
-
},
|
|
160434
|
-
{
|
|
160435
|
-
"type": "null"
|
|
161642
|
+
"documents": {
|
|
161643
|
+
"description": "I documenti che il partner dichiara di accettare, ciascuno con la versione che ha letto.",
|
|
161644
|
+
"maxItems": 16,
|
|
161645
|
+
"minItems": 1,
|
|
161646
|
+
"type": "array",
|
|
161647
|
+
"items": {
|
|
161648
|
+
"additionalProperties": false,
|
|
161649
|
+
"type": "object",
|
|
161650
|
+
"required": [
|
|
161651
|
+
"document",
|
|
161652
|
+
"version"
|
|
161653
|
+
],
|
|
161654
|
+
"properties": {
|
|
161655
|
+
"document": {
|
|
161656
|
+
"description": "Id del documento di programma.",
|
|
161657
|
+
"maxLength": 40,
|
|
161658
|
+
"minLength": 1,
|
|
161659
|
+
"type": "string"
|
|
161660
|
+
},
|
|
161661
|
+
"version": {
|
|
161662
|
+
"description": "Versione accettata. Deve essere quella corrente.",
|
|
161663
|
+
"maxLength": 20,
|
|
161664
|
+
"type": "string"
|
|
161665
|
+
}
|
|
160436
161666
|
}
|
|
160437
|
-
|
|
161667
|
+
}
|
|
160438
161668
|
}
|
|
160439
161669
|
}
|
|
160440
161670
|
}
|
|
160441
161671
|
}
|
|
160442
|
-
}
|
|
160443
|
-
"description": "Profilo PUBBLICO. Non è `partner_profile`, che è la configurazione a 4 valori della dashboard ed è in sola lettura per il partner (§12.5)."
|
|
161672
|
+
}
|
|
160444
161673
|
},
|
|
160445
161674
|
"security": [
|
|
160446
161675
|
{
|
|
@@ -160449,68 +161678,425 @@
|
|
|
160449
161678
|
],
|
|
160450
161679
|
"responses": {
|
|
160451
161680
|
"200": {
|
|
160452
|
-
"description": "
|
|
161681
|
+
"description": "Esito dell’accettazione, con lo stato di ri-consenso aggiornato.",
|
|
160453
161682
|
"content": {
|
|
160454
161683
|
"application/json": {
|
|
160455
161684
|
"schema": {
|
|
160456
161685
|
"additionalProperties": false,
|
|
160457
|
-
"description": "
|
|
161686
|
+
"description": "Esito dell’accettazione, con lo stato di ri-consenso aggiornato.",
|
|
160458
161687
|
"type": "object",
|
|
160459
161688
|
"required": [
|
|
160460
|
-
"
|
|
160461
|
-
"
|
|
160462
|
-
"
|
|
160463
|
-
"handle",
|
|
160464
|
-
"tagline"
|
|
161689
|
+
"enrolled",
|
|
161690
|
+
"recorded",
|
|
161691
|
+
"reconsent"
|
|
160465
161692
|
],
|
|
160466
161693
|
"properties": {
|
|
160467
|
-
"
|
|
160468
|
-
"description": "true
|
|
161694
|
+
"enrolled": {
|
|
161695
|
+
"description": "true se è nata una riga `partner_program_enrollment`. false quando il partner aveva già aderito a quella versione (idempotenza) o quando nessuna versione di programma è pubblicata.",
|
|
160469
161696
|
"type": "boolean"
|
|
160470
161697
|
},
|
|
160471
|
-
"
|
|
160472
|
-
"description": "
|
|
160473
|
-
"
|
|
160474
|
-
|
|
160475
|
-
|
|
160476
|
-
|
|
160477
|
-
|
|
160478
|
-
"type": "null"
|
|
160479
|
-
}
|
|
160480
|
-
]
|
|
161698
|
+
"recorded": {
|
|
161699
|
+
"description": "I documenti per cui è nata una riga `legal_consent`.",
|
|
161700
|
+
"type": "array",
|
|
161701
|
+
"items": {
|
|
161702
|
+
"description": "Id del documento registrato.",
|
|
161703
|
+
"type": "string"
|
|
161704
|
+
}
|
|
160481
161705
|
},
|
|
160482
|
-
"
|
|
160483
|
-
"
|
|
160484
|
-
"
|
|
160485
|
-
|
|
160486
|
-
|
|
161706
|
+
"reconsent": {
|
|
161707
|
+
"additionalProperties": false,
|
|
161708
|
+
"description": "Stato del ri-consenso ai termini di programma: cosa manca e se è esigibile.",
|
|
161709
|
+
"type": "object",
|
|
161710
|
+
"required": [
|
|
161711
|
+
"accepted_documents",
|
|
161712
|
+
"accepted_program_version",
|
|
161713
|
+
"current_program_version",
|
|
161714
|
+
"outstanding_documents",
|
|
161715
|
+
"reasons",
|
|
161716
|
+
"required"
|
|
161717
|
+
],
|
|
161718
|
+
"properties": {
|
|
161719
|
+
"accepted_documents": {
|
|
161720
|
+
"additionalProperties": false,
|
|
161721
|
+
"description": "Versione accettata per ciascun documento di programma. Input di `outstandingPartnerDocuments()`.",
|
|
161722
|
+
"type": "object",
|
|
161723
|
+
"properties": {
|
|
161724
|
+
"partnerContentAddendum": {
|
|
161725
|
+
"description": "Versione accettata di partnerContentAddendum. Assente = mai accettato.",
|
|
161726
|
+
"type": "string"
|
|
161727
|
+
},
|
|
161728
|
+
"partnerSelfBilling": {
|
|
161729
|
+
"description": "Versione accettata di partnerSelfBilling. Assente = mai accettato.",
|
|
161730
|
+
"type": "string"
|
|
161731
|
+
},
|
|
161732
|
+
"partnerTerms": {
|
|
161733
|
+
"description": "Versione accettata di partnerTerms. Assente = mai accettato.",
|
|
161734
|
+
"type": "string"
|
|
161735
|
+
},
|
|
161736
|
+
"referralTerms": {
|
|
161737
|
+
"description": "Versione accettata di referralTerms. Assente = mai accettato.",
|
|
161738
|
+
"type": "string"
|
|
161739
|
+
}
|
|
161740
|
+
}
|
|
160487
161741
|
},
|
|
160488
|
-
{
|
|
160489
|
-
"
|
|
160490
|
-
|
|
160491
|
-
|
|
160492
|
-
|
|
160493
|
-
|
|
160494
|
-
|
|
160495
|
-
|
|
160496
|
-
|
|
160497
|
-
|
|
161742
|
+
"accepted_program_version": {
|
|
161743
|
+
"description": "Riferimento a una `partner_program_version`, `null` quando non ne esiste una.",
|
|
161744
|
+
"anyOf": [
|
|
161745
|
+
{
|
|
161746
|
+
"additionalProperties": false,
|
|
161747
|
+
"type": "object",
|
|
161748
|
+
"required": [
|
|
161749
|
+
"id",
|
|
161750
|
+
"version"
|
|
161751
|
+
],
|
|
161752
|
+
"properties": {
|
|
161753
|
+
"id": {
|
|
161754
|
+
"description": "Id della versione di programma.",
|
|
161755
|
+
"format": "uuid",
|
|
161756
|
+
"type": "string"
|
|
161757
|
+
},
|
|
161758
|
+
"version": {
|
|
161759
|
+
"description": "Etichetta di versione, es. `1.0`.",
|
|
161760
|
+
"type": "string"
|
|
161761
|
+
}
|
|
161762
|
+
}
|
|
161763
|
+
},
|
|
161764
|
+
{
|
|
161765
|
+
"type": "null"
|
|
161766
|
+
}
|
|
161767
|
+
]
|
|
160498
161768
|
},
|
|
160499
|
-
{
|
|
160500
|
-
"
|
|
160501
|
-
|
|
160502
|
-
|
|
160503
|
-
|
|
160504
|
-
|
|
160505
|
-
|
|
160506
|
-
|
|
160507
|
-
|
|
160508
|
-
|
|
161769
|
+
"current_program_version": {
|
|
161770
|
+
"description": "Riferimento a una `partner_program_version`, `null` quando non ne esiste una.",
|
|
161771
|
+
"anyOf": [
|
|
161772
|
+
{
|
|
161773
|
+
"additionalProperties": false,
|
|
161774
|
+
"type": "object",
|
|
161775
|
+
"required": [
|
|
161776
|
+
"id",
|
|
161777
|
+
"version"
|
|
161778
|
+
],
|
|
161779
|
+
"properties": {
|
|
161780
|
+
"id": {
|
|
161781
|
+
"description": "Id della versione di programma.",
|
|
161782
|
+
"format": "uuid",
|
|
161783
|
+
"type": "string"
|
|
161784
|
+
},
|
|
161785
|
+
"version": {
|
|
161786
|
+
"description": "Etichetta di versione, es. `1.0`.",
|
|
161787
|
+
"type": "string"
|
|
161788
|
+
}
|
|
161789
|
+
}
|
|
161790
|
+
},
|
|
161791
|
+
{
|
|
161792
|
+
"type": "null"
|
|
161793
|
+
}
|
|
161794
|
+
]
|
|
160509
161795
|
},
|
|
160510
|
-
{
|
|
160511
|
-
"
|
|
161796
|
+
"outstanding_documents": {
|
|
161797
|
+
"description": "Documenti la cui versione accettata differisce dalla corrente. Rilevamento puro: comprende anche i documenti il cui testo non esiste ancora, perché non accettati lo sono comunque.",
|
|
161798
|
+
"type": "array",
|
|
161799
|
+
"items": {
|
|
161800
|
+
"description": "Id del documento di programma.",
|
|
161801
|
+
"type": "string"
|
|
161802
|
+
}
|
|
161803
|
+
},
|
|
161804
|
+
"reasons": {
|
|
161805
|
+
"description": "Perché il ri-consenso è dovuto. Vuoto quando `required` è false.",
|
|
161806
|
+
"type": "array",
|
|
161807
|
+
"items": {
|
|
161808
|
+
"description": "never_enrolled | program_version_superseded | documents_outdated.",
|
|
161809
|
+
"type": "string"
|
|
161810
|
+
}
|
|
161811
|
+
},
|
|
161812
|
+
"required": {
|
|
161813
|
+
"description": "true solo quando esiste qualcosa che il partner può DAVVERO riaccettare (vedi `reasons`).",
|
|
161814
|
+
"type": "boolean"
|
|
160512
161815
|
}
|
|
160513
|
-
|
|
161816
|
+
}
|
|
161817
|
+
}
|
|
161818
|
+
}
|
|
161819
|
+
}
|
|
161820
|
+
}
|
|
161821
|
+
}
|
|
161822
|
+
},
|
|
161823
|
+
"400": {
|
|
161824
|
+
"description": "Errore standard del backend.",
|
|
161825
|
+
"content": {
|
|
161826
|
+
"application/json": {
|
|
161827
|
+
"schema": {
|
|
161828
|
+
"additionalProperties": false,
|
|
161829
|
+
"description": "Errore standard del backend.",
|
|
161830
|
+
"type": "object",
|
|
161831
|
+
"required": [
|
|
161832
|
+
"error",
|
|
161833
|
+
"message",
|
|
161834
|
+
"statusCode"
|
|
161835
|
+
],
|
|
161836
|
+
"properties": {
|
|
161837
|
+
"code": {
|
|
161838
|
+
"description": "Codice macchina dell’errore, quando disponibile.",
|
|
161839
|
+
"type": "string"
|
|
161840
|
+
},
|
|
161841
|
+
"error": {
|
|
161842
|
+
"description": "Etichetta breve dell’errore.",
|
|
161843
|
+
"type": "string"
|
|
161844
|
+
},
|
|
161845
|
+
"message": {
|
|
161846
|
+
"description": "Messaggio leggibile.",
|
|
161847
|
+
"type": "string"
|
|
161848
|
+
},
|
|
161849
|
+
"statusCode": {
|
|
161850
|
+
"description": "Codice di stato HTTP ripetuto nel corpo.",
|
|
161851
|
+
"type": "integer"
|
|
161852
|
+
}
|
|
161853
|
+
}
|
|
161854
|
+
}
|
|
161855
|
+
}
|
|
161856
|
+
}
|
|
161857
|
+
},
|
|
161858
|
+
"401": {
|
|
161859
|
+
"description": "Errore standard del backend.",
|
|
161860
|
+
"content": {
|
|
161861
|
+
"application/json": {
|
|
161862
|
+
"schema": {
|
|
161863
|
+
"additionalProperties": false,
|
|
161864
|
+
"description": "Errore standard del backend.",
|
|
161865
|
+
"type": "object",
|
|
161866
|
+
"required": [
|
|
161867
|
+
"error",
|
|
161868
|
+
"message",
|
|
161869
|
+
"statusCode"
|
|
161870
|
+
],
|
|
161871
|
+
"properties": {
|
|
161872
|
+
"code": {
|
|
161873
|
+
"description": "Codice macchina dell’errore, quando disponibile.",
|
|
161874
|
+
"type": "string"
|
|
161875
|
+
},
|
|
161876
|
+
"error": {
|
|
161877
|
+
"description": "Etichetta breve dell’errore.",
|
|
161878
|
+
"type": "string"
|
|
161879
|
+
},
|
|
161880
|
+
"message": {
|
|
161881
|
+
"description": "Messaggio leggibile.",
|
|
161882
|
+
"type": "string"
|
|
161883
|
+
},
|
|
161884
|
+
"statusCode": {
|
|
161885
|
+
"description": "Codice di stato HTTP ripetuto nel corpo.",
|
|
161886
|
+
"type": "integer"
|
|
161887
|
+
}
|
|
161888
|
+
}
|
|
161889
|
+
}
|
|
161890
|
+
}
|
|
161891
|
+
}
|
|
161892
|
+
},
|
|
161893
|
+
"403": {
|
|
161894
|
+
"description": "Errore standard del backend.",
|
|
161895
|
+
"content": {
|
|
161896
|
+
"application/json": {
|
|
161897
|
+
"schema": {
|
|
161898
|
+
"additionalProperties": false,
|
|
161899
|
+
"description": "Errore standard del backend.",
|
|
161900
|
+
"type": "object",
|
|
161901
|
+
"required": [
|
|
161902
|
+
"error",
|
|
161903
|
+
"message",
|
|
161904
|
+
"statusCode"
|
|
161905
|
+
],
|
|
161906
|
+
"properties": {
|
|
161907
|
+
"code": {
|
|
161908
|
+
"description": "Codice macchina dell’errore, quando disponibile.",
|
|
161909
|
+
"type": "string"
|
|
161910
|
+
},
|
|
161911
|
+
"error": {
|
|
161912
|
+
"description": "Etichetta breve dell’errore.",
|
|
161913
|
+
"type": "string"
|
|
161914
|
+
},
|
|
161915
|
+
"message": {
|
|
161916
|
+
"description": "Messaggio leggibile.",
|
|
161917
|
+
"type": "string"
|
|
161918
|
+
},
|
|
161919
|
+
"statusCode": {
|
|
161920
|
+
"description": "Codice di stato HTTP ripetuto nel corpo.",
|
|
161921
|
+
"type": "integer"
|
|
161922
|
+
}
|
|
161923
|
+
}
|
|
161924
|
+
}
|
|
161925
|
+
}
|
|
161926
|
+
}
|
|
161927
|
+
},
|
|
161928
|
+
"409": {
|
|
161929
|
+
"description": "Errore standard del backend.",
|
|
161930
|
+
"content": {
|
|
161931
|
+
"application/json": {
|
|
161932
|
+
"schema": {
|
|
161933
|
+
"additionalProperties": false,
|
|
161934
|
+
"description": "Errore standard del backend.",
|
|
161935
|
+
"type": "object",
|
|
161936
|
+
"required": [
|
|
161937
|
+
"error",
|
|
161938
|
+
"message",
|
|
161939
|
+
"statusCode"
|
|
161940
|
+
],
|
|
161941
|
+
"properties": {
|
|
161942
|
+
"code": {
|
|
161943
|
+
"description": "Codice macchina dell’errore, quando disponibile.",
|
|
161944
|
+
"type": "string"
|
|
161945
|
+
},
|
|
161946
|
+
"error": {
|
|
161947
|
+
"description": "Etichetta breve dell’errore.",
|
|
161948
|
+
"type": "string"
|
|
161949
|
+
},
|
|
161950
|
+
"message": {
|
|
161951
|
+
"description": "Messaggio leggibile.",
|
|
161952
|
+
"type": "string"
|
|
161953
|
+
},
|
|
161954
|
+
"statusCode": {
|
|
161955
|
+
"description": "Codice di stato HTTP ripetuto nel corpo.",
|
|
161956
|
+
"type": "integer"
|
|
161957
|
+
}
|
|
161958
|
+
}
|
|
161959
|
+
}
|
|
161960
|
+
}
|
|
161961
|
+
}
|
|
161962
|
+
}
|
|
161963
|
+
}
|
|
161964
|
+
}
|
|
161965
|
+
},
|
|
161966
|
+
"/api/v1/partner/profile": {
|
|
161967
|
+
"patch": {
|
|
161968
|
+
"operationId": "updatePartnerPublicProfile",
|
|
161969
|
+
"summary": "Aggiorna il profilo pubblico del partner",
|
|
161970
|
+
"tags": [
|
|
161971
|
+
"partner"
|
|
161972
|
+
],
|
|
161973
|
+
"description": "Aggiorna il profilo PUBBLICO del partner. Ogni modifica riporta il profilo in `pending`: senza ri-approvazione un profilo già approvato potrebbe cambiare nome e aggirare il gate umano dell’identità reciproca (§4.5). Finché è `pending` le celle identità restano coperte.",
|
|
161974
|
+
"requestBody": {
|
|
161975
|
+
"required": true,
|
|
161976
|
+
"content": {
|
|
161977
|
+
"application/json": {
|
|
161978
|
+
"schema": {
|
|
161979
|
+
"additionalProperties": false,
|
|
161980
|
+
"description": "Profilo PUBBLICO. Non è `partner_profile`, che è la configurazione a 4 valori della dashboard ed è in sola lettura per il partner (§12.5).",
|
|
161981
|
+
"type": "object",
|
|
161982
|
+
"properties": {
|
|
161983
|
+
"avatar_url": {
|
|
161984
|
+
"description": "URL dell’avatar pubblico.",
|
|
161985
|
+
"anyOf": [
|
|
161986
|
+
{
|
|
161987
|
+
"maxLength": 500,
|
|
161988
|
+
"type": "string"
|
|
161989
|
+
},
|
|
161990
|
+
{
|
|
161991
|
+
"type": "null"
|
|
161992
|
+
}
|
|
161993
|
+
]
|
|
161994
|
+
},
|
|
161995
|
+
"display_name": {
|
|
161996
|
+
"description": "Nome mostrato al referito.",
|
|
161997
|
+
"maxLength": 120,
|
|
161998
|
+
"minLength": 2,
|
|
161999
|
+
"type": "string"
|
|
162000
|
+
},
|
|
162001
|
+
"handle": {
|
|
162002
|
+
"description": "Handle social pubblico.",
|
|
162003
|
+
"anyOf": [
|
|
162004
|
+
{
|
|
162005
|
+
"maxLength": 80,
|
|
162006
|
+
"type": "string"
|
|
162007
|
+
},
|
|
162008
|
+
{
|
|
162009
|
+
"type": "null"
|
|
162010
|
+
}
|
|
162011
|
+
]
|
|
162012
|
+
},
|
|
162013
|
+
"tagline": {
|
|
162014
|
+
"description": "Una riga di presentazione.",
|
|
162015
|
+
"anyOf": [
|
|
162016
|
+
{
|
|
162017
|
+
"maxLength": 160,
|
|
162018
|
+
"type": "string"
|
|
162019
|
+
},
|
|
162020
|
+
{
|
|
162021
|
+
"type": "null"
|
|
162022
|
+
}
|
|
162023
|
+
]
|
|
162024
|
+
}
|
|
162025
|
+
}
|
|
162026
|
+
}
|
|
162027
|
+
}
|
|
162028
|
+
},
|
|
162029
|
+
"description": "Profilo PUBBLICO. Non è `partner_profile`, che è la configurazione a 4 valori della dashboard ed è in sola lettura per il partner (§12.5)."
|
|
162030
|
+
},
|
|
162031
|
+
"security": [
|
|
162032
|
+
{
|
|
162033
|
+
"bearerAuth": []
|
|
162034
|
+
}
|
|
162035
|
+
],
|
|
162036
|
+
"responses": {
|
|
162037
|
+
"200": {
|
|
162038
|
+
"description": "Profilo pubblico del partner: è il gate dell’identità reciproca.",
|
|
162039
|
+
"content": {
|
|
162040
|
+
"application/json": {
|
|
162041
|
+
"schema": {
|
|
162042
|
+
"additionalProperties": false,
|
|
162043
|
+
"description": "Profilo pubblico del partner: è il gate dell’identità reciproca.",
|
|
162044
|
+
"type": "object",
|
|
162045
|
+
"required": [
|
|
162046
|
+
"approved",
|
|
162047
|
+
"avatar_url",
|
|
162048
|
+
"display_name",
|
|
162049
|
+
"handle",
|
|
162050
|
+
"tagline"
|
|
162051
|
+
],
|
|
162052
|
+
"properties": {
|
|
162053
|
+
"approved": {
|
|
162054
|
+
"description": "true solo dopo l’approvazione del backoffice (§4.5).",
|
|
162055
|
+
"type": "boolean"
|
|
162056
|
+
},
|
|
162057
|
+
"avatar_url": {
|
|
162058
|
+
"description": "Avatar pubblico.",
|
|
162059
|
+
"anyOf": [
|
|
162060
|
+
{
|
|
162061
|
+
"type": "string"
|
|
162062
|
+
},
|
|
162063
|
+
{
|
|
162064
|
+
"type": "null"
|
|
162065
|
+
}
|
|
162066
|
+
]
|
|
162067
|
+
},
|
|
162068
|
+
"display_name": {
|
|
162069
|
+
"description": "Nome mostrato al referito.",
|
|
162070
|
+
"anyOf": [
|
|
162071
|
+
{
|
|
162072
|
+
"type": "string"
|
|
162073
|
+
},
|
|
162074
|
+
{
|
|
162075
|
+
"type": "null"
|
|
162076
|
+
}
|
|
162077
|
+
]
|
|
162078
|
+
},
|
|
162079
|
+
"handle": {
|
|
162080
|
+
"description": "Handle social pubblico.",
|
|
162081
|
+
"anyOf": [
|
|
162082
|
+
{
|
|
162083
|
+
"type": "string"
|
|
162084
|
+
},
|
|
162085
|
+
{
|
|
162086
|
+
"type": "null"
|
|
162087
|
+
}
|
|
162088
|
+
]
|
|
162089
|
+
},
|
|
162090
|
+
"tagline": {
|
|
162091
|
+
"description": "Una riga di presentazione.",
|
|
162092
|
+
"anyOf": [
|
|
162093
|
+
{
|
|
162094
|
+
"type": "string"
|
|
162095
|
+
},
|
|
162096
|
+
{
|
|
162097
|
+
"type": "null"
|
|
162098
|
+
}
|
|
162099
|
+
]
|
|
160514
162100
|
}
|
|
160515
162101
|
}
|
|
160516
162102
|
}
|
|
@@ -176863,7 +178449,7 @@
|
|
|
176863
178449
|
"tags": [
|
|
176864
178450
|
"reports"
|
|
176865
178451
|
],
|
|
176866
|
-
"description": "Returns the current job status and, when COMPLETED, a freshly signed S3 download URL with its `expires_at` timestamp (~7 days). Access follows the current workspace for team-stamped runs; legacy runs without a team stamp remain original-owner only. The URL is regenerated on demand from the stored S3 key, so completed runs remain re-downloadable for the lifetime of the underlying object.",
|
|
178452
|
+
"description": "Returns the current job status and, when COMPLETED, a freshly signed S3 download URL with its `expires_at` timestamp (~7 days). Accepts both on-demand exports and scheduled sends. Access follows the current workspace for team-stamped runs; legacy runs without a team stamp remain original-owner only. The URL is regenerated on demand from the stored S3 key, so completed runs remain re-downloadable for the lifetime of the underlying object.",
|
|
176867
178453
|
"parameters": [
|
|
176868
178454
|
{
|
|
176869
178455
|
"schema": {
|
|
@@ -177000,7 +178586,7 @@
|
|
|
177000
178586
|
"tags": [
|
|
177001
178587
|
"reports"
|
|
177002
178588
|
],
|
|
177003
|
-
"description": "Persistent history of recent PDF/CSV report exports visible to the authenticated caller, ordered newest first. Team-stamped runs follow current workspace access; legacy runs without a team stamp remain original-owner only. Reads worker_run rows joined on the enqueued worker_run_event metadata so the Download Center UI can re-hydrate after a page refresh without losing track of completed exports whose presigned URLs have already expired.",
|
|
178589
|
+
"description": "Persistent history of recent PDF/CSV report exports visible to the authenticated caller, ordered newest first, covering both on-demand exports and scheduled sends. Team-stamped runs follow current workspace access; legacy runs without a team stamp remain original-owner only. Reads worker_run rows joined on the enqueued worker_run_event metadata so the Download Center UI can re-hydrate after a page refresh without losing track of completed exports whose presigned URLs have already expired.",
|
|
177004
178590
|
"parameters": [
|
|
177005
178591
|
{
|
|
177006
178592
|
"schema": {
|
|
@@ -177046,7 +178632,9 @@
|
|
|
177046
178632
|
"to_date",
|
|
177047
178633
|
"created_at",
|
|
177048
178634
|
"completed_at",
|
|
177049
|
-
"error_message"
|
|
178635
|
+
"error_message",
|
|
178636
|
+
"origin",
|
|
178637
|
+
"retryable"
|
|
177050
178638
|
],
|
|
177051
178639
|
"properties": {
|
|
177052
178640
|
"id": {
|
|
@@ -177153,6 +178741,27 @@
|
|
|
177153
178741
|
"type": "null"
|
|
177154
178742
|
}
|
|
177155
178743
|
]
|
|
178744
|
+
},
|
|
178745
|
+
"origin": {
|
|
178746
|
+
"description": "Who asked for this artifact: `on_demand` = the caller pressed Export; `scheduled` = a recurring send produced it. The UI must not treat a scheduled artifact as a download the user is waiting on.",
|
|
178747
|
+
"anyOf": [
|
|
178748
|
+
{
|
|
178749
|
+
"type": "string",
|
|
178750
|
+
"enum": [
|
|
178751
|
+
"on_demand"
|
|
178752
|
+
]
|
|
178753
|
+
},
|
|
178754
|
+
{
|
|
178755
|
+
"type": "string",
|
|
178756
|
+
"enum": [
|
|
178757
|
+
"scheduled"
|
|
178758
|
+
]
|
|
178759
|
+
}
|
|
178760
|
+
]
|
|
178761
|
+
},
|
|
178762
|
+
"retryable": {
|
|
178763
|
+
"description": "Whether POST /api/v1/reports/{id}/retry accepts this run. Only on-demand exports carry the stored request payload a retry replays; a scheduled send is re-run from its schedule instead.",
|
|
178764
|
+
"type": "boolean"
|
|
177156
178765
|
}
|
|
177157
178766
|
}
|
|
177158
178767
|
}
|
|
@@ -177247,6 +178856,8 @@
|
|
|
177247
178856
|
"recipients",
|
|
177248
178857
|
"format",
|
|
177249
178858
|
"ad_account_ids",
|
|
178859
|
+
"platforms",
|
|
178860
|
+
"period",
|
|
177250
178861
|
"is_active",
|
|
177251
178862
|
"last_run_at",
|
|
177252
178863
|
"next_run_at",
|
|
@@ -177364,6 +178975,54 @@
|
|
|
177364
178975
|
"type": "string"
|
|
177365
178976
|
}
|
|
177366
178977
|
},
|
|
178978
|
+
"platforms": {
|
|
178979
|
+
"type": "array",
|
|
178980
|
+
"items": {
|
|
178981
|
+
"type": "string"
|
|
178982
|
+
}
|
|
178983
|
+
},
|
|
178984
|
+
"period": {
|
|
178985
|
+
"anyOf": [
|
|
178986
|
+
{
|
|
178987
|
+
"description": "Rolling window recomputed at every run. Omitted/null falls back to the template period, else last 7 days.",
|
|
178988
|
+
"anyOf": [
|
|
178989
|
+
{
|
|
178990
|
+
"type": "string",
|
|
178991
|
+
"enum": [
|
|
178992
|
+
"last7d"
|
|
178993
|
+
]
|
|
178994
|
+
},
|
|
178995
|
+
{
|
|
178996
|
+
"type": "string",
|
|
178997
|
+
"enum": [
|
|
178998
|
+
"last14d"
|
|
178999
|
+
]
|
|
179000
|
+
},
|
|
179001
|
+
{
|
|
179002
|
+
"type": "string",
|
|
179003
|
+
"enum": [
|
|
179004
|
+
"last30d"
|
|
179005
|
+
]
|
|
179006
|
+
},
|
|
179007
|
+
{
|
|
179008
|
+
"type": "string",
|
|
179009
|
+
"enum": [
|
|
179010
|
+
"last90d"
|
|
179011
|
+
]
|
|
179012
|
+
},
|
|
179013
|
+
{
|
|
179014
|
+
"type": "string",
|
|
179015
|
+
"enum": [
|
|
179016
|
+
"mtd"
|
|
179017
|
+
]
|
|
179018
|
+
}
|
|
179019
|
+
]
|
|
179020
|
+
},
|
|
179021
|
+
{
|
|
179022
|
+
"type": "null"
|
|
179023
|
+
}
|
|
179024
|
+
]
|
|
179025
|
+
},
|
|
177367
179026
|
"is_active": {
|
|
177368
179027
|
"type": "boolean"
|
|
177369
179028
|
},
|
|
@@ -177428,6 +179087,33 @@
|
|
|
177428
179087
|
}
|
|
177429
179088
|
}
|
|
177430
179089
|
}
|
|
179090
|
+
},
|
|
179091
|
+
"503": {
|
|
179092
|
+
"description": "Scheduled reports are not enabled for this account.",
|
|
179093
|
+
"content": {
|
|
179094
|
+
"application/json": {
|
|
179095
|
+
"schema": {
|
|
179096
|
+
"additionalProperties": false,
|
|
179097
|
+
"description": "Scheduled reports are not enabled for this account.",
|
|
179098
|
+
"type": "object",
|
|
179099
|
+
"required": [
|
|
179100
|
+
"error",
|
|
179101
|
+
"code"
|
|
179102
|
+
],
|
|
179103
|
+
"properties": {
|
|
179104
|
+
"error": {
|
|
179105
|
+
"type": "string"
|
|
179106
|
+
},
|
|
179107
|
+
"code": {
|
|
179108
|
+
"type": "string",
|
|
179109
|
+
"enum": [
|
|
179110
|
+
"FEATURE_DISABLED"
|
|
179111
|
+
]
|
|
179112
|
+
}
|
|
179113
|
+
}
|
|
179114
|
+
}
|
|
179115
|
+
}
|
|
179116
|
+
}
|
|
177431
179117
|
}
|
|
177432
179118
|
}
|
|
177433
179119
|
},
|
|
@@ -177447,7 +179133,8 @@
|
|
|
177447
179133
|
"type": "object",
|
|
177448
179134
|
"required": [
|
|
177449
179135
|
"name",
|
|
177450
|
-
"frequency"
|
|
179136
|
+
"frequency",
|
|
179137
|
+
"recipients"
|
|
177451
179138
|
],
|
|
177452
179139
|
"properties": {
|
|
177453
179140
|
"name": {
|
|
@@ -177518,6 +179205,9 @@
|
|
|
177518
179205
|
"type": "integer"
|
|
177519
179206
|
},
|
|
177520
179207
|
"recipients": {
|
|
179208
|
+
"minItems": 1,
|
|
179209
|
+
"maxItems": 10,
|
|
179210
|
+
"description": "Destination inboxes. Up to 10 on paid plans; lower plans are capped further and may be restricted to the owner's own address.",
|
|
177521
179211
|
"type": "array",
|
|
177522
179212
|
"items": {
|
|
177523
179213
|
"additionalProperties": false,
|
|
@@ -177554,12 +179244,66 @@
|
|
|
177554
179244
|
]
|
|
177555
179245
|
},
|
|
177556
179246
|
"ad_account_ids": {
|
|
179247
|
+
"maxItems": 50,
|
|
179248
|
+
"description": "Ad accounts included in the export. Empty/omitted = every account in scope.",
|
|
179249
|
+
"type": "array",
|
|
179250
|
+
"items": {
|
|
179251
|
+
"minLength": 1,
|
|
179252
|
+
"type": "string"
|
|
179253
|
+
}
|
|
179254
|
+
},
|
|
179255
|
+
"platforms": {
|
|
179256
|
+
"maxItems": 10,
|
|
179257
|
+
"description": "Restricts the export to these ad platforms (meta, google, tiktok, taboola, snapchat, outbrain). Empty = every platform, and the export gains a Platform column.",
|
|
177557
179258
|
"type": "array",
|
|
177558
179259
|
"items": {
|
|
177559
179260
|
"minLength": 1,
|
|
179261
|
+
"maxLength": 20,
|
|
177560
179262
|
"type": "string"
|
|
177561
179263
|
}
|
|
177562
179264
|
},
|
|
179265
|
+
"period": {
|
|
179266
|
+
"anyOf": [
|
|
179267
|
+
{
|
|
179268
|
+
"description": "Rolling window recomputed at every run. Omitted/null falls back to the template period, else last 7 days.",
|
|
179269
|
+
"anyOf": [
|
|
179270
|
+
{
|
|
179271
|
+
"type": "string",
|
|
179272
|
+
"enum": [
|
|
179273
|
+
"last7d"
|
|
179274
|
+
]
|
|
179275
|
+
},
|
|
179276
|
+
{
|
|
179277
|
+
"type": "string",
|
|
179278
|
+
"enum": [
|
|
179279
|
+
"last14d"
|
|
179280
|
+
]
|
|
179281
|
+
},
|
|
179282
|
+
{
|
|
179283
|
+
"type": "string",
|
|
179284
|
+
"enum": [
|
|
179285
|
+
"last30d"
|
|
179286
|
+
]
|
|
179287
|
+
},
|
|
179288
|
+
{
|
|
179289
|
+
"type": "string",
|
|
179290
|
+
"enum": [
|
|
179291
|
+
"last90d"
|
|
179292
|
+
]
|
|
179293
|
+
},
|
|
179294
|
+
{
|
|
179295
|
+
"type": "string",
|
|
179296
|
+
"enum": [
|
|
179297
|
+
"mtd"
|
|
179298
|
+
]
|
|
179299
|
+
}
|
|
179300
|
+
]
|
|
179301
|
+
},
|
|
179302
|
+
{
|
|
179303
|
+
"type": "null"
|
|
179304
|
+
}
|
|
179305
|
+
]
|
|
179306
|
+
},
|
|
177563
179307
|
"is_active": {
|
|
177564
179308
|
"type": "boolean"
|
|
177565
179309
|
}
|
|
@@ -177606,6 +179350,8 @@
|
|
|
177606
179350
|
"recipients",
|
|
177607
179351
|
"format",
|
|
177608
179352
|
"ad_account_ids",
|
|
179353
|
+
"platforms",
|
|
179354
|
+
"period",
|
|
177609
179355
|
"is_active",
|
|
177610
179356
|
"last_run_at",
|
|
177611
179357
|
"next_run_at",
|
|
@@ -177723,6 +179469,54 @@
|
|
|
177723
179469
|
"type": "string"
|
|
177724
179470
|
}
|
|
177725
179471
|
},
|
|
179472
|
+
"platforms": {
|
|
179473
|
+
"type": "array",
|
|
179474
|
+
"items": {
|
|
179475
|
+
"type": "string"
|
|
179476
|
+
}
|
|
179477
|
+
},
|
|
179478
|
+
"period": {
|
|
179479
|
+
"anyOf": [
|
|
179480
|
+
{
|
|
179481
|
+
"description": "Rolling window recomputed at every run. Omitted/null falls back to the template period, else last 7 days.",
|
|
179482
|
+
"anyOf": [
|
|
179483
|
+
{
|
|
179484
|
+
"type": "string",
|
|
179485
|
+
"enum": [
|
|
179486
|
+
"last7d"
|
|
179487
|
+
]
|
|
179488
|
+
},
|
|
179489
|
+
{
|
|
179490
|
+
"type": "string",
|
|
179491
|
+
"enum": [
|
|
179492
|
+
"last14d"
|
|
179493
|
+
]
|
|
179494
|
+
},
|
|
179495
|
+
{
|
|
179496
|
+
"type": "string",
|
|
179497
|
+
"enum": [
|
|
179498
|
+
"last30d"
|
|
179499
|
+
]
|
|
179500
|
+
},
|
|
179501
|
+
{
|
|
179502
|
+
"type": "string",
|
|
179503
|
+
"enum": [
|
|
179504
|
+
"last90d"
|
|
179505
|
+
]
|
|
179506
|
+
},
|
|
179507
|
+
{
|
|
179508
|
+
"type": "string",
|
|
179509
|
+
"enum": [
|
|
179510
|
+
"mtd"
|
|
179511
|
+
]
|
|
179512
|
+
}
|
|
179513
|
+
]
|
|
179514
|
+
},
|
|
179515
|
+
{
|
|
179516
|
+
"type": "null"
|
|
179517
|
+
}
|
|
179518
|
+
]
|
|
179519
|
+
},
|
|
177726
179520
|
"is_active": {
|
|
177727
179521
|
"type": "boolean"
|
|
177728
179522
|
},
|
|
@@ -177801,6 +179595,29 @@
|
|
|
177801
179595
|
]
|
|
177802
179596
|
}
|
|
177803
179597
|
}
|
|
179598
|
+
},
|
|
179599
|
+
{
|
|
179600
|
+
"description": "The request failed schema validation.",
|
|
179601
|
+
"type": "object",
|
|
179602
|
+
"required": [
|
|
179603
|
+
"statusCode",
|
|
179604
|
+
"error",
|
|
179605
|
+
"message"
|
|
179606
|
+
],
|
|
179607
|
+
"properties": {
|
|
179608
|
+
"statusCode": {
|
|
179609
|
+
"type": "number"
|
|
179610
|
+
},
|
|
179611
|
+
"error": {
|
|
179612
|
+
"type": "string"
|
|
179613
|
+
},
|
|
179614
|
+
"message": {
|
|
179615
|
+
"type": "string"
|
|
179616
|
+
},
|
|
179617
|
+
"code": {
|
|
179618
|
+
"type": "string"
|
|
179619
|
+
}
|
|
179620
|
+
}
|
|
177804
179621
|
}
|
|
177805
179622
|
]
|
|
177806
179623
|
}
|
|
@@ -177916,6 +179733,33 @@
|
|
|
177916
179733
|
}
|
|
177917
179734
|
}
|
|
177918
179735
|
}
|
|
179736
|
+
},
|
|
179737
|
+
"503": {
|
|
179738
|
+
"description": "Scheduled reports are not enabled for this account.",
|
|
179739
|
+
"content": {
|
|
179740
|
+
"application/json": {
|
|
179741
|
+
"schema": {
|
|
179742
|
+
"additionalProperties": false,
|
|
179743
|
+
"description": "Scheduled reports are not enabled for this account.",
|
|
179744
|
+
"type": "object",
|
|
179745
|
+
"required": [
|
|
179746
|
+
"error",
|
|
179747
|
+
"code"
|
|
179748
|
+
],
|
|
179749
|
+
"properties": {
|
|
179750
|
+
"error": {
|
|
179751
|
+
"type": "string"
|
|
179752
|
+
},
|
|
179753
|
+
"code": {
|
|
179754
|
+
"type": "string",
|
|
179755
|
+
"enum": [
|
|
179756
|
+
"FEATURE_DISABLED"
|
|
179757
|
+
]
|
|
179758
|
+
}
|
|
179759
|
+
}
|
|
179760
|
+
}
|
|
179761
|
+
}
|
|
179762
|
+
}
|
|
177919
179763
|
}
|
|
177920
179764
|
}
|
|
177921
179765
|
}
|
|
@@ -177975,6 +179819,8 @@
|
|
|
177975
179819
|
"recipients",
|
|
177976
179820
|
"format",
|
|
177977
179821
|
"ad_account_ids",
|
|
179822
|
+
"platforms",
|
|
179823
|
+
"period",
|
|
177978
179824
|
"is_active",
|
|
177979
179825
|
"last_run_at",
|
|
177980
179826
|
"next_run_at",
|
|
@@ -178092,6 +179938,54 @@
|
|
|
178092
179938
|
"type": "string"
|
|
178093
179939
|
}
|
|
178094
179940
|
},
|
|
179941
|
+
"platforms": {
|
|
179942
|
+
"type": "array",
|
|
179943
|
+
"items": {
|
|
179944
|
+
"type": "string"
|
|
179945
|
+
}
|
|
179946
|
+
},
|
|
179947
|
+
"period": {
|
|
179948
|
+
"anyOf": [
|
|
179949
|
+
{
|
|
179950
|
+
"description": "Rolling window recomputed at every run. Omitted/null falls back to the template period, else last 7 days.",
|
|
179951
|
+
"anyOf": [
|
|
179952
|
+
{
|
|
179953
|
+
"type": "string",
|
|
179954
|
+
"enum": [
|
|
179955
|
+
"last7d"
|
|
179956
|
+
]
|
|
179957
|
+
},
|
|
179958
|
+
{
|
|
179959
|
+
"type": "string",
|
|
179960
|
+
"enum": [
|
|
179961
|
+
"last14d"
|
|
179962
|
+
]
|
|
179963
|
+
},
|
|
179964
|
+
{
|
|
179965
|
+
"type": "string",
|
|
179966
|
+
"enum": [
|
|
179967
|
+
"last30d"
|
|
179968
|
+
]
|
|
179969
|
+
},
|
|
179970
|
+
{
|
|
179971
|
+
"type": "string",
|
|
179972
|
+
"enum": [
|
|
179973
|
+
"last90d"
|
|
179974
|
+
]
|
|
179975
|
+
},
|
|
179976
|
+
{
|
|
179977
|
+
"type": "string",
|
|
179978
|
+
"enum": [
|
|
179979
|
+
"mtd"
|
|
179980
|
+
]
|
|
179981
|
+
}
|
|
179982
|
+
]
|
|
179983
|
+
},
|
|
179984
|
+
{
|
|
179985
|
+
"type": "null"
|
|
179986
|
+
}
|
|
179987
|
+
]
|
|
179988
|
+
},
|
|
178095
179989
|
"is_active": {
|
|
178096
179990
|
"type": "boolean"
|
|
178097
179991
|
},
|
|
@@ -178171,6 +180065,33 @@
|
|
|
178171
180065
|
}
|
|
178172
180066
|
}
|
|
178173
180067
|
}
|
|
180068
|
+
},
|
|
180069
|
+
"503": {
|
|
180070
|
+
"description": "Scheduled reports are not enabled for this account.",
|
|
180071
|
+
"content": {
|
|
180072
|
+
"application/json": {
|
|
180073
|
+
"schema": {
|
|
180074
|
+
"additionalProperties": false,
|
|
180075
|
+
"description": "Scheduled reports are not enabled for this account.",
|
|
180076
|
+
"type": "object",
|
|
180077
|
+
"required": [
|
|
180078
|
+
"error",
|
|
180079
|
+
"code"
|
|
180080
|
+
],
|
|
180081
|
+
"properties": {
|
|
180082
|
+
"error": {
|
|
180083
|
+
"type": "string"
|
|
180084
|
+
},
|
|
180085
|
+
"code": {
|
|
180086
|
+
"type": "string",
|
|
180087
|
+
"enum": [
|
|
180088
|
+
"FEATURE_DISABLED"
|
|
180089
|
+
]
|
|
180090
|
+
}
|
|
180091
|
+
}
|
|
180092
|
+
}
|
|
180093
|
+
}
|
|
180094
|
+
}
|
|
178174
180095
|
}
|
|
178175
180096
|
}
|
|
178176
180097
|
},
|
|
@@ -178180,7 +180101,7 @@
|
|
|
178180
180101
|
"tags": [
|
|
178181
180102
|
"reports"
|
|
178182
180103
|
],
|
|
178183
|
-
"description": "Partially updates the schedule. Any subset of mutable fields may be supplied. Recomputes `next_run_at` if cadence (frequency / day_of_week / day_of_month / hour_utc) changes. Returns 400 if `template_id` is reassigned to a template not owned by the session.",
|
|
180104
|
+
"description": "Partially updates the schedule. Any subset of mutable fields may be supplied. Recomputes `next_run_at` if cadence (frequency / day_of_week / day_of_month / hour_utc) changes. Returns 400 if `template_id` is reassigned to a template not owned by the session. Responds 503 when scheduled reports are disabled for the caller, EXCEPT for a body of exactly `{\"is_active\": false}` - pausing your own sends is always allowed.",
|
|
178184
180105
|
"requestBody": {
|
|
178185
180106
|
"required": true,
|
|
178186
180107
|
"content": {
|
|
@@ -178257,6 +180178,9 @@
|
|
|
178257
180178
|
"type": "integer"
|
|
178258
180179
|
},
|
|
178259
180180
|
"recipients": {
|
|
180181
|
+
"minItems": 1,
|
|
180182
|
+
"maxItems": 10,
|
|
180183
|
+
"description": "Destination inboxes. Up to 10 on paid plans; lower plans are capped further and may be restricted to the owner's own address.",
|
|
178260
180184
|
"type": "array",
|
|
178261
180185
|
"items": {
|
|
178262
180186
|
"additionalProperties": false,
|
|
@@ -178293,12 +180217,66 @@
|
|
|
178293
180217
|
]
|
|
178294
180218
|
},
|
|
178295
180219
|
"ad_account_ids": {
|
|
180220
|
+
"maxItems": 50,
|
|
180221
|
+
"description": "Ad accounts included in the export. Empty/omitted = every account in scope.",
|
|
180222
|
+
"type": "array",
|
|
180223
|
+
"items": {
|
|
180224
|
+
"minLength": 1,
|
|
180225
|
+
"type": "string"
|
|
180226
|
+
}
|
|
180227
|
+
},
|
|
180228
|
+
"platforms": {
|
|
180229
|
+
"maxItems": 10,
|
|
180230
|
+
"description": "Restricts the export to these ad platforms (meta, google, tiktok, taboola, snapchat, outbrain). Empty = every platform, and the export gains a Platform column.",
|
|
178296
180231
|
"type": "array",
|
|
178297
180232
|
"items": {
|
|
178298
180233
|
"minLength": 1,
|
|
180234
|
+
"maxLength": 20,
|
|
178299
180235
|
"type": "string"
|
|
178300
180236
|
}
|
|
178301
180237
|
},
|
|
180238
|
+
"period": {
|
|
180239
|
+
"anyOf": [
|
|
180240
|
+
{
|
|
180241
|
+
"description": "Rolling window recomputed at every run. Omitted/null falls back to the template period, else last 7 days.",
|
|
180242
|
+
"anyOf": [
|
|
180243
|
+
{
|
|
180244
|
+
"type": "string",
|
|
180245
|
+
"enum": [
|
|
180246
|
+
"last7d"
|
|
180247
|
+
]
|
|
180248
|
+
},
|
|
180249
|
+
{
|
|
180250
|
+
"type": "string",
|
|
180251
|
+
"enum": [
|
|
180252
|
+
"last14d"
|
|
180253
|
+
]
|
|
180254
|
+
},
|
|
180255
|
+
{
|
|
180256
|
+
"type": "string",
|
|
180257
|
+
"enum": [
|
|
180258
|
+
"last30d"
|
|
180259
|
+
]
|
|
180260
|
+
},
|
|
180261
|
+
{
|
|
180262
|
+
"type": "string",
|
|
180263
|
+
"enum": [
|
|
180264
|
+
"last90d"
|
|
180265
|
+
]
|
|
180266
|
+
},
|
|
180267
|
+
{
|
|
180268
|
+
"type": "string",
|
|
180269
|
+
"enum": [
|
|
180270
|
+
"mtd"
|
|
180271
|
+
]
|
|
180272
|
+
}
|
|
180273
|
+
]
|
|
180274
|
+
},
|
|
180275
|
+
{
|
|
180276
|
+
"type": "null"
|
|
180277
|
+
}
|
|
180278
|
+
]
|
|
180279
|
+
},
|
|
178302
180280
|
"is_active": {
|
|
178303
180281
|
"type": "boolean"
|
|
178304
180282
|
}
|
|
@@ -178354,6 +180332,8 @@
|
|
|
178354
180332
|
"recipients",
|
|
178355
180333
|
"format",
|
|
178356
180334
|
"ad_account_ids",
|
|
180335
|
+
"platforms",
|
|
180336
|
+
"period",
|
|
178357
180337
|
"is_active",
|
|
178358
180338
|
"last_run_at",
|
|
178359
180339
|
"next_run_at",
|
|
@@ -178471,6 +180451,54 @@
|
|
|
178471
180451
|
"type": "string"
|
|
178472
180452
|
}
|
|
178473
180453
|
},
|
|
180454
|
+
"platforms": {
|
|
180455
|
+
"type": "array",
|
|
180456
|
+
"items": {
|
|
180457
|
+
"type": "string"
|
|
180458
|
+
}
|
|
180459
|
+
},
|
|
180460
|
+
"period": {
|
|
180461
|
+
"anyOf": [
|
|
180462
|
+
{
|
|
180463
|
+
"description": "Rolling window recomputed at every run. Omitted/null falls back to the template period, else last 7 days.",
|
|
180464
|
+
"anyOf": [
|
|
180465
|
+
{
|
|
180466
|
+
"type": "string",
|
|
180467
|
+
"enum": [
|
|
180468
|
+
"last7d"
|
|
180469
|
+
]
|
|
180470
|
+
},
|
|
180471
|
+
{
|
|
180472
|
+
"type": "string",
|
|
180473
|
+
"enum": [
|
|
180474
|
+
"last14d"
|
|
180475
|
+
]
|
|
180476
|
+
},
|
|
180477
|
+
{
|
|
180478
|
+
"type": "string",
|
|
180479
|
+
"enum": [
|
|
180480
|
+
"last30d"
|
|
180481
|
+
]
|
|
180482
|
+
},
|
|
180483
|
+
{
|
|
180484
|
+
"type": "string",
|
|
180485
|
+
"enum": [
|
|
180486
|
+
"last90d"
|
|
180487
|
+
]
|
|
180488
|
+
},
|
|
180489
|
+
{
|
|
180490
|
+
"type": "string",
|
|
180491
|
+
"enum": [
|
|
180492
|
+
"mtd"
|
|
180493
|
+
]
|
|
180494
|
+
}
|
|
180495
|
+
]
|
|
180496
|
+
},
|
|
180497
|
+
{
|
|
180498
|
+
"type": "null"
|
|
180499
|
+
}
|
|
180500
|
+
]
|
|
180501
|
+
},
|
|
178474
180502
|
"is_active": {
|
|
178475
180503
|
"type": "boolean"
|
|
178476
180504
|
},
|
|
@@ -178512,6 +180540,7 @@
|
|
|
178512
180540
|
"schema": {
|
|
178513
180541
|
"anyOf": [
|
|
178514
180542
|
{
|
|
180543
|
+
"additionalProperties": false,
|
|
178515
180544
|
"type": "object",
|
|
178516
180545
|
"required": [
|
|
178517
180546
|
"error"
|
|
@@ -178548,6 +180577,29 @@
|
|
|
178548
180577
|
]
|
|
178549
180578
|
}
|
|
178550
180579
|
}
|
|
180580
|
+
},
|
|
180581
|
+
{
|
|
180582
|
+
"description": "The request failed schema validation.",
|
|
180583
|
+
"type": "object",
|
|
180584
|
+
"required": [
|
|
180585
|
+
"statusCode",
|
|
180586
|
+
"error",
|
|
180587
|
+
"message"
|
|
180588
|
+
],
|
|
180589
|
+
"properties": {
|
|
180590
|
+
"statusCode": {
|
|
180591
|
+
"type": "number"
|
|
180592
|
+
},
|
|
180593
|
+
"error": {
|
|
180594
|
+
"type": "string"
|
|
180595
|
+
},
|
|
180596
|
+
"message": {
|
|
180597
|
+
"type": "string"
|
|
180598
|
+
},
|
|
180599
|
+
"code": {
|
|
180600
|
+
"type": "string"
|
|
180601
|
+
}
|
|
180602
|
+
}
|
|
178551
180603
|
}
|
|
178552
180604
|
]
|
|
178553
180605
|
}
|
|
@@ -178617,6 +180669,33 @@
|
|
|
178617
180669
|
}
|
|
178618
180670
|
}
|
|
178619
180671
|
}
|
|
180672
|
+
},
|
|
180673
|
+
"503": {
|
|
180674
|
+
"description": "Scheduled reports are not enabled for this account.",
|
|
180675
|
+
"content": {
|
|
180676
|
+
"application/json": {
|
|
180677
|
+
"schema": {
|
|
180678
|
+
"additionalProperties": false,
|
|
180679
|
+
"description": "Scheduled reports are not enabled for this account.",
|
|
180680
|
+
"type": "object",
|
|
180681
|
+
"required": [
|
|
180682
|
+
"error",
|
|
180683
|
+
"code"
|
|
180684
|
+
],
|
|
180685
|
+
"properties": {
|
|
180686
|
+
"error": {
|
|
180687
|
+
"type": "string"
|
|
180688
|
+
},
|
|
180689
|
+
"code": {
|
|
180690
|
+
"type": "string",
|
|
180691
|
+
"enum": [
|
|
180692
|
+
"FEATURE_DISABLED"
|
|
180693
|
+
]
|
|
180694
|
+
}
|
|
180695
|
+
}
|
|
180696
|
+
}
|
|
180697
|
+
}
|
|
180698
|
+
}
|
|
178620
180699
|
}
|
|
178621
180700
|
}
|
|
178622
180701
|
},
|
|
@@ -178626,7 +180705,7 @@
|
|
|
178626
180705
|
"tags": [
|
|
178627
180706
|
"reports"
|
|
178628
180707
|
],
|
|
178629
|
-
"description": "Marks the schedule as deleted (sets deleted_at) so the cron loop stops picking it up. Idempotent: returns 404 if the schedule was already deleted or never existed.",
|
|
180708
|
+
"description": "Marks the schedule as deleted (sets deleted_at) so the cron loop stops picking it up. Idempotent: returns 404 if the schedule was already deleted or never existed. Not gated by the scheduled-reports feature flag: stopping your own sends must stay possible while the feature is switched off.",
|
|
178630
180709
|
"parameters": [
|
|
178631
180710
|
{
|
|
178632
180711
|
"schema": {
|
|
@@ -178661,35 +180740,74 @@
|
|
|
178661
180740
|
"description": "No content"
|
|
178662
180741
|
},
|
|
178663
180742
|
"400": {
|
|
178664
|
-
"description": "
|
|
180743
|
+
"description": "Invalid request - schema validation failed",
|
|
178665
180744
|
"content": {
|
|
178666
180745
|
"application/json": {
|
|
178667
180746
|
"schema": {
|
|
178668
|
-
"
|
|
178669
|
-
|
|
178670
|
-
|
|
178671
|
-
|
|
178672
|
-
|
|
178673
|
-
|
|
178674
|
-
|
|
178675
|
-
|
|
178676
|
-
|
|
178677
|
-
|
|
178678
|
-
|
|
178679
|
-
|
|
178680
|
-
"error": {
|
|
178681
|
-
"type": "string"
|
|
180747
|
+
"anyOf": [
|
|
180748
|
+
{
|
|
180749
|
+
"additionalProperties": false,
|
|
180750
|
+
"type": "object",
|
|
180751
|
+
"required": [
|
|
180752
|
+
"error"
|
|
180753
|
+
],
|
|
180754
|
+
"properties": {
|
|
180755
|
+
"error": {
|
|
180756
|
+
"type": "string"
|
|
180757
|
+
}
|
|
180758
|
+
}
|
|
178682
180759
|
},
|
|
178683
|
-
|
|
178684
|
-
"
|
|
180760
|
+
{
|
|
180761
|
+
"description": "Explicit destination workspace required: send the x-team-id header or activate a team scope for this operation.",
|
|
180762
|
+
"additionalProperties": false,
|
|
180763
|
+
"type": "object",
|
|
180764
|
+
"required": [
|
|
180765
|
+
"statusCode",
|
|
180766
|
+
"error",
|
|
180767
|
+
"message"
|
|
180768
|
+
],
|
|
180769
|
+
"properties": {
|
|
180770
|
+
"statusCode": {
|
|
180771
|
+
"type": "number"
|
|
180772
|
+
},
|
|
180773
|
+
"error": {
|
|
180774
|
+
"type": "string"
|
|
180775
|
+
},
|
|
180776
|
+
"message": {
|
|
180777
|
+
"type": "string"
|
|
180778
|
+
},
|
|
180779
|
+
"code": {
|
|
180780
|
+
"type": "string",
|
|
180781
|
+
"enum": [
|
|
180782
|
+
"SCOPE_TEAM_REQUIRED"
|
|
180783
|
+
]
|
|
180784
|
+
}
|
|
180785
|
+
}
|
|
178685
180786
|
},
|
|
178686
|
-
|
|
178687
|
-
"
|
|
178688
|
-
"
|
|
178689
|
-
|
|
178690
|
-
|
|
180787
|
+
{
|
|
180788
|
+
"description": "The request failed schema validation.",
|
|
180789
|
+
"type": "object",
|
|
180790
|
+
"required": [
|
|
180791
|
+
"statusCode",
|
|
180792
|
+
"error",
|
|
180793
|
+
"message"
|
|
180794
|
+
],
|
|
180795
|
+
"properties": {
|
|
180796
|
+
"statusCode": {
|
|
180797
|
+
"type": "number"
|
|
180798
|
+
},
|
|
180799
|
+
"error": {
|
|
180800
|
+
"type": "string"
|
|
180801
|
+
},
|
|
180802
|
+
"message": {
|
|
180803
|
+
"type": "string"
|
|
180804
|
+
},
|
|
180805
|
+
"code": {
|
|
180806
|
+
"type": "string"
|
|
180807
|
+
}
|
|
180808
|
+
}
|
|
178691
180809
|
}
|
|
178692
|
-
|
|
180810
|
+
]
|
|
178693
180811
|
}
|
|
178694
180812
|
}
|
|
178695
180813
|
}
|
|
@@ -178768,7 +180886,7 @@
|
|
|
178768
180886
|
"tags": [
|
|
178769
180887
|
"reports"
|
|
178770
180888
|
],
|
|
178771
|
-
"description": "Enqueues a one-off GENERATE_SCHEDULED_REPORT job for the given schedule, bypassing the cron cadence. The job emails the artifact to the schedule recipients and records a manual-trigger audit event. Returns the canonical async-job envelope (worker_run_id mirrored as job_id).",
|
|
180889
|
+
"description": "Enqueues a one-off GENERATE_SCHEDULED_REPORT job for the given schedule, bypassing the cron cadence. The job emails the artifact to the schedule recipients and records a manual-trigger audit event. Returns the canonical async-job envelope (worker_run_id mirrored as job_id). Rate limited to 5 calls per 1 hour per user: one call is a PDF render plus an email fan-out, not a download.",
|
|
178772
180890
|
"parameters": [
|
|
178773
180891
|
{
|
|
178774
180892
|
"schema": {
|
|
@@ -178846,6 +180964,79 @@
|
|
|
178846
180964
|
}
|
|
178847
180965
|
}
|
|
178848
180966
|
},
|
|
180967
|
+
"400": {
|
|
180968
|
+
"description": "Invalid request - schema validation failed",
|
|
180969
|
+
"content": {
|
|
180970
|
+
"application/json": {
|
|
180971
|
+
"schema": {
|
|
180972
|
+
"anyOf": [
|
|
180973
|
+
{
|
|
180974
|
+
"additionalProperties": false,
|
|
180975
|
+
"type": "object",
|
|
180976
|
+
"required": [
|
|
180977
|
+
"error"
|
|
180978
|
+
],
|
|
180979
|
+
"properties": {
|
|
180980
|
+
"error": {
|
|
180981
|
+
"type": "string"
|
|
180982
|
+
}
|
|
180983
|
+
}
|
|
180984
|
+
},
|
|
180985
|
+
{
|
|
180986
|
+
"description": "Explicit destination workspace required: send the x-team-id header or activate a team scope for this operation.",
|
|
180987
|
+
"additionalProperties": false,
|
|
180988
|
+
"type": "object",
|
|
180989
|
+
"required": [
|
|
180990
|
+
"statusCode",
|
|
180991
|
+
"error",
|
|
180992
|
+
"message"
|
|
180993
|
+
],
|
|
180994
|
+
"properties": {
|
|
180995
|
+
"statusCode": {
|
|
180996
|
+
"type": "number"
|
|
180997
|
+
},
|
|
180998
|
+
"error": {
|
|
180999
|
+
"type": "string"
|
|
181000
|
+
},
|
|
181001
|
+
"message": {
|
|
181002
|
+
"type": "string"
|
|
181003
|
+
},
|
|
181004
|
+
"code": {
|
|
181005
|
+
"type": "string",
|
|
181006
|
+
"enum": [
|
|
181007
|
+
"SCOPE_TEAM_REQUIRED"
|
|
181008
|
+
]
|
|
181009
|
+
}
|
|
181010
|
+
}
|
|
181011
|
+
},
|
|
181012
|
+
{
|
|
181013
|
+
"description": "The request failed schema validation.",
|
|
181014
|
+
"type": "object",
|
|
181015
|
+
"required": [
|
|
181016
|
+
"statusCode",
|
|
181017
|
+
"error",
|
|
181018
|
+
"message"
|
|
181019
|
+
],
|
|
181020
|
+
"properties": {
|
|
181021
|
+
"statusCode": {
|
|
181022
|
+
"type": "number"
|
|
181023
|
+
},
|
|
181024
|
+
"error": {
|
|
181025
|
+
"type": "string"
|
|
181026
|
+
},
|
|
181027
|
+
"message": {
|
|
181028
|
+
"type": "string"
|
|
181029
|
+
},
|
|
181030
|
+
"code": {
|
|
181031
|
+
"type": "string"
|
|
181032
|
+
}
|
|
181033
|
+
}
|
|
181034
|
+
}
|
|
181035
|
+
]
|
|
181036
|
+
}
|
|
181037
|
+
}
|
|
181038
|
+
}
|
|
181039
|
+
},
|
|
178849
181040
|
"401": {
|
|
178850
181041
|
"description": "Unauthorized - missing or invalid bearer token",
|
|
178851
181042
|
"content": {
|
|
@@ -178856,6 +181047,24 @@
|
|
|
178856
181047
|
}
|
|
178857
181048
|
}
|
|
178858
181049
|
},
|
|
181050
|
+
"403": {
|
|
181051
|
+
"description": "Forbidden - caller lacks the required role/permission",
|
|
181052
|
+
"content": {
|
|
181053
|
+
"application/json": {
|
|
181054
|
+
"schema": {
|
|
181055
|
+
"type": "object",
|
|
181056
|
+
"required": [
|
|
181057
|
+
"error"
|
|
181058
|
+
],
|
|
181059
|
+
"properties": {
|
|
181060
|
+
"error": {
|
|
181061
|
+
"type": "string"
|
|
181062
|
+
}
|
|
181063
|
+
}
|
|
181064
|
+
}
|
|
181065
|
+
}
|
|
181066
|
+
}
|
|
181067
|
+
},
|
|
178859
181068
|
"404": {
|
|
178860
181069
|
"description": "Resource not found",
|
|
178861
181070
|
"content": {
|
|
@@ -178874,6 +181083,24 @@
|
|
|
178874
181083
|
}
|
|
178875
181084
|
}
|
|
178876
181085
|
},
|
|
181086
|
+
"429": {
|
|
181087
|
+
"description": "Too many requests - rate limit exceeded",
|
|
181088
|
+
"content": {
|
|
181089
|
+
"application/json": {
|
|
181090
|
+
"schema": {
|
|
181091
|
+
"type": "object",
|
|
181092
|
+
"required": [
|
|
181093
|
+
"error"
|
|
181094
|
+
],
|
|
181095
|
+
"properties": {
|
|
181096
|
+
"error": {
|
|
181097
|
+
"type": "string"
|
|
181098
|
+
}
|
|
181099
|
+
}
|
|
181100
|
+
}
|
|
181101
|
+
}
|
|
181102
|
+
}
|
|
181103
|
+
},
|
|
178877
181104
|
"500": {
|
|
178878
181105
|
"description": "Internal server error",
|
|
178879
181106
|
"content": {
|
|
@@ -178891,6 +181118,33 @@
|
|
|
178891
181118
|
}
|
|
178892
181119
|
}
|
|
178893
181120
|
}
|
|
181121
|
+
},
|
|
181122
|
+
"503": {
|
|
181123
|
+
"description": "Scheduled reports are not enabled for this account.",
|
|
181124
|
+
"content": {
|
|
181125
|
+
"application/json": {
|
|
181126
|
+
"schema": {
|
|
181127
|
+
"additionalProperties": false,
|
|
181128
|
+
"description": "Scheduled reports are not enabled for this account.",
|
|
181129
|
+
"type": "object",
|
|
181130
|
+
"required": [
|
|
181131
|
+
"error",
|
|
181132
|
+
"code"
|
|
181133
|
+
],
|
|
181134
|
+
"properties": {
|
|
181135
|
+
"error": {
|
|
181136
|
+
"type": "string"
|
|
181137
|
+
},
|
|
181138
|
+
"code": {
|
|
181139
|
+
"type": "string",
|
|
181140
|
+
"enum": [
|
|
181141
|
+
"FEATURE_DISABLED"
|
|
181142
|
+
]
|
|
181143
|
+
}
|
|
181144
|
+
}
|
|
181145
|
+
}
|
|
181146
|
+
}
|
|
181147
|
+
}
|
|
178894
181148
|
}
|
|
178895
181149
|
}
|
|
178896
181150
|
}
|