platform-api 3.6.0 → 3.7.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/lib/platform-api/client.rb +225 -74
- data/lib/platform-api/version.rb +1 -1
- data/platform-api.gemspec +1 -1
- data/schema.json +124 -13
- metadata +10 -10
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4df90c15a3a7108112d47c4a8912f2c0cc0c133f220f9b7b18a90f5f81b8eb84
|
4
|
+
data.tar.gz: 6466930cc95ffab375021eb6a3442aaf320d72cfaec9f2f8b78548c9798ffbaf
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 63e2ae18a43482dc82198b1b189048820530d0ec59d17b4a9f8836b7cfe5e9e448b772bfc7f063455abc2b15c7c05a67feb8eae72bfa57dc0bb31c54e2af2d57
|
7
|
+
data.tar.gz: 7787d7c3d99164a0d6737250f66b29e0fb1a755292a67c5e62da8c84452ab7bcfac1380318bc1e5ed3b4cd54c7e7bd83484134eb1accf9c6014c17b7144eb995
|
data/CHANGELOG.md
CHANGED
data/lib/platform-api/client.rb
CHANGED
@@ -83,7 +83,7 @@ module PlatformAPI
|
|
83
83
|
|
84
84
|
# Get the default options.
|
85
85
|
def self.default_options
|
86
|
-
default_headers = {"Accept"=>"application/vnd.heroku+json; version=3", "User-Agent"=>"platform-api/3.
|
86
|
+
default_headers = {"Accept"=>"application/vnd.heroku+json; version=3", "User-Agent"=>"platform-api/3.7.0"}
|
87
87
|
{
|
88
88
|
default_headers: default_headers,
|
89
89
|
url: "https://api.heroku.com"
|
@@ -98,6 +98,13 @@ module PlatformAPI
|
|
98
98
|
@client = client
|
99
99
|
end
|
100
100
|
|
101
|
+
# A Heroku account becomes delinquent due to non-payment. We [suspend and delete](https://help.heroku.com/EREVRILX/what-happens-if-i-have-unpaid-heroku-invoices) delinquent accounts if their invoices remain unpaid.
|
102
|
+
#
|
103
|
+
# @return [AccountDelinquency]
|
104
|
+
def account_delinquency
|
105
|
+
@account_delinquency_resource ||= AccountDelinquency.new(@client)
|
106
|
+
end
|
107
|
+
|
101
108
|
# An account feature represents a Heroku labs capability that can be enabled or disabled for an account on Heroku.
|
102
109
|
#
|
103
110
|
# @return [AccountFeature]
|
@@ -350,7 +357,7 @@ module PlatformAPI
|
|
350
357
|
@formation_resource ||= Formation.new(@client)
|
351
358
|
end
|
352
359
|
|
353
|
-
# Identity Providers represent the SAML configuration of an Enterprise
|
360
|
+
# Identity Providers represent the SAML configuration of teams or an Enterprise account
|
354
361
|
#
|
355
362
|
# @return [IdentityProvider]
|
356
363
|
def identity_provider
|
@@ -679,6 +686,13 @@ module PlatformAPI
|
|
679
686
|
@team_daily_usage_resource ||= TeamDailyUsage.new(@client)
|
680
687
|
end
|
681
688
|
|
689
|
+
# A Heroku team becomes delinquent due to non-payment. We [suspend and delete](https://help.heroku.com/EREVRILX/what-happens-if-i-have-unpaid-heroku-invoices) delinquent teams if their invoices remain unpaid.
|
690
|
+
#
|
691
|
+
# @return [TeamDelinquency]
|
692
|
+
def team_delinquency
|
693
|
+
@team_delinquency_resource ||= TeamDelinquency.new(@client)
|
694
|
+
end
|
695
|
+
|
682
696
|
# A team feature represents a feature enabled on a team account.
|
683
697
|
#
|
684
698
|
# @return [TeamFeature]
|
@@ -773,6 +787,18 @@ module PlatformAPI
|
|
773
787
|
|
774
788
|
private
|
775
789
|
|
790
|
+
# A Heroku account becomes delinquent due to non-payment. We [suspend and delete](https://help.heroku.com/EREVRILX/what-happens-if-i-have-unpaid-heroku-invoices) delinquent accounts if their invoices remain unpaid.
|
791
|
+
class AccountDelinquency
|
792
|
+
def initialize(client)
|
793
|
+
@client = client
|
794
|
+
end
|
795
|
+
|
796
|
+
# Account delinquency information.
|
797
|
+
def info()
|
798
|
+
@client.account_delinquency.info()
|
799
|
+
end
|
800
|
+
end
|
801
|
+
|
776
802
|
# An account feature represents a Heroku labs capability that can be enabled or disabled for an account on Heroku.
|
777
803
|
class AccountFeature
|
778
804
|
def initialize(client)
|
@@ -1465,18 +1491,18 @@ module PlatformAPI
|
|
1465
1491
|
|
1466
1492
|
# Get archive for a single month.
|
1467
1493
|
#
|
1468
|
-
# @param
|
1494
|
+
# @param enterprise_account_id_or_enterprise_account_name: unique identifier of the enterprise account or unique name of the enterprise account
|
1469
1495
|
# @param archive_year: year of the archive
|
1470
1496
|
# @param archive_month: month of the archive
|
1471
|
-
def info(
|
1472
|
-
@client.archive.info(
|
1497
|
+
def info(enterprise_account_id_or_enterprise_account_name, archive_year, archive_month)
|
1498
|
+
@client.archive.info(enterprise_account_id_or_enterprise_account_name, archive_year, archive_month)
|
1473
1499
|
end
|
1474
1500
|
|
1475
1501
|
# List existing archives.
|
1476
1502
|
#
|
1477
|
-
# @param
|
1478
|
-
def list(
|
1479
|
-
@client.archive.list(
|
1503
|
+
# @param enterprise_account_id_or_enterprise_account_name: unique identifier of the enterprise account or unique name of the enterprise account
|
1504
|
+
def list(enterprise_account_id_or_enterprise_account_name)
|
1505
|
+
@client.archive.list(enterprise_account_id_or_enterprise_account_name)
|
1480
1506
|
end
|
1481
1507
|
end
|
1482
1508
|
|
@@ -1488,9 +1514,9 @@ module PlatformAPI
|
|
1488
1514
|
|
1489
1515
|
# List existing events. Returns all events for one day, defaulting to current day. Order, actor, action, and type, and day query params can be specified as query parameters. For example, '/enterprise-accounts/:id/events?order=desc&actor=user@example.com&action=create&type=app&day=2020-09-30' would return events in descending order and only return app created events by the user with user@example.com email address.
|
1490
1516
|
#
|
1491
|
-
# @param
|
1492
|
-
def list(
|
1493
|
-
@client.audit_trail_event.list(
|
1517
|
+
# @param enterprise_account_id_or_enterprise_account_name: unique identifier of the enterprise account or unique name of the enterprise account
|
1518
|
+
def list(enterprise_account_id_or_enterprise_account_name)
|
1519
|
+
@client.audit_trail_event.list(enterprise_account_id_or_enterprise_account_name)
|
1494
1520
|
end
|
1495
1521
|
end
|
1496
1522
|
|
@@ -1798,34 +1824,34 @@ module PlatformAPI
|
|
1798
1824
|
|
1799
1825
|
# List members in an enterprise account.
|
1800
1826
|
#
|
1801
|
-
# @param
|
1802
|
-
def list(
|
1803
|
-
@client.enterprise_account_member.list(
|
1827
|
+
# @param enterprise_account_id_or_enterprise_account_name: unique identifier of the enterprise account or unique name of the enterprise account
|
1828
|
+
def list(enterprise_account_id_or_enterprise_account_name)
|
1829
|
+
@client.enterprise_account_member.list(enterprise_account_id_or_enterprise_account_name)
|
1804
1830
|
end
|
1805
1831
|
|
1806
1832
|
# Create a member in an enterprise account.
|
1807
1833
|
#
|
1808
|
-
# @param
|
1834
|
+
# @param enterprise_account_id_or_enterprise_account_name: unique identifier of the enterprise account or unique name of the enterprise account
|
1809
1835
|
# @param body: the object to pass as the request payload
|
1810
|
-
def create(
|
1811
|
-
@client.enterprise_account_member.create(
|
1836
|
+
def create(enterprise_account_id_or_enterprise_account_name, body = {})
|
1837
|
+
@client.enterprise_account_member.create(enterprise_account_id_or_enterprise_account_name, body)
|
1812
1838
|
end
|
1813
1839
|
|
1814
1840
|
# Update a member in an enterprise account.
|
1815
1841
|
#
|
1816
|
-
# @param
|
1842
|
+
# @param enterprise_account_id_or_enterprise_account_name: unique identifier of the enterprise account or unique name of the enterprise account
|
1817
1843
|
# @param account_email_or_account_id: unique email address of account or unique identifier of an account
|
1818
1844
|
# @param body: the object to pass as the request payload
|
1819
|
-
def update(
|
1820
|
-
@client.enterprise_account_member.update(
|
1845
|
+
def update(enterprise_account_id_or_enterprise_account_name, account_email_or_account_id, body = {})
|
1846
|
+
@client.enterprise_account_member.update(enterprise_account_id_or_enterprise_account_name, account_email_or_account_id, body)
|
1821
1847
|
end
|
1822
1848
|
|
1823
1849
|
# delete a member in an enterprise account.
|
1824
1850
|
#
|
1825
|
-
# @param
|
1851
|
+
# @param enterprise_account_id_or_enterprise_account_name: unique identifier of the enterprise account or unique name of the enterprise account
|
1826
1852
|
# @param account_email_or_account_id: unique email address of account or unique identifier of an account
|
1827
|
-
def delete(
|
1828
|
-
@client.enterprise_account_member.delete(
|
1853
|
+
def delete(enterprise_account_id_or_enterprise_account_name, account_email_or_account_id)
|
1854
|
+
@client.enterprise_account_member.delete(enterprise_account_id_or_enterprise_account_name, account_email_or_account_id)
|
1829
1855
|
end
|
1830
1856
|
end
|
1831
1857
|
|
@@ -1858,17 +1884,17 @@ module PlatformAPI
|
|
1858
1884
|
|
1859
1885
|
# Information about an enterprise account.
|
1860
1886
|
#
|
1861
|
-
# @param
|
1862
|
-
def info(
|
1863
|
-
@client.enterprise_account.info(
|
1887
|
+
# @param enterprise_account_id_or_enterprise_account_name: unique identifier of the enterprise account or unique name of the enterprise account
|
1888
|
+
def info(enterprise_account_id_or_enterprise_account_name)
|
1889
|
+
@client.enterprise_account.info(enterprise_account_id_or_enterprise_account_name)
|
1864
1890
|
end
|
1865
1891
|
|
1866
1892
|
# Update enterprise account properties
|
1867
1893
|
#
|
1868
|
-
# @param
|
1894
|
+
# @param enterprise_account_id_or_enterprise_account_name: unique identifier of the enterprise account or unique name of the enterprise account
|
1869
1895
|
# @param body: the object to pass as the request payload
|
1870
|
-
def update(
|
1871
|
-
@client.enterprise_account.update(
|
1896
|
+
def update(enterprise_account_id_or_enterprise_account_name, body = {})
|
1897
|
+
@client.enterprise_account.update(enterprise_account_id_or_enterprise_account_name, body)
|
1872
1898
|
end
|
1873
1899
|
end
|
1874
1900
|
|
@@ -1925,7 +1951,7 @@ module PlatformAPI
|
|
1925
1951
|
end
|
1926
1952
|
end
|
1927
1953
|
|
1928
|
-
# Identity Providers represent the SAML configuration of an Enterprise
|
1954
|
+
# Identity Providers represent the SAML configuration of teams or an Enterprise account
|
1929
1955
|
class IdentityProvider
|
1930
1956
|
def initialize(client)
|
1931
1957
|
@client = client
|
@@ -2187,7 +2213,7 @@ module PlatformAPI
|
|
2187
2213
|
@client.oauth_client.delete(oauth_client_id)
|
2188
2214
|
end
|
2189
2215
|
|
2190
|
-
# Info for an OAuth client
|
2216
|
+
# Info for an OAuth client. The output for unauthenticated requests excludes the `secret` parameter.
|
2191
2217
|
#
|
2192
2218
|
# @param oauth_client_id: unique identifier of this OAuth client
|
2193
2219
|
def info(oauth_client_id)
|
@@ -3063,34 +3089,34 @@ module PlatformAPI
|
|
3063
3089
|
|
3064
3090
|
# Delete an existing collaborator from a team app.
|
3065
3091
|
#
|
3066
|
-
# @param
|
3092
|
+
# @param team_app_identity:
|
3067
3093
|
# @param collaborator_email: invited email address of collaborator
|
3068
|
-
def delete(
|
3069
|
-
@client.team_app_collaborator.delete(
|
3094
|
+
def delete(team_app_identity, collaborator_email)
|
3095
|
+
@client.team_app_collaborator.delete(team_app_identity, collaborator_email)
|
3070
3096
|
end
|
3071
3097
|
|
3072
3098
|
# Info for a collaborator on a team app.
|
3073
3099
|
#
|
3074
|
-
# @param
|
3100
|
+
# @param team_app_identity:
|
3075
3101
|
# @param collaborator_email: invited email address of collaborator
|
3076
|
-
def info(
|
3077
|
-
@client.team_app_collaborator.info(
|
3102
|
+
def info(team_app_identity, collaborator_email)
|
3103
|
+
@client.team_app_collaborator.info(team_app_identity, collaborator_email)
|
3078
3104
|
end
|
3079
3105
|
|
3080
3106
|
# Update an existing collaborator from a team app.
|
3081
3107
|
#
|
3082
|
-
# @param
|
3108
|
+
# @param team_app_identity:
|
3083
3109
|
# @param collaborator_email: invited email address of collaborator
|
3084
3110
|
# @param body: the object to pass as the request payload
|
3085
|
-
def update(
|
3086
|
-
@client.team_app_collaborator.update(
|
3111
|
+
def update(team_app_identity, collaborator_email, body = {})
|
3112
|
+
@client.team_app_collaborator.update(team_app_identity, collaborator_email, body)
|
3087
3113
|
end
|
3088
3114
|
|
3089
3115
|
# List collaborators on a team app.
|
3090
3116
|
#
|
3091
|
-
# @param
|
3092
|
-
def list(
|
3093
|
-
@client.team_app_collaborator.list(
|
3117
|
+
# @param team_app_identity:
|
3118
|
+
def list(team_app_identity)
|
3119
|
+
@client.team_app_collaborator.list(team_app_identity)
|
3094
3120
|
end
|
3095
3121
|
end
|
3096
3122
|
|
@@ -3121,33 +3147,33 @@ module PlatformAPI
|
|
3121
3147
|
|
3122
3148
|
# Info for a team app.
|
3123
3149
|
#
|
3124
|
-
# @param
|
3125
|
-
def info(
|
3126
|
-
@client.team_app.info(
|
3150
|
+
# @param team_app_identity:
|
3151
|
+
def info(team_app_identity)
|
3152
|
+
@client.team_app.info(team_app_identity)
|
3127
3153
|
end
|
3128
3154
|
|
3129
3155
|
# Lock or unlock a team app.
|
3130
3156
|
#
|
3131
|
-
# @param
|
3157
|
+
# @param team_app_identity:
|
3132
3158
|
# @param body: the object to pass as the request payload
|
3133
|
-
def update_locked(
|
3134
|
-
@client.team_app.update_locked(
|
3159
|
+
def update_locked(team_app_identity, body = {})
|
3160
|
+
@client.team_app.update_locked(team_app_identity, body)
|
3135
3161
|
end
|
3136
3162
|
|
3137
3163
|
# Transfer an existing team app to another Heroku account.
|
3138
3164
|
#
|
3139
|
-
# @param
|
3165
|
+
# @param team_app_identity:
|
3140
3166
|
# @param body: the object to pass as the request payload
|
3141
|
-
def transfer_to_account(
|
3142
|
-
@client.team_app.transfer_to_account(
|
3167
|
+
def transfer_to_account(team_app_identity, body = {})
|
3168
|
+
@client.team_app.transfer_to_account(team_app_identity, body)
|
3143
3169
|
end
|
3144
3170
|
|
3145
3171
|
# Transfer an existing team app to another team.
|
3146
3172
|
#
|
3147
|
-
# @param
|
3173
|
+
# @param team_app_identity:
|
3148
3174
|
# @param body: the object to pass as the request payload
|
3149
|
-
def transfer_to_team(
|
3150
|
-
@client.team_app.transfer_to_team(
|
3175
|
+
def transfer_to_team(team_app_identity, body = {})
|
3176
|
+
@client.team_app.transfer_to_team(team_app_identity, body)
|
3151
3177
|
end
|
3152
3178
|
|
3153
3179
|
# List team apps.
|
@@ -3174,6 +3200,20 @@ module PlatformAPI
|
|
3174
3200
|
end
|
3175
3201
|
end
|
3176
3202
|
|
3203
|
+
# A Heroku team becomes delinquent due to non-payment. We [suspend and delete](https://help.heroku.com/EREVRILX/what-happens-if-i-have-unpaid-heroku-invoices) delinquent teams if their invoices remain unpaid.
|
3204
|
+
class TeamDelinquency
|
3205
|
+
def initialize(client)
|
3206
|
+
@client = client
|
3207
|
+
end
|
3208
|
+
|
3209
|
+
# Team delinquency information.
|
3210
|
+
#
|
3211
|
+
# @param team_name_or_team_id: unique name of team or unique identifier of team
|
3212
|
+
def info(team_name_or_team_id)
|
3213
|
+
@client.team_delinquency.info(team_name_or_team_id)
|
3214
|
+
end
|
3215
|
+
end
|
3216
|
+
|
3177
3217
|
# A team feature represents a feature enabled on a team account.
|
3178
3218
|
class TeamFeature
|
3179
3219
|
def initialize(client)
|
@@ -3410,17 +3450,17 @@ module PlatformAPI
|
|
3410
3450
|
|
3411
3451
|
# List teams for an enterprise account.
|
3412
3452
|
#
|
3413
|
-
# @param
|
3414
|
-
def list_by_enterprise_account(
|
3415
|
-
@client.team.list_by_enterprise_account(
|
3453
|
+
# @param enterprise_account_id_or_enterprise_account_name: unique identifier of the enterprise account or unique name of the enterprise account
|
3454
|
+
def list_by_enterprise_account(enterprise_account_id_or_enterprise_account_name)
|
3455
|
+
@client.team.list_by_enterprise_account(enterprise_account_id_or_enterprise_account_name)
|
3416
3456
|
end
|
3417
3457
|
|
3418
3458
|
# Create a team in an enterprise account.
|
3419
3459
|
#
|
3420
|
-
# @param
|
3460
|
+
# @param enterprise_account_id_or_enterprise_account_name: unique identifier of the enterprise account or unique name of the enterprise account
|
3421
3461
|
# @param body: the object to pass as the request payload
|
3422
|
-
def create_in_enterprise_account(
|
3423
|
-
@client.team.create_in_enterprise_account(
|
3462
|
+
def create_in_enterprise_account(enterprise_account_id_or_enterprise_account_name, body = {})
|
3463
|
+
@client.team.create_in_enterprise_account(enterprise_account_id_or_enterprise_account_name, body)
|
3424
3464
|
end
|
3425
3465
|
end
|
3426
3466
|
|
@@ -3572,6 +3612,58 @@ module PlatformAPI
|
|
3572
3612
|
"object"
|
3573
3613
|
],
|
3574
3614
|
"definitions": {
|
3615
|
+
"account-delinquency": {
|
3616
|
+
"description": "A Heroku account becomes delinquent due to non-payment. We [suspend and delete](https://help.heroku.com/EREVRILX/what-happens-if-i-have-unpaid-heroku-invoices) delinquent accounts if their invoices remain unpaid.",
|
3617
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
3618
|
+
"stability": "development",
|
3619
|
+
"strictProperties": true,
|
3620
|
+
"title": "Heroku Platform API - Account Delinquency",
|
3621
|
+
"type": [
|
3622
|
+
"object"
|
3623
|
+
],
|
3624
|
+
"definitions": {
|
3625
|
+
"scheduled_suspension_time": {
|
3626
|
+
"description": "scheduled time of when we will suspend your account due to delinquency",
|
3627
|
+
"example": "2024-01-01T12:00:00Z",
|
3628
|
+
"format": "date-time",
|
3629
|
+
"readOnly": true,
|
3630
|
+
"type": [
|
3631
|
+
"string",
|
3632
|
+
"null"
|
3633
|
+
]
|
3634
|
+
},
|
3635
|
+
"scheduled_deletion_time": {
|
3636
|
+
"description": "scheduled time of when we will delete your account due to delinquency",
|
3637
|
+
"example": "2024-01-01T12:00:00Z",
|
3638
|
+
"format": "date-time",
|
3639
|
+
"readOnly": true,
|
3640
|
+
"type": [
|
3641
|
+
"string",
|
3642
|
+
"null"
|
3643
|
+
]
|
3644
|
+
}
|
3645
|
+
},
|
3646
|
+
"links": [
|
3647
|
+
{
|
3648
|
+
"description": "Account delinquency information.",
|
3649
|
+
"href": "/account/delinquency",
|
3650
|
+
"method": "GET",
|
3651
|
+
"rel": "self",
|
3652
|
+
"targetSchema": {
|
3653
|
+
"$ref": "#/definitions/account-delinquency"
|
3654
|
+
},
|
3655
|
+
"title": "Info"
|
3656
|
+
}
|
3657
|
+
],
|
3658
|
+
"properties": {
|
3659
|
+
"scheduled_suspension_time": {
|
3660
|
+
"$ref": "#/definitions/account-delinquency/definitions/scheduled_suspension_time"
|
3661
|
+
},
|
3662
|
+
"scheduled_deletion_time": {
|
3663
|
+
"$ref": "#/definitions/account-delinquency/definitions/scheduled_deletion_time"
|
3664
|
+
}
|
3665
|
+
}
|
3666
|
+
},
|
3575
3667
|
"account-feature": {
|
3576
3668
|
"description": "An account feature represents a Heroku labs capability that can be enabled or disabled for an account on Heroku.",
|
3577
3669
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
@@ -9465,7 +9557,7 @@ module PlatformAPI
|
|
9465
9557
|
]
|
9466
9558
|
},
|
9467
9559
|
"size": {
|
9468
|
-
"description": "dyno size
|
9560
|
+
"description": "dyno size",
|
9469
9561
|
"example": "standard-1X",
|
9470
9562
|
"readOnly": false,
|
9471
9563
|
"type": [
|
@@ -10367,6 +10459,9 @@ module PlatformAPI
|
|
10367
10459
|
"anyOf": [
|
10368
10460
|
{
|
10369
10461
|
"$ref": "#/definitions/enterprise-account/definitions/id"
|
10462
|
+
},
|
10463
|
+
{
|
10464
|
+
"$ref": "#/definitions/enterprise-account/definitions/name"
|
10370
10465
|
}
|
10371
10466
|
]
|
10372
10467
|
},
|
@@ -10617,7 +10712,7 @@ module PlatformAPI
|
|
10617
10712
|
]
|
10618
10713
|
},
|
10619
10714
|
"size": {
|
10620
|
-
"description": "dyno size
|
10715
|
+
"description": "dyno size",
|
10621
10716
|
"example": "standard-1X",
|
10622
10717
|
"readOnly": false,
|
10623
10718
|
"type": [
|
@@ -10791,7 +10886,7 @@ module PlatformAPI
|
|
10791
10886
|
}
|
10792
10887
|
},
|
10793
10888
|
"identity-provider": {
|
10794
|
-
"description": "Identity Providers represent the SAML configuration of an Enterprise
|
10889
|
+
"description": "Identity Providers represent the SAML configuration of teams or an Enterprise account",
|
10795
10890
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
10796
10891
|
"stability": "production",
|
10797
10892
|
"strictProperties": true,
|
@@ -12422,7 +12517,7 @@ module PlatformAPI
|
|
12422
12517
|
"title": "Delete"
|
12423
12518
|
},
|
12424
12519
|
{
|
12425
|
-
"description": "Info for an OAuth client",
|
12520
|
+
"description": "Info for an OAuth client. The output for unauthenticated requests excludes the `secret` parameter.",
|
12426
12521
|
"href": "/oauth/clients/{(%23%2Fdefinitions%2Foauth-client%2Fdefinitions%2Fidentity)}",
|
12427
12522
|
"method": "GET",
|
12428
12523
|
"rel": "self",
|
@@ -12604,7 +12699,7 @@ module PlatformAPI
|
|
12604
12699
|
},
|
12605
12700
|
"token": {
|
12606
12701
|
"description": "contents of the token to be used for authorization",
|
12607
|
-
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
12702
|
+
"example": "HRKU-01234567-89ab-cdef-0123-456789abcdef",
|
12608
12703
|
"readOnly": true,
|
12609
12704
|
"type": [
|
12610
12705
|
"string"
|
@@ -12802,9 +12897,11 @@ module PlatformAPI
|
|
12802
12897
|
"outbound-ruleset": {
|
12803
12898
|
"description": "An outbound-ruleset is a collection of rules that specify what hosts Dynos are allowed to communicate with. ",
|
12804
12899
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
12805
|
-
"stability": "
|
12900
|
+
"stability": "deprecation",
|
12806
12901
|
"strictProperties": true,
|
12807
12902
|
"title": "Heroku Platform API - Outbound Ruleset",
|
12903
|
+
"deprecated_at": "2024-04-30",
|
12904
|
+
"deactivate_on": "2024-06-03",
|
12808
12905
|
"type": [
|
12809
12906
|
"object"
|
12810
12907
|
],
|
@@ -16970,7 +17067,7 @@ module PlatformAPI
|
|
16970
17067
|
"space": {
|
16971
17068
|
"description": "A space is an isolated, highly available, secure app execution environment.",
|
16972
17069
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
16973
|
-
"stability": "
|
17070
|
+
"stability": "production",
|
16974
17071
|
"strictProperties": true,
|
16975
17072
|
"title": "Heroku Platform API - Space",
|
16976
17073
|
"type": [
|
@@ -17633,11 +17730,7 @@ module PlatformAPI
|
|
17633
17730
|
]
|
17634
17731
|
},
|
17635
17732
|
"identity": {
|
17636
|
-
"
|
17637
|
-
{
|
17638
|
-
"$ref": "#/definitions/app/definitions/name"
|
17639
|
-
}
|
17640
|
-
]
|
17733
|
+
"$ref": "#/definitions/app/definitions/name"
|
17641
17734
|
},
|
17642
17735
|
"internal_routing": {
|
17643
17736
|
"default": false,
|
@@ -18119,6 +18212,58 @@ module PlatformAPI
|
|
18119
18212
|
}
|
18120
18213
|
}
|
18121
18214
|
},
|
18215
|
+
"team-delinquency": {
|
18216
|
+
"description": "A Heroku team becomes delinquent due to non-payment. We [suspend and delete](https://help.heroku.com/EREVRILX/what-happens-if-i-have-unpaid-heroku-invoices) delinquent teams if their invoices remain unpaid.",
|
18217
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
18218
|
+
"stability": "development",
|
18219
|
+
"strictProperties": true,
|
18220
|
+
"title": "Heroku Platform API - Team Delinquency",
|
18221
|
+
"type": [
|
18222
|
+
"object"
|
18223
|
+
],
|
18224
|
+
"definitions": {
|
18225
|
+
"scheduled_suspension_time": {
|
18226
|
+
"description": "scheduled time of when we will suspend your team due to delinquency",
|
18227
|
+
"example": "2024-01-01T12:00:00Z",
|
18228
|
+
"format": "date-time",
|
18229
|
+
"readOnly": true,
|
18230
|
+
"type": [
|
18231
|
+
"string",
|
18232
|
+
"null"
|
18233
|
+
]
|
18234
|
+
},
|
18235
|
+
"scheduled_deletion_time": {
|
18236
|
+
"description": "scheduled time of when we will delete your team due to delinquency",
|
18237
|
+
"example": "2024-01-01T12:00:00Z",
|
18238
|
+
"format": "date-time",
|
18239
|
+
"readOnly": true,
|
18240
|
+
"type": [
|
18241
|
+
"string",
|
18242
|
+
"null"
|
18243
|
+
]
|
18244
|
+
}
|
18245
|
+
},
|
18246
|
+
"links": [
|
18247
|
+
{
|
18248
|
+
"description": "Team delinquency information.",
|
18249
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/delinquency",
|
18250
|
+
"method": "GET",
|
18251
|
+
"rel": "self",
|
18252
|
+
"targetSchema": {
|
18253
|
+
"$ref": "#/definitions/team-delinquency"
|
18254
|
+
},
|
18255
|
+
"title": "Info"
|
18256
|
+
}
|
18257
|
+
],
|
18258
|
+
"properties": {
|
18259
|
+
"scheduled_suspension_time": {
|
18260
|
+
"$ref": "#/definitions/team-delinquency/definitions/scheduled_suspension_time"
|
18261
|
+
},
|
18262
|
+
"scheduled_deletion_time": {
|
18263
|
+
"$ref": "#/definitions/team-delinquency/definitions/scheduled_deletion_time"
|
18264
|
+
}
|
18265
|
+
}
|
18266
|
+
},
|
18122
18267
|
"team-feature": {
|
18123
18268
|
"description": "A team feature represents a feature enabled on a team account.",
|
18124
18269
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
@@ -18782,7 +18927,7 @@ module PlatformAPI
|
|
18782
18927
|
]
|
18783
18928
|
},
|
18784
18929
|
"two_factor_authentication": {
|
18785
|
-
"description": "whether the
|
18930
|
+
"description": "whether the team member has two factor authentication enabled",
|
18786
18931
|
"example": true,
|
18787
18932
|
"readOnly": true,
|
18788
18933
|
"type": [
|
@@ -20922,6 +21067,9 @@ module PlatformAPI
|
|
20922
21067
|
}
|
20923
21068
|
},
|
20924
21069
|
"properties": {
|
21070
|
+
"account-delinquency": {
|
21071
|
+
"$ref": "#/definitions/account-delinquency"
|
21072
|
+
},
|
20925
21073
|
"account-feature": {
|
20926
21074
|
"$ref": "#/definitions/account-feature"
|
20927
21075
|
},
|
@@ -21171,6 +21319,9 @@ module PlatformAPI
|
|
21171
21319
|
"team-daily-usage": {
|
21172
21320
|
"$ref": "#/definitions/team-daily-usage"
|
21173
21321
|
},
|
21322
|
+
"team-delinquency": {
|
21323
|
+
"$ref": "#/definitions/team-delinquency"
|
21324
|
+
},
|
21174
21325
|
"team-feature": {
|
21175
21326
|
"$ref": "#/definitions/team-feature"
|
21176
21327
|
},
|
data/lib/platform-api/version.rb
CHANGED
data/platform-api.gemspec
CHANGED
@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
|
|
22
22
|
|
23
23
|
spec.add_development_dependency 'bundler'
|
24
24
|
spec.add_development_dependency 'rake'
|
25
|
-
spec.add_development_dependency 'yard'
|
25
|
+
spec.add_development_dependency 'yard', '~> 0.9.36'
|
26
26
|
spec.add_development_dependency 'pry'
|
27
27
|
spec.add_development_dependency 'netrc'
|
28
28
|
spec.add_development_dependency 'rspec'
|
data/schema.json
CHANGED
@@ -4,6 +4,58 @@
|
|
4
4
|
"object"
|
5
5
|
],
|
6
6
|
"definitions": {
|
7
|
+
"account-delinquency": {
|
8
|
+
"description": "A Heroku account becomes delinquent due to non-payment. We [suspend and delete](https://help.heroku.com/EREVRILX/what-happens-if-i-have-unpaid-heroku-invoices) delinquent accounts if their invoices remain unpaid.",
|
9
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
10
|
+
"stability": "development",
|
11
|
+
"strictProperties": true,
|
12
|
+
"title": "Heroku Platform API - Account Delinquency",
|
13
|
+
"type": [
|
14
|
+
"object"
|
15
|
+
],
|
16
|
+
"definitions": {
|
17
|
+
"scheduled_suspension_time": {
|
18
|
+
"description": "scheduled time of when we will suspend your account due to delinquency",
|
19
|
+
"example": "2024-01-01T12:00:00Z",
|
20
|
+
"format": "date-time",
|
21
|
+
"readOnly": true,
|
22
|
+
"type": [
|
23
|
+
"string",
|
24
|
+
"null"
|
25
|
+
]
|
26
|
+
},
|
27
|
+
"scheduled_deletion_time": {
|
28
|
+
"description": "scheduled time of when we will delete your account due to delinquency",
|
29
|
+
"example": "2024-01-01T12:00:00Z",
|
30
|
+
"format": "date-time",
|
31
|
+
"readOnly": true,
|
32
|
+
"type": [
|
33
|
+
"string",
|
34
|
+
"null"
|
35
|
+
]
|
36
|
+
}
|
37
|
+
},
|
38
|
+
"links": [
|
39
|
+
{
|
40
|
+
"description": "Account delinquency information.",
|
41
|
+
"href": "/account/delinquency",
|
42
|
+
"method": "GET",
|
43
|
+
"rel": "self",
|
44
|
+
"targetSchema": {
|
45
|
+
"$ref": "#/definitions/account-delinquency"
|
46
|
+
},
|
47
|
+
"title": "Info"
|
48
|
+
}
|
49
|
+
],
|
50
|
+
"properties": {
|
51
|
+
"scheduled_suspension_time": {
|
52
|
+
"$ref": "#/definitions/account-delinquency/definitions/scheduled_suspension_time"
|
53
|
+
},
|
54
|
+
"scheduled_deletion_time": {
|
55
|
+
"$ref": "#/definitions/account-delinquency/definitions/scheduled_deletion_time"
|
56
|
+
}
|
57
|
+
}
|
58
|
+
},
|
7
59
|
"account-feature": {
|
8
60
|
"description": "An account feature represents a Heroku labs capability that can be enabled or disabled for an account on Heroku.",
|
9
61
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
@@ -5897,7 +5949,7 @@
|
|
5897
5949
|
]
|
5898
5950
|
},
|
5899
5951
|
"size": {
|
5900
|
-
"description": "dyno size
|
5952
|
+
"description": "dyno size",
|
5901
5953
|
"example": "standard-1X",
|
5902
5954
|
"readOnly": false,
|
5903
5955
|
"type": [
|
@@ -6799,6 +6851,9 @@
|
|
6799
6851
|
"anyOf": [
|
6800
6852
|
{
|
6801
6853
|
"$ref": "#/definitions/enterprise-account/definitions/id"
|
6854
|
+
},
|
6855
|
+
{
|
6856
|
+
"$ref": "#/definitions/enterprise-account/definitions/name"
|
6802
6857
|
}
|
6803
6858
|
]
|
6804
6859
|
},
|
@@ -7049,7 +7104,7 @@
|
|
7049
7104
|
]
|
7050
7105
|
},
|
7051
7106
|
"size": {
|
7052
|
-
"description": "dyno size
|
7107
|
+
"description": "dyno size",
|
7053
7108
|
"example": "standard-1X",
|
7054
7109
|
"readOnly": false,
|
7055
7110
|
"type": [
|
@@ -7223,7 +7278,7 @@
|
|
7223
7278
|
}
|
7224
7279
|
},
|
7225
7280
|
"identity-provider": {
|
7226
|
-
"description": "Identity Providers represent the SAML configuration of an Enterprise
|
7281
|
+
"description": "Identity Providers represent the SAML configuration of teams or an Enterprise account",
|
7227
7282
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
7228
7283
|
"stability": "production",
|
7229
7284
|
"strictProperties": true,
|
@@ -8854,7 +8909,7 @@
|
|
8854
8909
|
"title": "Delete"
|
8855
8910
|
},
|
8856
8911
|
{
|
8857
|
-
"description": "Info for an OAuth client",
|
8912
|
+
"description": "Info for an OAuth client. The output for unauthenticated requests excludes the `secret` parameter.",
|
8858
8913
|
"href": "/oauth/clients/{(%23%2Fdefinitions%2Foauth-client%2Fdefinitions%2Fidentity)}",
|
8859
8914
|
"method": "GET",
|
8860
8915
|
"rel": "self",
|
@@ -9035,7 +9090,7 @@
|
|
9035
9090
|
},
|
9036
9091
|
"token": {
|
9037
9092
|
"description": "contents of the token to be used for authorization",
|
9038
|
-
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
9093
|
+
"example": "HRKU-01234567-89ab-cdef-0123-456789abcdef",
|
9039
9094
|
"readOnly": true,
|
9040
9095
|
"type": [
|
9041
9096
|
"string"
|
@@ -9233,9 +9288,11 @@
|
|
9233
9288
|
"outbound-ruleset": {
|
9234
9289
|
"description": "An outbound-ruleset is a collection of rules that specify what hosts Dynos are allowed to communicate with. ",
|
9235
9290
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
9236
|
-
"stability": "
|
9291
|
+
"stability": "deprecation",
|
9237
9292
|
"strictProperties": true,
|
9238
9293
|
"title": "Heroku Platform API - Outbound Ruleset",
|
9294
|
+
"deprecated_at": "2024-04-30",
|
9295
|
+
"deactivate_on": "2024-06-03",
|
9239
9296
|
"type": [
|
9240
9297
|
"object"
|
9241
9298
|
],
|
@@ -13399,7 +13456,7 @@
|
|
13399
13456
|
"space": {
|
13400
13457
|
"description": "A space is an isolated, highly available, secure app execution environment.",
|
13401
13458
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
13402
|
-
"stability": "
|
13459
|
+
"stability": "production",
|
13403
13460
|
"strictProperties": true,
|
13404
13461
|
"title": "Heroku Platform API - Space",
|
13405
13462
|
"type": [
|
@@ -14062,11 +14119,7 @@
|
|
14062
14119
|
]
|
14063
14120
|
},
|
14064
14121
|
"identity": {
|
14065
|
-
"
|
14066
|
-
{
|
14067
|
-
"$ref": "#/definitions/app/definitions/name"
|
14068
|
-
}
|
14069
|
-
]
|
14122
|
+
"$ref": "#/definitions/app/definitions/name"
|
14070
14123
|
},
|
14071
14124
|
"internal_routing": {
|
14072
14125
|
"default": false,
|
@@ -14548,6 +14601,58 @@
|
|
14548
14601
|
}
|
14549
14602
|
}
|
14550
14603
|
},
|
14604
|
+
"team-delinquency": {
|
14605
|
+
"description": "A Heroku team becomes delinquent due to non-payment. We [suspend and delete](https://help.heroku.com/EREVRILX/what-happens-if-i-have-unpaid-heroku-invoices) delinquent teams if their invoices remain unpaid.",
|
14606
|
+
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
14607
|
+
"stability": "development",
|
14608
|
+
"strictProperties": true,
|
14609
|
+
"title": "Heroku Platform API - Team Delinquency",
|
14610
|
+
"type": [
|
14611
|
+
"object"
|
14612
|
+
],
|
14613
|
+
"definitions": {
|
14614
|
+
"scheduled_suspension_time": {
|
14615
|
+
"description": "scheduled time of when we will suspend your team due to delinquency",
|
14616
|
+
"example": "2024-01-01T12:00:00Z",
|
14617
|
+
"format": "date-time",
|
14618
|
+
"readOnly": true,
|
14619
|
+
"type": [
|
14620
|
+
"string",
|
14621
|
+
"null"
|
14622
|
+
]
|
14623
|
+
},
|
14624
|
+
"scheduled_deletion_time": {
|
14625
|
+
"description": "scheduled time of when we will delete your team due to delinquency",
|
14626
|
+
"example": "2024-01-01T12:00:00Z",
|
14627
|
+
"format": "date-time",
|
14628
|
+
"readOnly": true,
|
14629
|
+
"type": [
|
14630
|
+
"string",
|
14631
|
+
"null"
|
14632
|
+
]
|
14633
|
+
}
|
14634
|
+
},
|
14635
|
+
"links": [
|
14636
|
+
{
|
14637
|
+
"description": "Team delinquency information.",
|
14638
|
+
"href": "/teams/{(%23%2Fdefinitions%2Fteam%2Fdefinitions%2Fidentity)}/delinquency",
|
14639
|
+
"method": "GET",
|
14640
|
+
"rel": "self",
|
14641
|
+
"targetSchema": {
|
14642
|
+
"$ref": "#/definitions/team-delinquency"
|
14643
|
+
},
|
14644
|
+
"title": "Info"
|
14645
|
+
}
|
14646
|
+
],
|
14647
|
+
"properties": {
|
14648
|
+
"scheduled_suspension_time": {
|
14649
|
+
"$ref": "#/definitions/team-delinquency/definitions/scheduled_suspension_time"
|
14650
|
+
},
|
14651
|
+
"scheduled_deletion_time": {
|
14652
|
+
"$ref": "#/definitions/team-delinquency/definitions/scheduled_deletion_time"
|
14653
|
+
}
|
14654
|
+
}
|
14655
|
+
},
|
14551
14656
|
"team-feature": {
|
14552
14657
|
"description": "A team feature represents a feature enabled on a team account.",
|
14553
14658
|
"$schema": "http://json-schema.org/draft-04/hyper-schema",
|
@@ -15211,7 +15316,7 @@
|
|
15211
15316
|
]
|
15212
15317
|
},
|
15213
15318
|
"two_factor_authentication": {
|
15214
|
-
"description": "whether the
|
15319
|
+
"description": "whether the team member has two factor authentication enabled",
|
15215
15320
|
"example": true,
|
15216
15321
|
"readOnly": true,
|
15217
15322
|
"type": [
|
@@ -17351,6 +17456,9 @@
|
|
17351
17456
|
}
|
17352
17457
|
},
|
17353
17458
|
"properties": {
|
17459
|
+
"account-delinquency": {
|
17460
|
+
"$ref": "#/definitions/account-delinquency"
|
17461
|
+
},
|
17354
17462
|
"account-feature": {
|
17355
17463
|
"$ref": "#/definitions/account-feature"
|
17356
17464
|
},
|
@@ -17600,6 +17708,9 @@
|
|
17600
17708
|
"team-daily-usage": {
|
17601
17709
|
"$ref": "#/definitions/team-daily-usage"
|
17602
17710
|
},
|
17711
|
+
"team-delinquency": {
|
17712
|
+
"$ref": "#/definitions/team-delinquency"
|
17713
|
+
},
|
17603
17714
|
"team-feature": {
|
17604
17715
|
"$ref": "#/definitions/team-feature"
|
17605
17716
|
},
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: platform-api
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 3.
|
4
|
+
version: 3.7.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- jkakar
|
8
|
-
autorequire:
|
8
|
+
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-
|
11
|
+
date: 2024-05-29 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: bundler
|
@@ -42,16 +42,16 @@ dependencies:
|
|
42
42
|
name: yard
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|
44
44
|
requirements:
|
45
|
-
- - "
|
45
|
+
- - "~>"
|
46
46
|
- !ruby/object:Gem::Version
|
47
|
-
version:
|
47
|
+
version: 0.9.36
|
48
48
|
type: :development
|
49
49
|
prerelease: false
|
50
50
|
version_requirements: !ruby/object:Gem::Requirement
|
51
51
|
requirements:
|
52
|
-
- - "
|
52
|
+
- - "~>"
|
53
53
|
- !ruby/object:Gem::Version
|
54
|
-
version:
|
54
|
+
version: 0.9.36
|
55
55
|
- !ruby/object:Gem::Dependency
|
56
56
|
name: pry
|
57
57
|
requirement: !ruby/object:Gem::Requirement
|
@@ -197,7 +197,7 @@ homepage: https://github.com/heroku/platform-api
|
|
197
197
|
licenses:
|
198
198
|
- MIT
|
199
199
|
metadata: {}
|
200
|
-
post_install_message:
|
200
|
+
post_install_message:
|
201
201
|
rdoc_options: []
|
202
202
|
require_paths:
|
203
203
|
- lib
|
@@ -212,8 +212,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
212
212
|
- !ruby/object:Gem::Version
|
213
213
|
version: '0'
|
214
214
|
requirements: []
|
215
|
-
rubygems_version: 3.
|
216
|
-
signing_key:
|
215
|
+
rubygems_version: 3.2.21
|
216
|
+
signing_key:
|
217
217
|
specification_version: 4
|
218
218
|
summary: Ruby HTTP client for the Heroku API.
|
219
219
|
test_files: []
|