platform-api 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,1704 +1,2 @@
1
- # encoding: utf-8
2
-
3
- #
4
- # WARNING: Do not edit by hand, this file was generated by Heroics:
5
- #
6
- # https://github.com/interagent/heroics
7
- #
8
-
9
- require 'heroics'
10
- require 'uri'
11
-
12
- module PlatformAPI
13
- # Get a Client configured to use HTTP Basic authentication.
14
- #
15
- # @param api_key [String] The API key to use when connecting.
16
- # @param options [Hash<Symbol,String>] Optionally, custom settings
17
- # to use with the client. Allowed options are `default_headers`,
18
- # `cache`, `user` and `url`.
19
- # @return [Client] A client configured to use the API with HTTP Basic
20
- # authentication.
21
- def self.connect(api_key, options=nil)
22
- options = custom_options(options)
23
- uri = URI.parse(options[:url])
24
- uri.user = options.fetch(:user, 'user').gsub('@', '%40')
25
- uri.password = api_key
26
- client = Heroics.client_from_schema(SCHEMA, uri.to_s, options)
27
- Client.new(client)
28
- end
29
-
30
- # Get a Client configured to use OAuth authentication.
31
- #
32
- # @param oauth_token [String] The OAuth token to use with the API.
33
- # @param options [Hash<Symbol,String>] Optionally, custom settings
34
- # to use with the client. Allowed options are `default_headers`,
35
- # `cache` and `url`.
36
- # @return [Client] A client configured to use the API with OAuth
37
- # authentication.
38
- def self.connect_oauth(oauth_token, options=nil)
39
- options = custom_options(options)
40
- url = options[:url]
41
- client = Heroics.oauth_client_from_schema(oauth_token, SCHEMA, url, options)
42
- Client.new(client)
43
- end
44
-
45
- # Get a Client configured to use Token authentication.
46
- #
47
- # @param token [String] The token to use with the API.
48
- # @param options [Hash<Symbol,String>] Optionally, custom settings
49
- # to use with the client. Allowed options are `default_headers`,
50
- # `cache` and `url`.
51
- # @return [Client] A client configured to use the API with OAuth
52
- # authentication.
53
- def self.connect_token(token, options=nil)
54
- options = custom_options(options)
55
- url = options[:url]
56
- client = Heroics.token_client_from_schema(token, SCHEMA, url, options)
57
- Client.new(client)
58
- end
59
-
60
- # Get customized options.
61
- def self.custom_options(options)
62
- return default_options if options.nil?
63
-
64
- final_options = default_options
65
- if options[:default_headers]
66
- final_options[:default_headers].merge!(options[:default_headers])
67
- end
68
- final_options[:cache] = options[:cache] if options[:cache]
69
- final_options[:url] = options[:url] if options[:url]
70
- final_options[:user] = options[:user] if options[:user]
71
- final_options
72
- end
73
-
74
- # Get the default options.
75
- def self.default_options
76
- default_headers = {"Accept"=>"application/vnd.heroku+json; version=3"}
77
- cache = Moneta.new(:File, dir: "#{Dir.home}/.heroics/platform-api")
78
- {
79
- default_headers: default_headers,
80
- cache: cache,
81
- url: "https://api.heroku.com"
82
- }
83
- end
84
-
85
- private_class_method :default_options, :custom_options
86
-
87
- # The platform API empowers developers to automate, extend and combine Heroku with other services.
88
- class Client
89
- def initialize(client)
90
- @client = client
91
- end
92
-
93
- # An add-on attachment represents a connection between an app and an add-on that it has been given access to.
94
- #
95
- # @return [AddonAttachment]
96
- def addon_attachment
97
- @addon_attachment_resource ||= AddonAttachment.new(@client)
98
- end
99
-
100
- # Add-on services represent add-ons that may be provisioned for apps. Endpoints under add-on services can be accessed without authentication.
101
- #
102
- # @return [AddonService]
103
- def addon_service
104
- @addon_service_resource ||= AddonService.new(@client)
105
- end
106
-
107
- # Add-ons represent add-ons that have been provisioned for an app.
108
- #
109
- # @return [Addon]
110
- def addon
111
- @addon_resource ||= Addon.new(@client)
112
- end
113
-
114
- # An app feature represents a Heroku labs capability that can be enabled or disabled for an app on Heroku.
115
- #
116
- # @return [AppFeature]
117
- def app_feature
118
- @app_feature_resource ||= AppFeature.new(@client)
119
- end
120
-
121
- # An app setup represents an app on Heroku that is setup using an environment, addons, and scripts described in an app.json manifest file.
122
- #
123
- # @return [AppSetup]
124
- def app_setup
125
- @app_setup_resource ||= AppSetup.new(@client)
126
- end
127
-
128
- # An app transfer represents a two party interaction for transferring ownership of an app.
129
- #
130
- # @return [AppTransfer]
131
- def app_transfer
132
- @app_transfer_resource ||= AppTransfer.new(@client)
133
- end
134
-
135
- # An app represents the program that you would like to deploy and run on Heroku.
136
- #
137
- # @return [App]
138
- def app
139
- @app_resource ||= App.new(@client)
140
- end
141
-
142
- # A build result contains the output from a build.
143
- #
144
- # @return [BuildResult]
145
- def build_result
146
- @build_result_resource ||= BuildResult.new(@client)
147
- end
148
-
149
- # A build represents the process of transforming a code tarball into a slug
150
- #
151
- # @return [Build]
152
- def build
153
- @build_resource ||= Build.new(@client)
154
- end
155
-
156
- # An buildpack installtion represents a buildpack that will be run against an app.
157
- #
158
- # @return [BuildpackInstallation]
159
- def buildpack_installation
160
- @buildpack_installation_resource ||= BuildpackInstallation.new(@client)
161
- end
162
-
163
- # A collaborator represents an account that has been given access to an app on Heroku.
164
- #
165
- # @return [Collaborator]
166
- def collaborator
167
- @collaborator_resource ||= Collaborator.new(@client)
168
- end
169
-
170
- # Config Vars allow you to manage the configuration information provided to an app on Heroku.
171
- #
172
- # @return [ConfigVar]
173
- def config_var
174
- @config_var_resource ||= ConfigVar.new(@client)
175
- end
176
-
177
- # A credit represents value that will be used up before further charges are assigned to an account.
178
- #
179
- # @return [Credit]
180
- def credit
181
- @credit_resource ||= Credit.new(@client)
182
- end
183
-
184
- # Domains define what web routes should be routed to an app on Heroku.
185
- #
186
- # @return [Domain]
187
- def domain
188
- @domain_resource ||= Domain.new(@client)
189
- end
190
-
191
- # Dynos encapsulate running processes of an app on Heroku.
192
- #
193
- # @return [Dyno]
194
- def dyno
195
- @dyno_resource ||= Dyno.new(@client)
196
- end
197
-
198
- # An event represents an action performed on another API resource.
199
- #
200
- # @return [Event]
201
- def event
202
- @event_resource ||= Event.new(@client)
203
- end
204
-
205
- # The formation of processes that should be maintained for an app. Update the formation to scale processes or change dyno sizes. Available process type names and commands are defined by the `process_types` attribute for the [slug](#slug) currently released on an app.
206
- #
207
- # @return [Formation]
208
- def formation
209
- @formation_resource ||= Formation.new(@client)
210
- end
211
-
212
- # An invoice is an itemized bill of goods for an account which includes pricing and charges.
213
- #
214
- # @return [Invoice]
215
- def invoice
216
- @invoice_resource ||= Invoice.new(@client)
217
- end
218
-
219
- # An invoice address represents the address that should be listed on an invoice.
220
- #
221
- # @return [InvoiceAddress]
222
- def invoice_address
223
- @invoice_address_resource ||= InvoiceAddress.new(@client)
224
- end
225
-
226
- # Keys represent public SSH keys associated with an account and are used to authorize accounts as they are performing git operations.
227
- #
228
- # @return [Key]
229
- def key
230
- @key_resource ||= Key.new(@client)
231
- end
232
-
233
- # [Log drains](https://devcenter.heroku.com/articles/log-drains) provide a way to forward your Heroku logs to an external syslog server for long-term archiving. This external service must be configured to receive syslog packets from Heroku, whereupon its URL can be added to an app using this API. Some addons will add a log drain when they are provisioned to an app. These drains can only be removed by removing the add-on.
234
- #
235
- # @return [LogDrain]
236
- def log_drain
237
- @log_drain_resource ||= LogDrain.new(@client)
238
- end
239
-
240
- # A log session is a reference to the http based log stream for an app.
241
- #
242
- # @return [LogSession]
243
- def log_session
244
- @log_session_resource ||= LogSession.new(@client)
245
- end
246
-
247
- # OAuth authorizations represent clients that a Heroku user has authorized to automate, customize or extend their usage of the platform. For more information please refer to the [Heroku OAuth documentation](https://devcenter.heroku.com/articles/oauth)
248
- #
249
- # @return [OauthAuthorization]
250
- def oauth_authorization
251
- @oauth_authorization_resource ||= OauthAuthorization.new(@client)
252
- end
253
-
254
- # OAuth clients are applications that Heroku users can authorize to automate, customize or extend their usage of the platform. For more information please refer to the [Heroku OAuth documentation](https://devcenter.heroku.com/articles/oauth).
255
- #
256
- # @return [OauthClient]
257
- def oauth_client
258
- @oauth_client_resource ||= OauthClient.new(@client)
259
- end
260
-
261
- # OAuth grants are used to obtain authorizations on behalf of a user. For more information please refer to the [Heroku OAuth documentation](https://devcenter.heroku.com/articles/oauth)
262
- #
263
- # @return [OauthGrant]
264
- def oauth_grant
265
- @oauth_grant_resource ||= OauthGrant.new(@client)
266
- end
267
-
268
- # OAuth tokens provide access for authorized clients to act on behalf of a Heroku user to automate, customize or extend their usage of the platform. For more information please refer to the [Heroku OAuth documentation](https://devcenter.heroku.com/articles/oauth)
269
- #
270
- # @return [OauthToken]
271
- def oauth_token
272
- @oauth_token_resource ||= OauthToken.new(@client)
273
- end
274
-
275
- # An organization collaborator represents an account that has been given access to an organization app on Heroku.
276
- #
277
- # @return [OrganizationAppCollaborator]
278
- def organization_app_collaborator
279
- @organization_app_collaborator_resource ||= OrganizationAppCollaborator.new(@client)
280
- end
281
-
282
- # An organization app encapsulates the organization specific functionality of Heroku apps.
283
- #
284
- # @return [OrganizationApp]
285
- def organization_app
286
- @organization_app_resource ||= OrganizationApp.new(@client)
287
- end
288
-
289
- # An organization invoice is an itemized bill of goods for an organization which includes pricing and charges.
290
- #
291
- # @return [OrganizationInvoice]
292
- def organization_invoice
293
- @organization_invoice_resource ||= OrganizationInvoice.new(@client)
294
- end
295
-
296
- # An organization member is an individual with access to an organization.
297
- #
298
- # @return [OrganizationMember]
299
- def organization_member
300
- @organization_member_resource ||= OrganizationMember.new(@client)
301
- end
302
-
303
- # Organizations allow you to manage access to a shared group of applications across your development team.
304
- #
305
- # @return [Organization]
306
- def organization
307
- @organization_resource ||= Organization.new(@client)
308
- end
309
-
310
- # This renders a secret that clients can use to build a one-time password to be supplied as a 2nd factor of authentication.
311
- #
312
- # @return [OtpSecret]
313
- def otp_secret
314
- @otp_secret_resource ||= OtpSecret.new(@client)
315
- end
316
-
317
- # A payment represents money collected for an account
318
- #
319
- # @return [Payment]
320
- def payment
321
- @payment_resource ||= Payment.new(@client)
322
- end
323
-
324
- # The on file payment method for an account
325
- #
326
- # @return [PaymentMethod]
327
- def payment_method
328
- @payment_method_resource ||= PaymentMethod.new(@client)
329
- end
330
-
331
- # Plans represent different configurations of add-ons that may be added to apps. Endpoints under add-on services can be accessed without authentication.
332
- #
333
- # @return [Plan]
334
- def plan
335
- @plan_resource ||= Plan.new(@client)
336
- end
337
-
338
- # Rate Limit represents the number of request tokens each account holds. Requests to this endpoint do not count towards the rate limit.
339
- #
340
- # @return [RateLimit]
341
- def rate_limit
342
- @rate_limit_resource ||= RateLimit.new(@client)
343
- end
344
-
345
- # Recovery codes grant access to accounts with two-factor authentication enabled.
346
- #
347
- # @return [RecoveryCode]
348
- def recovery_code
349
- @recovery_code_resource ||= RecoveryCode.new(@client)
350
- end
351
-
352
- # A region represents a geographic location in which your application may run.
353
- #
354
- # @return [Region]
355
- def region
356
- @region_resource ||= Region.new(@client)
357
- end
358
-
359
- # A release represents a combination of code, config vars and add-ons for an app on Heroku.
360
- #
361
- # @return [Release]
362
- def release
363
- @release_resource ||= Release.new(@client)
364
- end
365
-
366
- # A slug is a snapshot of your application code that is ready to run on the platform.
367
- #
368
- # @return [Slug]
369
- def slug
370
- @slug_resource ||= Slug.new(@client)
371
- end
372
-
373
- # A source is a location for uploading and downloading an application's source code.
374
- #
375
- # @return [Source]
376
- def source
377
- @source_resource ||= Source.new(@client)
378
- end
379
-
380
- # [SSL Endpoint](https://devcenter.heroku.com/articles/ssl-endpoint) is a public address serving custom SSL cert for HTTPS traffic to a Heroku app. Note that an app must have the `ssl:endpoint` addon installed before it can provision an SSL Endpoint using these APIs.
381
- #
382
- # @return [SSLEndpoint]
383
- def ssl_endpoint
384
- @ssl_endpoint_resource ||= SSLEndpoint.new(@client)
385
- end
386
-
387
- # Stacks are the different application execution environments available in the Heroku platform.
388
- #
389
- # @return [Stack]
390
- def stack
391
- @stack_resource ||= Stack.new(@client)
392
- end
393
-
394
- # An account feature represents a Heroku labs capability that can be enabled or disabled for an account on Heroku.
395
- #
396
- # @return [AccountFeature]
397
- def account_feature
398
- @account_feature_resource ||= AccountFeature.new(@client)
399
- end
400
-
401
- # Tracks a user's preferences and message dismissals
402
- #
403
- # @return [UserPreferences]
404
- def user_preferences
405
- @user_preferences_resource ||= UserPreferences.new(@client)
406
- end
407
-
408
- # An account represents an individual signed up to use the Heroku platform.
409
- #
410
- # @return [Account]
411
- def account
412
- @account_resource ||= Account.new(@client)
413
- end
414
- end
415
-
416
- private
417
-
418
- # An add-on attachment represents a connection between an app and an add-on that it has been given access to.
419
- class AddonAttachment
420
- def initialize(client)
421
- @client = client
422
- end
423
-
424
- # Create a new add-on attachment.
425
- #
426
- # @param body: the object to pass as the request payload
427
- def create(body)
428
- @client.addon_attachment.create(body)
429
- end
430
-
431
- # Delete an existing add-on attachment.
432
- #
433
- # @param addon_attachment_id: unique identifier of this add-on attachment
434
- def delete(addon_attachment_id)
435
- @client.addon_attachment.delete(addon_attachment_id)
436
- end
437
-
438
- # Info for existing add-on attachment.
439
- #
440
- # @param addon_attachment_id: unique identifier of this add-on attachment
441
- def info(addon_attachment_id)
442
- @client.addon_attachment.info(addon_attachment_id)
443
- end
444
-
445
- # List existing add-on attachments.
446
- def list()
447
- @client.addon_attachment.list()
448
- end
449
-
450
- # List existing add-on attachments for an add-on.
451
- #
452
- # @param addon_id_or_addon_name: unique identifier of add-on or globally unique name of the add-on
453
- def list_by_add_on(addon_id_or_addon_name)
454
- @client.addon_attachment.list_by_add_on(addon_id_or_addon_name)
455
- end
456
-
457
- # List existing add-on attachments for an app.
458
- #
459
- # @param app_id_or_app_name: unique identifier of app or unique name of app
460
- def list_by_app(app_id_or_app_name)
461
- @client.addon_attachment.list_by_app(app_id_or_app_name)
462
- end
463
-
464
- # Info for existing add-on attachment for an app.
465
- #
466
- # @param app_id_or_app_name: unique identifier of app or unique name of app
467
- # @param addon_attachment_id_or_addon_attachment_name: unique identifier of this add-on attachment or unique name for this add-on attachment to this app
468
- def info_by_app(app_id_or_app_name, addon_attachment_id_or_addon_attachment_name)
469
- @client.addon_attachment.info_by_app(app_id_or_app_name, addon_attachment_id_or_addon_attachment_name)
470
- end
471
- end
472
-
473
- # Add-on services represent add-ons that may be provisioned for apps. Endpoints under add-on services can be accessed without authentication.
474
- class AddonService
475
- def initialize(client)
476
- @client = client
477
- end
478
-
479
- # Info for existing addon-service.
480
- #
481
- # @param addon_service_id_or_addon_service_name: unique identifier of this addon-service or unique name of this addon-service
482
- def info(addon_service_id_or_addon_service_name)
483
- @client.addon_service.info(addon_service_id_or_addon_service_name)
484
- end
485
-
486
- # List existing addon-services.
487
- def list()
488
- @client.addon_service.list()
489
- end
490
- end
491
-
492
- # Add-ons represent add-ons that have been provisioned for an app.
493
- class Addon
494
- def initialize(client)
495
- @client = client
496
- end
497
-
498
- # Create a new add-on.
499
- #
500
- # @param app_id_or_app_name: unique identifier of app or unique name of app
501
- # @param body: the object to pass as the request payload
502
- def create(app_id_or_app_name, body)
503
- @client.addon.create(app_id_or_app_name, body)
504
- end
505
-
506
- # Delete an existing add-on.
507
- #
508
- # @param app_id_or_app_name: unique identifier of app or unique name of app
509
- # @param addon_id_or_addon_name: unique identifier of add-on or globally unique name of the add-on
510
- def delete(app_id_or_app_name, addon_id_or_addon_name)
511
- @client.addon.delete(app_id_or_app_name, addon_id_or_addon_name)
512
- end
513
-
514
- # Info for an existing add-on.
515
- #
516
- # @param addon_id_or_addon_name: unique identifier of add-on or globally unique name of the add-on
517
- def info(addon_id_or_addon_name)
518
- @client.addon.info(addon_id_or_addon_name)
519
- end
520
-
521
- # List all existing add-ons.
522
- def list()
523
- @client.addon.list()
524
- end
525
-
526
- # List existing add-ons for an app.
527
- #
528
- # @param app_id_or_app_name: unique identifier of app or unique name of app
529
- def list_by_app(app_id_or_app_name)
530
- @client.addon.list_by_app(app_id_or_app_name)
531
- end
532
-
533
- # Change add-on plan. Some add-ons may not support changing plans. In that case, an error will be returned.
534
- #
535
- # @param app_id_or_app_name: unique identifier of app or unique name of app
536
- # @param addon_id_or_addon_name: unique identifier of add-on or globally unique name of the add-on
537
- # @param body: the object to pass as the request payload
538
- def update(app_id_or_app_name, addon_id_or_addon_name, body)
539
- @client.addon.update(app_id_or_app_name, addon_id_or_addon_name, body)
540
- end
541
- end
542
-
543
- # An app feature represents a Heroku labs capability that can be enabled or disabled for an app on Heroku.
544
- class AppFeature
545
- def initialize(client)
546
- @client = client
547
- end
548
-
549
- # Info for an existing app feature.
550
- #
551
- # @param app_id_or_app_name: unique identifier of app or unique name of app
552
- # @param app_feature_id_or_app_feature_name: unique identifier of app feature or unique name of app feature
553
- def info(app_id_or_app_name, app_feature_id_or_app_feature_name)
554
- @client.app_feature.info(app_id_or_app_name, app_feature_id_or_app_feature_name)
555
- end
556
-
557
- # List existing app features.
558
- #
559
- # @param app_id_or_app_name: unique identifier of app or unique name of app
560
- def list(app_id_or_app_name)
561
- @client.app_feature.list(app_id_or_app_name)
562
- end
563
-
564
- # Update an existing app feature.
565
- #
566
- # @param app_id_or_app_name: unique identifier of app or unique name of app
567
- # @param app_feature_id_or_app_feature_name: unique identifier of app feature or unique name of app feature
568
- # @param body: the object to pass as the request payload
569
- def update(app_id_or_app_name, app_feature_id_or_app_feature_name, body)
570
- @client.app_feature.update(app_id_or_app_name, app_feature_id_or_app_feature_name, body)
571
- end
572
- end
573
-
574
- # An app setup represents an app on Heroku that is setup using an environment, addons, and scripts described in an app.json manifest file.
575
- class AppSetup
576
- def initialize(client)
577
- @client = client
578
- end
579
-
580
- # Create a new app setup from a gzipped tar archive containing an app.json manifest file.
581
- #
582
- # @param body: the object to pass as the request payload
583
- def create(body)
584
- @client.app_setup.create(body)
585
- end
586
-
587
- # Get the status of an app setup.
588
- #
589
- # @param app_setup_id: unique identifier of app setup
590
- def info(app_setup_id)
591
- @client.app_setup.info(app_setup_id)
592
- end
593
- end
594
-
595
- # An app transfer represents a two party interaction for transferring ownership of an app.
596
- class AppTransfer
597
- def initialize(client)
598
- @client = client
599
- end
600
-
601
- # Create a new app transfer.
602
- #
603
- # @param body: the object to pass as the request payload
604
- def create(body)
605
- @client.app_transfer.create(body)
606
- end
607
-
608
- # Delete an existing app transfer
609
- #
610
- # @param app_transfer_id_or_app_name: unique identifier of app transfer or unique name of app
611
- def delete(app_transfer_id_or_app_name)
612
- @client.app_transfer.delete(app_transfer_id_or_app_name)
613
- end
614
-
615
- # Info for existing app transfer.
616
- #
617
- # @param app_transfer_id_or_app_name: unique identifier of app transfer or unique name of app
618
- def info(app_transfer_id_or_app_name)
619
- @client.app_transfer.info(app_transfer_id_or_app_name)
620
- end
621
-
622
- # List existing apps transfers.
623
- def list()
624
- @client.app_transfer.list()
625
- end
626
-
627
- # Update an existing app transfer.
628
- #
629
- # @param app_transfer_id_or_app_name: unique identifier of app transfer or unique name of app
630
- # @param body: the object to pass as the request payload
631
- def update(app_transfer_id_or_app_name, body)
632
- @client.app_transfer.update(app_transfer_id_or_app_name, body)
633
- end
634
- end
635
-
636
- # An app represents the program that you would like to deploy and run on Heroku.
637
- class App
638
- def initialize(client)
639
- @client = client
640
- end
641
-
642
- # Create a new app.
643
- #
644
- # @param body: the object to pass as the request payload
645
- def create(body)
646
- @client.app.create(body)
647
- end
648
-
649
- # Delete an existing app.
650
- #
651
- # @param app_id_or_app_name: unique identifier of app or unique name of app
652
- def delete(app_id_or_app_name)
653
- @client.app.delete(app_id_or_app_name)
654
- end
655
-
656
- # Info for existing app.
657
- #
658
- # @param app_id_or_app_name: unique identifier of app or unique name of app
659
- def info(app_id_or_app_name)
660
- @client.app.info(app_id_or_app_name)
661
- end
662
-
663
- # List existing apps.
664
- def list()
665
- @client.app.list()
666
- end
667
-
668
- # Update an existing app.
669
- #
670
- # @param app_id_or_app_name: unique identifier of app or unique name of app
671
- # @param body: the object to pass as the request payload
672
- def update(app_id_or_app_name, body)
673
- @client.app.update(app_id_or_app_name, body)
674
- end
675
- end
676
-
677
- # A build result contains the output from a build.
678
- class BuildResult
679
- def initialize(client)
680
- @client = client
681
- end
682
-
683
- # Info for existing result.
684
- #
685
- # @param app_id_or_app_name: unique identifier of app or unique name of app
686
- # @param build_id: unique identifier of build
687
- def info(app_id_or_app_name, build_id)
688
- @client.build_result.info(app_id_or_app_name, build_id)
689
- end
690
- end
691
-
692
- # A build represents the process of transforming a code tarball into a slug
693
- class Build
694
- def initialize(client)
695
- @client = client
696
- end
697
-
698
- # Create a new build.
699
- #
700
- # @param app_id_or_app_name: unique identifier of app or unique name of app
701
- # @param body: the object to pass as the request payload
702
- def create(app_id_or_app_name, body)
703
- @client.build.create(app_id_or_app_name, body)
704
- end
705
-
706
- # Info for existing build.
707
- #
708
- # @param app_id_or_app_name: unique identifier of app or unique name of app
709
- # @param build_id: unique identifier of build
710
- def info(app_id_or_app_name, build_id)
711
- @client.build.info(app_id_or_app_name, build_id)
712
- end
713
-
714
- # List existing build.
715
- #
716
- # @param app_id_or_app_name: unique identifier of app or unique name of app
717
- def list(app_id_or_app_name)
718
- @client.build.list(app_id_or_app_name)
719
- end
720
- end
721
-
722
- # An buildpack installtion represents a buildpack that will be run against an app.
723
- class BuildpackInstallation
724
- def initialize(client)
725
- @client = client
726
- end
727
-
728
- # Update an app's buildpack installations.
729
- #
730
- # @param app_id_or_app_name: unique identifier of app or unique name of app
731
- # @param body: the object to pass as the request payload
732
- def update(app_id_or_app_name, body)
733
- @client.buildpack_installation.update(app_id_or_app_name, body)
734
- end
735
-
736
- # List an app's existing buildpack installations.
737
- #
738
- # @param app_id_or_app_name: unique identifier of app or unique name of app
739
- def list(app_id_or_app_name)
740
- @client.buildpack_installation.list(app_id_or_app_name)
741
- end
742
- end
743
-
744
- # A collaborator represents an account that has been given access to an app on Heroku.
745
- class Collaborator
746
- def initialize(client)
747
- @client = client
748
- end
749
-
750
- # Create a new collaborator.
751
- #
752
- # @param app_id_or_app_name: unique identifier of app or unique name of app
753
- # @param body: the object to pass as the request payload
754
- def create(app_id_or_app_name, body)
755
- @client.collaborator.create(app_id_or_app_name, body)
756
- end
757
-
758
- # Delete an existing collaborator.
759
- #
760
- # @param app_id_or_app_name: unique identifier of app or unique name of app
761
- # @param collaborator_email_or_collaborator_id: invited email address of collaborator or unique identifier of collaborator
762
- def delete(app_id_or_app_name, collaborator_email_or_collaborator_id)
763
- @client.collaborator.delete(app_id_or_app_name, collaborator_email_or_collaborator_id)
764
- end
765
-
766
- # Info for existing collaborator.
767
- #
768
- # @param app_id_or_app_name: unique identifier of app or unique name of app
769
- # @param collaborator_email_or_collaborator_id: invited email address of collaborator or unique identifier of collaborator
770
- def info(app_id_or_app_name, collaborator_email_or_collaborator_id)
771
- @client.collaborator.info(app_id_or_app_name, collaborator_email_or_collaborator_id)
772
- end
773
-
774
- # List existing collaborators.
775
- #
776
- # @param app_id_or_app_name: unique identifier of app or unique name of app
777
- def list(app_id_or_app_name)
778
- @client.collaborator.list(app_id_or_app_name)
779
- end
780
- end
781
-
782
- # Config Vars allow you to manage the configuration information provided to an app on Heroku.
783
- class ConfigVar
784
- def initialize(client)
785
- @client = client
786
- end
787
-
788
- # Get config-vars for app.
789
- #
790
- # @param app_id_or_app_name: unique identifier of app or unique name of app
791
- def info(app_id_or_app_name)
792
- @client.config_var.info(app_id_or_app_name)
793
- end
794
-
795
- # Update config-vars for app. You can update existing config-vars by setting them again, and remove by setting it to `NULL`.
796
- #
797
- # @param app_id_or_app_name: unique identifier of app or unique name of app
798
- # @param body: the object to pass as the request payload
799
- def update(app_id_or_app_name, body)
800
- @client.config_var.update(app_id_or_app_name, body)
801
- end
802
- end
803
-
804
- # A credit represents value that will be used up before further charges are assigned to an account.
805
- class Credit
806
- def initialize(client)
807
- @client = client
808
- end
809
-
810
- # Create a new credit.
811
- #
812
- # @param body: the object to pass as the request payload
813
- def create(body)
814
- @client.credit.create(body)
815
- end
816
-
817
- # Info for existing credit.
818
- #
819
- # @param credit_id: unique identifier of credit
820
- def info(credit_id)
821
- @client.credit.info(credit_id)
822
- end
823
-
824
- # List existing credits.
825
- def list()
826
- @client.credit.list()
827
- end
828
- end
829
-
830
- # Domains define what web routes should be routed to an app on Heroku.
831
- class Domain
832
- def initialize(client)
833
- @client = client
834
- end
835
-
836
- # Create a new domain.
837
- #
838
- # @param app_id_or_app_name: unique identifier of app or unique name of app
839
- # @param body: the object to pass as the request payload
840
- def create(app_id_or_app_name, body)
841
- @client.domain.create(app_id_or_app_name, body)
842
- end
843
-
844
- # Delete an existing domain
845
- #
846
- # @param app_id_or_app_name: unique identifier of app or unique name of app
847
- # @param domain_id_or_domain_hostname: unique identifier of this domain or full hostname
848
- def delete(app_id_or_app_name, domain_id_or_domain_hostname)
849
- @client.domain.delete(app_id_or_app_name, domain_id_or_domain_hostname)
850
- end
851
-
852
- # Info for existing domain.
853
- #
854
- # @param app_id_or_app_name: unique identifier of app or unique name of app
855
- # @param domain_id_or_domain_hostname: unique identifier of this domain or full hostname
856
- def info(app_id_or_app_name, domain_id_or_domain_hostname)
857
- @client.domain.info(app_id_or_app_name, domain_id_or_domain_hostname)
858
- end
859
-
860
- # List existing domains.
861
- #
862
- # @param app_id_or_app_name: unique identifier of app or unique name of app
863
- def list(app_id_or_app_name)
864
- @client.domain.list(app_id_or_app_name)
865
- end
866
- end
867
-
868
- # Dynos encapsulate running processes of an app on Heroku.
869
- class Dyno
870
- def initialize(client)
871
- @client = client
872
- end
873
-
874
- # Create a new dyno.
875
- #
876
- # @param app_id_or_app_name: unique identifier of app or unique name of app
877
- # @param body: the object to pass as the request payload
878
- def create(app_id_or_app_name, body)
879
- @client.dyno.create(app_id_or_app_name, body)
880
- end
881
-
882
- # Restart dyno.
883
- #
884
- # @param app_id_or_app_name: unique identifier of app or unique name of app
885
- # @param dyno_id_or_dyno_name: unique identifier of this dyno or the name of this process on this dyno
886
- def restart(app_id_or_app_name, dyno_id_or_dyno_name)
887
- @client.dyno.restart(app_id_or_app_name, dyno_id_or_dyno_name)
888
- end
889
-
890
- # Restart all dynos
891
- #
892
- # @param app_id_or_app_name: unique identifier of app or unique name of app
893
- def restart_all(app_id_or_app_name)
894
- @client.dyno.restart_all(app_id_or_app_name)
895
- end
896
-
897
- # Info for existing dyno.
898
- #
899
- # @param app_id_or_app_name: unique identifier of app or unique name of app
900
- # @param dyno_id_or_dyno_name: unique identifier of this dyno or the name of this process on this dyno
901
- def info(app_id_or_app_name, dyno_id_or_dyno_name)
902
- @client.dyno.info(app_id_or_app_name, dyno_id_or_dyno_name)
903
- end
904
-
905
- # List existing dynos.
906
- #
907
- # @param app_id_or_app_name: unique identifier of app or unique name of app
908
- def list(app_id_or_app_name)
909
- @client.dyno.list(app_id_or_app_name)
910
- end
911
- end
912
-
913
- # An event represents an action performed on another API resource.
914
- class Event
915
- def initialize(client)
916
- @client = client
917
- end
918
- end
919
-
920
- # The formation of processes that should be maintained for an app. Update the formation to scale processes or change dyno sizes. Available process type names and commands are defined by the `process_types` attribute for the [slug](#slug) currently released on an app.
921
- class Formation
922
- def initialize(client)
923
- @client = client
924
- end
925
-
926
- # Info for a process type
927
- #
928
- # @param app_id_or_app_name: unique identifier of app or unique name of app
929
- # @param formation_id_or_formation_type: unique identifier of this process type or type of process to maintain
930
- def info(app_id_or_app_name, formation_id_or_formation_type)
931
- @client.formation.info(app_id_or_app_name, formation_id_or_formation_type)
932
- end
933
-
934
- # List process type formation
935
- #
936
- # @param app_id_or_app_name: unique identifier of app or unique name of app
937
- def list(app_id_or_app_name)
938
- @client.formation.list(app_id_or_app_name)
939
- end
940
-
941
- # Batch update process types
942
- #
943
- # @param app_id_or_app_name: unique identifier of app or unique name of app
944
- # @param body: the object to pass as the request payload
945
- def batch_update(app_id_or_app_name, body)
946
- @client.formation.batch_update(app_id_or_app_name, body)
947
- end
948
-
949
- # Update process type
950
- #
951
- # @param app_id_or_app_name: unique identifier of app or unique name of app
952
- # @param formation_id_or_formation_type: unique identifier of this process type or type of process to maintain
953
- # @param body: the object to pass as the request payload
954
- def update(app_id_or_app_name, formation_id_or_formation_type, body)
955
- @client.formation.update(app_id_or_app_name, formation_id_or_formation_type, body)
956
- end
957
- end
958
-
959
- # An invoice is an itemized bill of goods for an account which includes pricing and charges.
960
- class Invoice
961
- def initialize(client)
962
- @client = client
963
- end
964
-
965
- # Info for existing invoice.
966
- #
967
- # @param invoice_number: human readable invoice number
968
- def info(invoice_number)
969
- @client.invoice.info(invoice_number)
970
- end
971
-
972
- # List existing invoices.
973
- def list()
974
- @client.invoice.list()
975
- end
976
- end
977
-
978
- # An invoice address represents the address that should be listed on an invoice.
979
- class InvoiceAddress
980
- def initialize(client)
981
- @client = client
982
- end
983
-
984
- # Retrieve existing invoice address.
985
- def info()
986
- @client.invoice_address.info()
987
- end
988
-
989
- # Update invoice address for an account.
990
- #
991
- # @param body: the object to pass as the request payload
992
- def update(body)
993
- @client.invoice_address.update(body)
994
- end
995
- end
996
-
997
- # Keys represent public SSH keys associated with an account and are used to authorize accounts as they are performing git operations.
998
- class Key
999
- def initialize(client)
1000
- @client = client
1001
- end
1002
-
1003
- # Create a new key.
1004
- #
1005
- # @param body: the object to pass as the request payload
1006
- def create(body)
1007
- @client.key.create(body)
1008
- end
1009
-
1010
- # Delete an existing key
1011
- #
1012
- # @param key_id_or_key_fingerprint: unique identifier of this key or a unique identifying string based on contents
1013
- def delete(key_id_or_key_fingerprint)
1014
- @client.key.delete(key_id_or_key_fingerprint)
1015
- end
1016
-
1017
- # Info for existing key.
1018
- #
1019
- # @param key_id_or_key_fingerprint: unique identifier of this key or a unique identifying string based on contents
1020
- def info(key_id_or_key_fingerprint)
1021
- @client.key.info(key_id_or_key_fingerprint)
1022
- end
1023
-
1024
- # List existing keys.
1025
- def list()
1026
- @client.key.list()
1027
- end
1028
- end
1029
-
1030
- # [Log drains](https://devcenter.heroku.com/articles/log-drains) provide a way to forward your Heroku logs to an external syslog server for long-term archiving. This external service must be configured to receive syslog packets from Heroku, whereupon its URL can be added to an app using this API. Some addons will add a log drain when they are provisioned to an app. These drains can only be removed by removing the add-on.
1031
- class LogDrain
1032
- def initialize(client)
1033
- @client = client
1034
- end
1035
-
1036
- # Create a new log drain.
1037
- #
1038
- # @param app_id_or_app_name: unique identifier of app or unique name of app
1039
- # @param body: the object to pass as the request payload
1040
- def create(app_id_or_app_name, body)
1041
- @client.log_drain.create(app_id_or_app_name, body)
1042
- end
1043
-
1044
- # Delete an existing log drain. Log drains added by add-ons can only be removed by removing the add-on.
1045
- #
1046
- # @param app_id_or_app_name: unique identifier of app or unique name of app
1047
- # @param log_drain_id_or_log_drain_url: unique identifier of this log drain or url associated with the log drain
1048
- def delete(app_id_or_app_name, log_drain_id_or_log_drain_url)
1049
- @client.log_drain.delete(app_id_or_app_name, log_drain_id_or_log_drain_url)
1050
- end
1051
-
1052
- # Info for existing log drain.
1053
- #
1054
- # @param app_id_or_app_name: unique identifier of app or unique name of app
1055
- # @param log_drain_id_or_log_drain_url: unique identifier of this log drain or url associated with the log drain
1056
- def info(app_id_or_app_name, log_drain_id_or_log_drain_url)
1057
- @client.log_drain.info(app_id_or_app_name, log_drain_id_or_log_drain_url)
1058
- end
1059
-
1060
- # List existing log drains.
1061
- #
1062
- # @param app_id_or_app_name: unique identifier of app or unique name of app
1063
- def list(app_id_or_app_name)
1064
- @client.log_drain.list(app_id_or_app_name)
1065
- end
1066
- end
1067
-
1068
- # A log session is a reference to the http based log stream for an app.
1069
- class LogSession
1070
- def initialize(client)
1071
- @client = client
1072
- end
1073
-
1074
- # Create a new log session.
1075
- #
1076
- # @param app_id_or_app_name: unique identifier of app or unique name of app
1077
- # @param body: the object to pass as the request payload
1078
- def create(app_id_or_app_name, body)
1079
- @client.log_session.create(app_id_or_app_name, body)
1080
- end
1081
- end
1082
-
1083
- # OAuth authorizations represent clients that a Heroku user has authorized to automate, customize or extend their usage of the platform. For more information please refer to the [Heroku OAuth documentation](https://devcenter.heroku.com/articles/oauth)
1084
- class OauthAuthorization
1085
- def initialize(client)
1086
- @client = client
1087
- end
1088
-
1089
- # Create a new OAuth authorization.
1090
- #
1091
- # @param body: the object to pass as the request payload
1092
- def create(body)
1093
- @client.oauth_authorization.create(body)
1094
- end
1095
-
1096
- # Delete OAuth authorization.
1097
- #
1098
- # @param oauth_authorization_id: unique identifier of OAuth authorization
1099
- def delete(oauth_authorization_id)
1100
- @client.oauth_authorization.delete(oauth_authorization_id)
1101
- end
1102
-
1103
- # Info for an OAuth authorization.
1104
- #
1105
- # @param oauth_authorization_id: unique identifier of OAuth authorization
1106
- def info(oauth_authorization_id)
1107
- @client.oauth_authorization.info(oauth_authorization_id)
1108
- end
1109
-
1110
- # List OAuth authorizations.
1111
- def list()
1112
- @client.oauth_authorization.list()
1113
- end
1114
-
1115
- # Regenerate OAuth tokens. This endpoint is only available to direct authorizations or privileged OAuth clients.
1116
- #
1117
- # @param oauth_authorization_id: unique identifier of OAuth authorization
1118
- def regenerate(oauth_authorization_id)
1119
- @client.oauth_authorization.regenerate(oauth_authorization_id)
1120
- end
1121
- end
1122
-
1123
- # OAuth clients are applications that Heroku users can authorize to automate, customize or extend their usage of the platform. For more information please refer to the [Heroku OAuth documentation](https://devcenter.heroku.com/articles/oauth).
1124
- class OauthClient
1125
- def initialize(client)
1126
- @client = client
1127
- end
1128
-
1129
- # Create a new OAuth client.
1130
- #
1131
- # @param body: the object to pass as the request payload
1132
- def create(body)
1133
- @client.oauth_client.create(body)
1134
- end
1135
-
1136
- # Delete OAuth client.
1137
- #
1138
- # @param oauth_client_id: unique identifier of this OAuth client
1139
- def delete(oauth_client_id)
1140
- @client.oauth_client.delete(oauth_client_id)
1141
- end
1142
-
1143
- # Info for an OAuth client
1144
- #
1145
- # @param oauth_client_id: unique identifier of this OAuth client
1146
- def info(oauth_client_id)
1147
- @client.oauth_client.info(oauth_client_id)
1148
- end
1149
-
1150
- # List OAuth clients
1151
- def list()
1152
- @client.oauth_client.list()
1153
- end
1154
-
1155
- # Update OAuth client
1156
- #
1157
- # @param oauth_client_id: unique identifier of this OAuth client
1158
- # @param body: the object to pass as the request payload
1159
- def update(oauth_client_id, body)
1160
- @client.oauth_client.update(oauth_client_id, body)
1161
- end
1162
- end
1163
-
1164
- # OAuth grants are used to obtain authorizations on behalf of a user. For more information please refer to the [Heroku OAuth documentation](https://devcenter.heroku.com/articles/oauth)
1165
- class OauthGrant
1166
- def initialize(client)
1167
- @client = client
1168
- end
1169
- end
1170
-
1171
- # OAuth tokens provide access for authorized clients to act on behalf of a Heroku user to automate, customize or extend their usage of the platform. For more information please refer to the [Heroku OAuth documentation](https://devcenter.heroku.com/articles/oauth)
1172
- class OauthToken
1173
- def initialize(client)
1174
- @client = client
1175
- end
1176
-
1177
- # Create a new OAuth token.
1178
- #
1179
- # @param body: the object to pass as the request payload
1180
- def create(body)
1181
- @client.oauth_token.create(body)
1182
- end
1183
- end
1184
-
1185
- # An organization collaborator represents an account that has been given access to an organization app on Heroku.
1186
- class OrganizationAppCollaborator
1187
- def initialize(client)
1188
- @client = client
1189
- end
1190
-
1191
- # Create a new collaborator on an organization app. Use this endpoint instead of the `/apps/{app_id_or_name}/collaborator` endpoint when you want the collaborator to be granted [privileges] (https://devcenter.heroku.com/articles/org-users-access#roles) according to their role in the organization.
1192
- #
1193
- # @param app_id_or_app_name: unique identifier of app or unique name of app
1194
- # @param body: the object to pass as the request payload
1195
- def create(app_id_or_app_name, body)
1196
- @client.organization_app_collaborator.create(app_id_or_app_name, body)
1197
- end
1198
-
1199
- # Delete an existing collaborator from an organization app.
1200
- #
1201
- # @param app_name: unique name of app
1202
- # @param collaborator_email: invited email address of collaborator
1203
- def delete(app_name, collaborator_email)
1204
- @client.organization_app_collaborator.delete(app_name, collaborator_email)
1205
- end
1206
-
1207
- # Info for a collaborator on an organization app.
1208
- #
1209
- # @param app_name: unique name of app
1210
- # @param collaborator_email: invited email address of collaborator
1211
- def info(app_name, collaborator_email)
1212
- @client.organization_app_collaborator.info(app_name, collaborator_email)
1213
- end
1214
-
1215
- # List collaborators on an organization app.
1216
- #
1217
- # @param app_name: unique name of app
1218
- def list(app_name)
1219
- @client.organization_app_collaborator.list(app_name)
1220
- end
1221
- end
1222
-
1223
- # An organization app encapsulates the organization specific functionality of Heroku apps.
1224
- class OrganizationApp
1225
- def initialize(client)
1226
- @client = client
1227
- end
1228
-
1229
- # Create a new app in the specified organization, in the default organization if unspecified, or in personal account, if default organization is not set.
1230
- #
1231
- # @param body: the object to pass as the request payload
1232
- def create(body)
1233
- @client.organization_app.create(body)
1234
- end
1235
-
1236
- # List apps in the default organization, or in personal account, if default organization is not set.
1237
- def list()
1238
- @client.organization_app.list()
1239
- end
1240
-
1241
- # List organization apps.
1242
- #
1243
- # @param organization_name: unique name of organization
1244
- def list_for_organization(organization_name)
1245
- @client.organization_app.list_for_organization(organization_name)
1246
- end
1247
-
1248
- # Info for an organization app.
1249
- #
1250
- # @param app_name: unique name of app
1251
- def info(app_name)
1252
- @client.organization_app.info(app_name)
1253
- end
1254
-
1255
- # Lock or unlock an organization app.
1256
- #
1257
- # @param app_name: unique name of app
1258
- # @param body: the object to pass as the request payload
1259
- def update_locked(app_name, body)
1260
- @client.organization_app.update_locked(app_name, body)
1261
- end
1262
-
1263
- # Transfer an existing organization app to another Heroku account.
1264
- #
1265
- # @param app_name: unique name of app
1266
- # @param body: the object to pass as the request payload
1267
- def transfer_to_account(app_name, body)
1268
- @client.organization_app.transfer_to_account(app_name, body)
1269
- end
1270
-
1271
- # Transfer an existing organization app to another organization.
1272
- #
1273
- # @param app_name: unique name of app
1274
- # @param body: the object to pass as the request payload
1275
- def transfer_to_organization(app_name, body)
1276
- @client.organization_app.transfer_to_organization(app_name, body)
1277
- end
1278
- end
1279
-
1280
- # An organization invoice is an itemized bill of goods for an organization which includes pricing and charges.
1281
- class OrganizationInvoice
1282
- def initialize(client)
1283
- @client = client
1284
- end
1285
-
1286
- # Info for existing invoice.
1287
- #
1288
- # @param organization_name: unique name of organization
1289
- # @param organization_invoice_number: human readable invoice number
1290
- def info(organization_name, organization_invoice_number)
1291
- @client.organization_invoice.info(organization_name, organization_invoice_number)
1292
- end
1293
-
1294
- # List existing invoices.
1295
- #
1296
- # @param organization_name: unique name of organization
1297
- def list(organization_name)
1298
- @client.organization_invoice.list(organization_name)
1299
- end
1300
- end
1301
-
1302
- # An organization member is an individual with access to an organization.
1303
- class OrganizationMember
1304
- def initialize(client)
1305
- @client = client
1306
- end
1307
-
1308
- # Create a new organization member, or update their role.
1309
- #
1310
- # @param organization_name: unique name of organization
1311
- # @param body: the object to pass as the request payload
1312
- def create_or_update(organization_name, body)
1313
- @client.organization_member.create_or_update(organization_name, body)
1314
- end
1315
-
1316
- # Remove a member from the organization.
1317
- #
1318
- # @param organization_name: unique name of organization
1319
- # @param organization_member_email: email address of the organization member
1320
- def delete(organization_name, organization_member_email)
1321
- @client.organization_member.delete(organization_name, organization_member_email)
1322
- end
1323
-
1324
- # List members of the organization.
1325
- #
1326
- # @param organization_name: unique name of organization
1327
- def list(organization_name)
1328
- @client.organization_member.list(organization_name)
1329
- end
1330
- end
1331
-
1332
- # Organizations allow you to manage access to a shared group of applications across your development team.
1333
- class Organization
1334
- def initialize(client)
1335
- @client = client
1336
- end
1337
-
1338
- # List organizations in which you are a member.
1339
- def list()
1340
- @client.organization.list()
1341
- end
1342
-
1343
- # Info for an organization.
1344
- #
1345
- # @param organization_name: unique name of organization
1346
- def info(organization_name)
1347
- @client.organization.info(organization_name)
1348
- end
1349
-
1350
- # Set or unset the organization as your default organization.
1351
- #
1352
- # @param organization_name: unique name of organization
1353
- # @param body: the object to pass as the request payload
1354
- def update(organization_name, body)
1355
- @client.organization.update(organization_name, body)
1356
- end
1357
- end
1358
-
1359
- # This renders a secret that clients can use to build a one-time password to be supplied as a 2nd factor of authentication.
1360
- class OtpSecret
1361
- def initialize(client)
1362
- @client = client
1363
- end
1364
-
1365
- # Create new OTP secret. This invalidates any existing OTP secrets on the account.
1366
- def create()
1367
- @client.otp_secret.create()
1368
- end
1369
- end
1370
-
1371
- # A payment represents money collected for an account
1372
- class Payment
1373
- def initialize(client)
1374
- @client = client
1375
- end
1376
-
1377
- # Create a payment on an existing account
1378
- #
1379
- # @param body: the object to pass as the request payload
1380
- def create(body)
1381
- @client.payment.create(body)
1382
- end
1383
- end
1384
-
1385
- # The on file payment method for an account
1386
- class PaymentMethod
1387
- def initialize(client)
1388
- @client = client
1389
- end
1390
-
1391
- # Update an existing payment method for an account.
1392
- #
1393
- # @param body: the object to pass as the request payload
1394
- def update(body)
1395
- @client.payment_method.update(body)
1396
- end
1397
-
1398
- # Get the current payment method for an account.
1399
- def get()
1400
- @client.payment_method.get()
1401
- end
1402
- end
1403
-
1404
- # Plans represent different configurations of add-ons that may be added to apps. Endpoints under add-on services can be accessed without authentication.
1405
- class Plan
1406
- def initialize(client)
1407
- @client = client
1408
- end
1409
-
1410
- # Info for existing plan.
1411
- #
1412
- # @param addon_service_id_or_addon_service_name: unique identifier of this addon-service or unique name of this addon-service
1413
- # @param plan_id_or_plan_name: unique identifier of this plan or unique name of this plan
1414
- def info(addon_service_id_or_addon_service_name, plan_id_or_plan_name)
1415
- @client.plan.info(addon_service_id_or_addon_service_name, plan_id_or_plan_name)
1416
- end
1417
-
1418
- # List existing plans.
1419
- #
1420
- # @param addon_service_id_or_addon_service_name: unique identifier of this addon-service or unique name of this addon-service
1421
- def list(addon_service_id_or_addon_service_name)
1422
- @client.plan.list(addon_service_id_or_addon_service_name)
1423
- end
1424
- end
1425
-
1426
- # Rate Limit represents the number of request tokens each account holds. Requests to this endpoint do not count towards the rate limit.
1427
- class RateLimit
1428
- def initialize(client)
1429
- @client = client
1430
- end
1431
-
1432
- # Info for rate limits.
1433
- def info()
1434
- @client.rate_limit.info()
1435
- end
1436
- end
1437
-
1438
- # Recovery codes grant access to accounts with two-factor authentication enabled.
1439
- class RecoveryCode
1440
- def initialize(client)
1441
- @client = client
1442
- end
1443
-
1444
- # Generate new recovery codes. This invalidates any existing codes on the account.
1445
- def create()
1446
- @client.recovery_code.create()
1447
- end
1448
- end
1449
-
1450
- # A region represents a geographic location in which your application may run.
1451
- class Region
1452
- def initialize(client)
1453
- @client = client
1454
- end
1455
-
1456
- # Info for existing region.
1457
- #
1458
- # @param region_id_or_region_name: unique identifier of region or unique name of region
1459
- def info(region_id_or_region_name)
1460
- @client.region.info(region_id_or_region_name)
1461
- end
1462
-
1463
- # List existing regions.
1464
- def list()
1465
- @client.region.list()
1466
- end
1467
- end
1468
-
1469
- # A release represents a combination of code, config vars and add-ons for an app on Heroku.
1470
- class Release
1471
- def initialize(client)
1472
- @client = client
1473
- end
1474
-
1475
- # Info for existing release.
1476
- #
1477
- # @param app_id_or_app_name: unique identifier of app or unique name of app
1478
- # @param release_id_or_release_version: unique identifier of release or unique version assigned to the release
1479
- def info(app_id_or_app_name, release_id_or_release_version)
1480
- @client.release.info(app_id_or_app_name, release_id_or_release_version)
1481
- end
1482
-
1483
- # List existing releases.
1484
- #
1485
- # @param app_id_or_app_name: unique identifier of app or unique name of app
1486
- def list(app_id_or_app_name)
1487
- @client.release.list(app_id_or_app_name)
1488
- end
1489
-
1490
- # Create new release. The API cannot be used to create releases on Bamboo apps.
1491
- #
1492
- # @param app_id_or_app_name: unique identifier of app or unique name of app
1493
- # @param body: the object to pass as the request payload
1494
- def create(app_id_or_app_name, body)
1495
- @client.release.create(app_id_or_app_name, body)
1496
- end
1497
-
1498
- # Rollback to an existing release.
1499
- #
1500
- # @param app_id_or_app_name: unique identifier of app or unique name of app
1501
- # @param body: the object to pass as the request payload
1502
- def rollback(app_id_or_app_name, body)
1503
- @client.release.rollback(app_id_or_app_name, body)
1504
- end
1505
- end
1506
-
1507
- # A slug is a snapshot of your application code that is ready to run on the platform.
1508
- class Slug
1509
- def initialize(client)
1510
- @client = client
1511
- end
1512
-
1513
- # Info for existing slug.
1514
- #
1515
- # @param app_id_or_app_name: unique identifier of app or unique name of app
1516
- # @param slug_id: unique identifier of slug
1517
- def info(app_id_or_app_name, slug_id)
1518
- @client.slug.info(app_id_or_app_name, slug_id)
1519
- end
1520
-
1521
- # Create a new slug. For more information please refer to [Deploying Slugs using the Platform API](https://devcenter.heroku.com/articles/platform-api-deploying-slugs?preview=1).
1522
- #
1523
- # @param app_id_or_app_name: unique identifier of app or unique name of app
1524
- # @param body: the object to pass as the request payload
1525
- def create(app_id_or_app_name, body)
1526
- @client.slug.create(app_id_or_app_name, body)
1527
- end
1528
- end
1529
-
1530
- # A source is a location for uploading and downloading an application's source code.
1531
- class Source
1532
- def initialize(client)
1533
- @client = client
1534
- end
1535
-
1536
- # Create URLs for uploading and downloading source.
1537
- #
1538
- # @param app_id_or_app_name: unique identifier of app or unique name of app
1539
- def create(app_id_or_app_name)
1540
- @client.source.create(app_id_or_app_name)
1541
- end
1542
- end
1543
-
1544
- # [SSL Endpoint](https://devcenter.heroku.com/articles/ssl-endpoint) is a public address serving custom SSL cert for HTTPS traffic to a Heroku app. Note that an app must have the `ssl:endpoint` addon installed before it can provision an SSL Endpoint using these APIs.
1545
- class SSLEndpoint
1546
- def initialize(client)
1547
- @client = client
1548
- end
1549
-
1550
- # Create a new SSL endpoint.
1551
- #
1552
- # @param app_id_or_app_name: unique identifier of app or unique name of app
1553
- # @param body: the object to pass as the request payload
1554
- def create(app_id_or_app_name, body)
1555
- @client.ssl_endpoint.create(app_id_or_app_name, body)
1556
- end
1557
-
1558
- # Delete existing SSL endpoint.
1559
- #
1560
- # @param app_id_or_app_name: unique identifier of app or unique name of app
1561
- # @param ssl_endpoint_id_or_ssl_endpoint_name: unique identifier of this SSL endpoint or unique name for SSL endpoint
1562
- def delete(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name)
1563
- @client.ssl_endpoint.delete(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name)
1564
- end
1565
-
1566
- # Info for existing SSL endpoint.
1567
- #
1568
- # @param app_id_or_app_name: unique identifier of app or unique name of app
1569
- # @param ssl_endpoint_id_or_ssl_endpoint_name: unique identifier of this SSL endpoint or unique name for SSL endpoint
1570
- def info(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name)
1571
- @client.ssl_endpoint.info(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name)
1572
- end
1573
-
1574
- # List existing SSL endpoints.
1575
- #
1576
- # @param app_id_or_app_name: unique identifier of app or unique name of app
1577
- def list(app_id_or_app_name)
1578
- @client.ssl_endpoint.list(app_id_or_app_name)
1579
- end
1580
-
1581
- # Update an existing SSL endpoint.
1582
- #
1583
- # @param app_id_or_app_name: unique identifier of app or unique name of app
1584
- # @param ssl_endpoint_id_or_ssl_endpoint_name: unique identifier of this SSL endpoint or unique name for SSL endpoint
1585
- # @param body: the object to pass as the request payload
1586
- def update(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name, body)
1587
- @client.ssl_endpoint.update(app_id_or_app_name, ssl_endpoint_id_or_ssl_endpoint_name, body)
1588
- end
1589
- end
1590
-
1591
- # Stacks are the different application execution environments available in the Heroku platform.
1592
- class Stack
1593
- def initialize(client)
1594
- @client = client
1595
- end
1596
-
1597
- # Stack info.
1598
- #
1599
- # @param stack_name_or_stack_id: unique name of stack or unique identifier of stack
1600
- def info(stack_name_or_stack_id)
1601
- @client.stack.info(stack_name_or_stack_id)
1602
- end
1603
-
1604
- # List available stacks.
1605
- def list()
1606
- @client.stack.list()
1607
- end
1608
- end
1609
-
1610
- # An account feature represents a Heroku labs capability that can be enabled or disabled for an account on Heroku.
1611
- class AccountFeature
1612
- def initialize(client)
1613
- @client = client
1614
- end
1615
-
1616
- # Info for an existing account feature.
1617
- #
1618
- # @param account_feature_id_or_account_feature_name: unique identifier of account feature or unique name of account feature
1619
- def info(account_feature_id_or_account_feature_name)
1620
- @client.account_feature.info(account_feature_id_or_account_feature_name)
1621
- end
1622
-
1623
- # List existing account features.
1624
- def list()
1625
- @client.account_feature.list()
1626
- end
1627
-
1628
- # Update an existing account feature.
1629
- #
1630
- # @param account_feature_id_or_account_feature_name: unique identifier of account feature or unique name of account feature
1631
- # @param body: the object to pass as the request payload
1632
- def update(account_feature_id_or_account_feature_name, body)
1633
- @client.account_feature.update(account_feature_id_or_account_feature_name, body)
1634
- end
1635
- end
1636
-
1637
- # Tracks a user's preferences and message dismissals
1638
- class UserPreferences
1639
- def initialize(client)
1640
- @client = client
1641
- end
1642
-
1643
- # Retrieve User Preferences
1644
- def user_preferences()
1645
- @client.user_preferences.user_preferences()
1646
- end
1647
-
1648
- # Update User Preferences
1649
- #
1650
- # @param body: the object to pass as the request payload
1651
- def update(body)
1652
- @client.user_preferences.update(body)
1653
- end
1654
- end
1655
-
1656
- # An account represents an individual signed up to use the Heroku platform.
1657
- class Account
1658
- def initialize(client)
1659
- @client = client
1660
- end
1661
-
1662
- # Info for account.
1663
- #
1664
- # @param account_email_or_account_id: unique email address of account or unique identifier of an account
1665
- def info(account_email_or_account_id)
1666
- @client.account.info(account_email_or_account_id)
1667
- end
1668
-
1669
- # Update account.
1670
- #
1671
- # @param account_email_or_account_id: unique email address of account or unique identifier of an account
1672
- # @param body: the object to pass as the request payload
1673
- def update(account_email_or_account_id, body)
1674
- @client.account.update(account_email_or_account_id, body)
1675
- end
1676
-
1677
- # Change Email for account.
1678
- #
1679
- # @param account_email_or_account_id: unique email address of account or unique identifier of an account
1680
- # @param body: the object to pass as the request payload
1681
- def change_email(account_email_or_account_id, body)
1682
- @client.account.change_email(account_email_or_account_id, body)
1683
- end
1684
-
1685
- # Change Password for account.
1686
- #
1687
- # @param account_email_or_account_id: unique email address of account or unique identifier of an account
1688
- # @param body: the object to pass as the request payload
1689
- def change_password(account_email_or_account_id, body)
1690
- @client.account.change_password(account_email_or_account_id, body)
1691
- end
1692
-
1693
- # Delete account. Note that this action cannot be undone.
1694
- #
1695
- # @param account_email_or_account_id: unique email address of account or unique identifier of an account
1696
- def delete(account_email_or_account_id)
1697
- @client.account.delete(account_email_or_account_id)
1698
- end
1699
- end
1700
-
1701
- SCHEMA = Heroics::Schema.new(MultiJson.load(<<-'HEROICS_SCHEMA'))
1702
- {"$schema":"http://interagent.github.io/interagent-hyper-schema","type":["object"],"definitions":{"addon-attachment":{"description":"An add-on attachment represents a connection between an app and an add-on that it has been given access to.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"prototype","strictProperties":true,"title":"Heroku Platform API - Add-on Attachment","type":["object"],"definitions":{"created_at":{"description":"when add-on attachment was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"id":{"description":"unique identifier of this add-on attachment","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"force":{"default":false,"description":"whether or not to allow existing attachment with same name to be replaced","example":false,"readOnly":false,"type":["boolean"]},"identity":{"anyOf":[{"$ref":"#/definitions/addon-attachment/definitions/id"}]},"scopedIdentity":{"anyOf":[{"$ref":"#/definitions/addon-attachment/definitions/id"},{"$ref":"#/definitions/addon-attachment/definitions/name"}]},"name":{"description":"unique name for this add-on attachment to this app","example":"DATABASE","readOnly":true,"type":["string"]},"updated_at":{"description":"when add-on attachment was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]}},"links":[{"description":"Create a new add-on attachment.","href":"/addon-attachments","method":"POST","rel":"create","schema":{"properties":{"addon":{"$ref":"#/definitions/addon/definitions/identity"},"app":{"$ref":"#/definitions/app/definitions/identity"},"force":{"$ref":"#/definitions/addon-attachment/definitions/force"},"name":{"$ref":"#/definitions/addon-attachment/definitions/name"}},"required":["addon","app"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/addon-attachment"},"title":"Create"},{"description":"Delete an existing add-on attachment.","href":"/addon-attachments/{(%23%2Fdefinitions%2Faddon-attachment%2Fdefinitions%2Fidentity)}","method":"DELETE","rel":"destroy","targetSchema":{"$ref":"#/definitions/addon-attachment"},"title":"Delete"},{"description":"Info for existing add-on attachment.","href":"/addon-attachments/{(%23%2Fdefinitions%2Faddon-attachment%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/addon-attachment"},"title":"Info"},{"description":"List existing add-on attachments.","href":"/addon-attachments","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/addon-attachment"},"type":["array"]},"title":"List"},{"description":"List existing add-on attachments for an add-on.","href":"/addons/{(%23%2Fdefinitions%2Faddon%2Fdefinitions%2Fidentity)}/addon-attachments","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/addon-attachment"},"type":["array"]},"title":"List by Add-on"},{"description":"List existing add-on attachments for an app.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/addon-attachments","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/addon-attachment"},"type":["array"]},"title":"List by App"},{"description":"Info for existing add-on attachment for an app.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/addon-attachments/{(%23%2Fdefinitions%2Faddon-attachment%2Fdefinitions%2FscopedIdentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/addon-attachment"},"title":"Info by App"}],"properties":{"addon":{"description":"identity of add-on","properties":{"id":{"$ref":"#/definitions/addon/definitions/id"},"name":{"$ref":"#/definitions/addon/definitions/name"},"app":{"description":"billing application associated with this add-on","type":["object"],"properties":{"id":{"$ref":"#/definitions/app/definitions/id"},"name":{"$ref":"#/definitions/app/definitions/name"}},"strictProperties":true}},"strictProperties":true,"type":["object"]},"app":{"description":"application that is attached to add-on","properties":{"id":{"$ref":"#/definitions/app/definitions/id"},"name":{"$ref":"#/definitions/app/definitions/name"}},"strictProperties":true,"type":["object"]},"created_at":{"$ref":"#/definitions/addon-attachment/definitions/created_at"},"id":{"$ref":"#/definitions/addon-attachment/definitions/id"},"name":{"$ref":"#/definitions/addon-attachment/definitions/name"},"updated_at":{"$ref":"#/definitions/addon-attachment/definitions/updated_at"}}},"addon-service":{"description":"Add-on services represent add-ons that may be provisioned for apps. Endpoints under add-on services can be accessed without authentication.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - Add-on Service","type":["object"],"definitions":{"created_at":{"description":"when addon-service was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"human_name":{"description":"human-readable name of the addon service provider","example":"Heroku Postgres","readOnly":true,"type":["string"]},"id":{"description":"unique identifier of this addon-service","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/addon-service/definitions/id"},{"$ref":"#/definitions/addon-service/definitions/name"}]},"name":{"description":"unique name of this addon-service","example":"heroku-postgresql","readOnly":true,"type":["string"]},"state":{"description":"release status for add-on service","enum":["alpha","beta","ga","shutdown"],"example":"ga","readOnly":true,"type":["string"]},"updated_at":{"description":"when addon-service was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]}},"links":[{"description":"Info for existing addon-service.","href":"/addon-services/{(%23%2Fdefinitions%2Faddon-service%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/addon-service"},"title":"Info"},{"description":"List existing addon-services.","href":"/addon-services","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/addon-service"},"type":["array"]},"title":"List"}],"properties":{"created_at":{"$ref":"#/definitions/addon-service/definitions/created_at"},"human_name":{"$ref":"#/definitions/addon-service/definitions/human_name"},"id":{"$ref":"#/definitions/addon-service/definitions/id"},"name":{"$ref":"#/definitions/addon-service/definitions/name"},"state":{"$ref":"#/definitions/addon-service/definitions/state"},"updated_at":{"$ref":"#/definitions/addon-service/definitions/updated_at"}}},"addon":{"description":"Add-ons represent add-ons that have been provisioned for an app.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - Add-on","type":["object"],"definitions":{"config_vars":{"description":"config vars exposed to the owning app by this add-on","example":["FOO","BAZ"],"items":{"type":["string"]},"readOnly":true,"type":["array"]},"created_at":{"description":"when add-on was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"id":{"description":"unique identifier of add-on","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/addon/definitions/id"},{"$ref":"#/definitions/addon/definitions/name"}]},"name":{"description":"globally unique name of the add-on","example":"acme-inc-primary-database","pattern":"^[a-zA-Z][A-Za-z0-9_-]+$","readOnly":true,"type":["string"]},"provider_id":{"description":"id of this add-on with its provider","example":"abcd1234","readOnly":true,"type":["string"]},"updated_at":{"description":"when add-on was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"web_url":{"description":"URL for logging into web interface of add-on (e.g. a dashboard)","example":"https://postgres.heroku.com/databases/01234567-89ab-cdef-0123-456789abcdef","format":"uri","readOnly":true,"type":["null","string"]}},"links":[{"description":"Create a new add-on.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/addons","method":"POST","rel":"create","schema":{"properties":{"attachment":{"description":"name for add-on's initial attachment","example":{"name":"DATABASE_FOLLOWER"},"name":{"$ref":"#/definitions/addon-attachment/definitions/name"},"type":["object"]},"config":{"additionalProperties":false,"description":"custom add-on provisioning options","example":{"db-version":"1.2.3"},"patternProperties":{"^\\w+$":{"type":["string"]}},"type":["object"]},"plan":{"$ref":"#/definitions/plan/definitions/identity"}},"required":["plan"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/addon"},"title":"Create"},{"description":"Delete an existing add-on.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/addons/{(%23%2Fdefinitions%2Faddon%2Fdefinitions%2Fidentity)}","method":"DELETE","rel":"destroy","targetSchema":{"$ref":"#/definitions/addon"},"title":"Delete"},{"description":"Info for an existing add-on.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/addons/{(%23%2Fdefinitions%2Faddon%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/addon"},"title":"Info"},{"description":"List all existing add-ons.","href":"/addons","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/addon"},"type":["array"]},"title":"List"},{"description":"Info for an existing add-on.","href":"/addons/{(%23%2Fdefinitions%2Faddon%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/addon"},"title":"Info"},{"description":"List existing add-ons for an app.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/addons","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/addon"},"type":["array"]},"title":"List by App"},{"description":"Change add-on plan. Some add-ons may not support changing plans. In that case, an error will be returned.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/addons/{(%23%2Fdefinitions%2Faddon%2Fdefinitions%2Fidentity)}","method":"PATCH","rel":"update","schema":{"properties":{"plan":{"$ref":"#/definitions/plan/definitions/identity"}},"required":["plan"],"type":["object"]},"title":"Update"}],"properties":{"addon_service":{"description":"identity of add-on service","properties":{"id":{"$ref":"#/definitions/addon-service/definitions/id"},"name":{"$ref":"#/definitions/addon-service/definitions/name"}},"strictProperties":true,"type":["object"]},"app":{"description":"billing application associated with this add-on","type":["object"],"properties":{"id":{"$ref":"#/definitions/app/definitions/id"},"name":{"$ref":"#/definitions/app/definitions/name"}},"strictProperties":true},"config_vars":{"$ref":"#/definitions/addon/definitions/config_vars"},"created_at":{"$ref":"#/definitions/addon/definitions/created_at"},"id":{"$ref":"#/definitions/addon/definitions/id"},"name":{"$ref":"#/definitions/addon/definitions/name"},"plan":{"description":"identity of add-on plan","properties":{"id":{"$ref":"#/definitions/plan/definitions/id"},"name":{"$ref":"#/definitions/plan/definitions/name"}},"strictProperties":true,"type":["object"]},"provider_id":{"$ref":"#/definitions/addon/definitions/provider_id"},"updated_at":{"$ref":"#/definitions/addon/definitions/updated_at"},"web_url":{"$ref":"#/definitions/addon/definitions/web_url"}}},"app-feature":{"description":"An app feature represents a Heroku labs capability that can be enabled or disabled for an app on Heroku.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - App Feature","type":["object"],"definitions":{"created_at":{"description":"when app feature was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"description":{"description":"description of app feature","example":"Causes app to example.","readOnly":true,"type":["string"]},"doc_url":{"description":"documentation URL of app feature","example":"http://devcenter.heroku.com/articles/example","readOnly":true,"type":["string"]},"enabled":{"description":"whether or not app feature has been enabled","example":true,"readOnly":false,"type":["boolean"]},"id":{"description":"unique identifier of app feature","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/app-feature/definitions/id"},{"$ref":"#/definitions/app-feature/definitions/name"}]},"name":{"description":"unique name of app feature","example":"name","readOnly":true,"type":["string"]},"state":{"description":"state of app feature","example":"public","readOnly":true,"type":["string"]},"updated_at":{"description":"when app feature was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]}},"links":[{"description":"Info for an existing app feature.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/features/{(%23%2Fdefinitions%2Fapp-feature%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/app-feature"},"title":"Info"},{"description":"List existing app features.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/features","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/app-feature"},"type":["array"]},"title":"List"},{"description":"Update an existing app feature.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/features/{(%23%2Fdefinitions%2Fapp-feature%2Fdefinitions%2Fidentity)}","method":"PATCH","rel":"update","schema":{"properties":{"enabled":{"$ref":"#/definitions/app-feature/definitions/enabled"}},"required":["enabled"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/app-feature"},"title":"Update"}],"properties":{"created_at":{"$ref":"#/definitions/app-feature/definitions/created_at"},"description":{"$ref":"#/definitions/app-feature/definitions/description"},"doc_url":{"$ref":"#/definitions/app-feature/definitions/doc_url"},"enabled":{"$ref":"#/definitions/app-feature/definitions/enabled"},"id":{"$ref":"#/definitions/app-feature/definitions/id"},"name":{"$ref":"#/definitions/app-feature/definitions/name"},"state":{"$ref":"#/definitions/app-feature/definitions/state"},"updated_at":{"$ref":"#/definitions/app-feature/definitions/updated_at"}}},"app-setup":{"description":"An app setup represents an app on Heroku that is setup using an environment, addons, and scripts described in an app.json manifest file.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Setup API - App Setup","type":["object"],"definitions":{"id":{"description":"unique identifier of app setup","example":"01234567-89ab-cdef-0123-456789abcdef","readOnly":true,"type":["string"],"format":"uuid"},"identity":{"anyOf":[{"$ref":"#/definitions/app-setup/definitions/id"}]},"created_at":{"description":"when app setup was created","example":"2012-01-01T12:00:00Z","readOnly":true,"type":["string"],"format":"date-time"},"updated_at":{"description":"when app setup was updated","example":"2012-01-01T12:00:00Z","readOnly":true,"type":["string"],"format":"date-time"},"status":{"description":"the overall status of app setup","example":"succeeded","enum":["failed","pending","succeeded"],"readOnly":true,"type":["string"]},"resolved_success_url":{"description":"fully qualified success url","example":"https://example.herokuapp.com/welcome","readOnly":true,"type":["string","null"]},"failure_message":{"description":"reason that app setup has failed","example":"invalid app.json","readOnly":true,"type":["string","null"]},"manifest_errors":{"description":"errors associated with invalid app.json manifest file","example":["config var FOO is required"],"readOnly":true,"items":{"type":["string"]},"type":["array"]},"postdeploy":{"description":"result of postdeploy script","type":["object","null"],"properties":{"output":{"description":"output of the postdeploy script","example":"assets precompiled","readOnly":true,"type":["string"]},"exit_code":{"description":"The exit code of the postdeploy script","example":1,"readOnly":true,"type":["integer"]}},"readOnly":true}},"properties":{"id":{"$ref":"#/definitions/app-setup/definitions/id"},"created_at":{"$ref":"#/definitions/app-setup/definitions/created_at"},"updated_at":{"$ref":"#/definitions/app-setup/definitions/updated_at"},"status":{"$ref":"#/definitions/app-setup/definitions/status"},"failure_message":{"$ref":"#/definitions/app-setup/definitions/failure_message"},"app":{"description":"identity of app","strictProperties":true,"type":["object"],"properties":{"id":{"$ref":"#/definitions/app/definitions/id"},"name":{"$ref":"#/definitions/app/definitions/name"}}},"build":{"description":"identity and status of build","strictProperties":true,"type":["object"],"properties":{"id":{"$ref":"#/definitions/build/definitions/id"},"status":{"$ref":"#/definitions/build/definitions/status"}}},"manifest_errors":{"$ref":"#/definitions/app-setup/definitions/manifest_errors"},"postdeploy":{"$ref":"#/definitions/app-setup/definitions/postdeploy"},"resolved_success_url":{"$ref":"#/definitions/app-setup/definitions/resolved_success_url"}},"links":[{"description":"Create a new app setup from a gzipped tar archive containing an app.json manifest file.","title":"Create","rel":"create","method":"POST","href":"/app-setups","schema":{"required":["source_blob"],"type":["object"],"properties":{"app":{"description":"optional parameters for created app","properties":{"locked":{"$ref":"#/definitions/organization-app/definitions/locked"},"name":{"$ref":"#/definitions/app/definitions/name"},"organization":{"$ref":"#/definitions/organization/definitions/name"},"personal":{"$ref":"#/definitions/organization-app/definitions/personal"},"region":{"$ref":"#/definitions/region/definitions/name"},"stack":{"$ref":"#/definitions/stack/definitions/name"}},"type":["object"]},"source_blob":{"description":"gzipped tarball of source code containing app.json manifest file","example":"https://example.com/source.tgz?token=xyz","properties":{"url":{"description":"URL of gzipped tarball of source code containing app.json manifest file","example":"https://example.com/source.tgz?token=xyz","readOnly":true,"type":["string"]}},"type":["object"]},"overrides":{"description":"overrides of keys in the app.json manifest file","example":{"env":{"FOO":"bar","BAZ":"qux"}},"properties":{"env":{"description":"overrides of the env specified in the app.json manifest file","example":{"FOO":"bar","BAZ":"qux"},"readOnly":true,"additionalProperties":false,"patternProperties":{"^\\w+$":{"type":["string"]}},"type":["object"]}},"type":["object"]}}},"targetSchema":{"$ref":"#/definitions/app-setup"}},{"description":"Get the status of an app setup.","title":"Info","rel":"self","method":"GET","href":"/app-setups/{(%23%2Fdefinitions%2Fapp-setup%2Fdefinitions%2Fidentity)}","targetSchema":{"$ref":"#/definitions/app-setup"}}]},"app-transfer":{"description":"An app transfer represents a two party interaction for transferring ownership of an app.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - App Transfer","type":["object"],"definitions":{"created_at":{"description":"when app transfer was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"id":{"description":"unique identifier of app transfer","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/app-transfer/definitions/id"},{"$ref":"#/definitions/app/definitions/name"}]},"state":{"description":"the current state of an app transfer","enum":["pending","accepted","declined"],"example":"pending","readOnly":true,"type":["string"]},"updated_at":{"description":"when app transfer was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]}},"links":[{"description":"Create a new app transfer.","href":"/account/app-transfers","method":"POST","rel":"create","schema":{"properties":{"app":{"$ref":"#/definitions/app/definitions/identity"},"recipient":{"$ref":"#/definitions/account/definitions/identity"}},"required":["app","recipient"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/app-transfer"},"title":"Create"},{"description":"Delete an existing app transfer","href":"/account/app-transfers/{(%23%2Fdefinitions%2Fapp-transfer%2Fdefinitions%2Fidentity)}","method":"DELETE","rel":"destroy","targetSchema":{"$ref":"#/definitions/app-transfer"},"title":"Delete"},{"description":"Info for existing app transfer.","href":"/account/app-transfers/{(%23%2Fdefinitions%2Fapp-transfer%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/app-transfer"},"title":"Info"},{"description":"List existing apps transfers.","href":"/account/app-transfers","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/app-transfer"},"type":["array"]},"title":"List"},{"description":"Update an existing app transfer.","href":"/account/app-transfers/{(%23%2Fdefinitions%2Fapp-transfer%2Fdefinitions%2Fidentity)}","method":"PATCH","rel":"update","schema":{"properties":{"state":{"$ref":"#/definitions/app-transfer/definitions/state"}},"required":["state"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/app-transfer"},"title":"Update"}],"properties":{"app":{"description":"app involved in the transfer","properties":{"name":{"$ref":"#/definitions/app/definitions/name"},"id":{"$ref":"#/definitions/app/definitions/id"}},"type":["object"]},"created_at":{"$ref":"#/definitions/app-transfer/definitions/created_at"},"id":{"$ref":"#/definitions/app-transfer/definitions/id"},"owner":{"description":"identity of the owner of the transfer","properties":{"email":{"$ref":"#/definitions/account/definitions/email"},"id":{"$ref":"#/definitions/account/definitions/id"}},"strictProperties":true,"type":["object"]},"recipient":{"description":"identity of the recipient of the transfer","properties":{"email":{"$ref":"#/definitions/account/definitions/email"},"id":{"$ref":"#/definitions/account/definitions/id"}},"strictProperties":true,"type":["object"]},"state":{"$ref":"#/definitions/app-transfer/definitions/state"},"updated_at":{"$ref":"#/definitions/app-transfer/definitions/updated_at"}}},"app":{"description":"An app represents the program that you would like to deploy and run on Heroku.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - App","type":["object"],"definitions":{"archived_at":{"description":"when app was archived","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["null","string"]},"buildpack_provided_description":{"description":"description from buildpack of app","example":"Ruby/Rack","readOnly":true,"type":["null","string"]},"created_at":{"description":"when app was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"git_url":{"description":"git repo URL of app","example":"git@heroku.com:example.git","pattern":"^git@heroku\\.com:[a-z][a-z0-9-]{2,29}\\.git$","readOnly":true,"type":["string"]},"id":{"description":"unique identifier of app","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/app/definitions/id"},{"$ref":"#/definitions/app/definitions/name"}]},"maintenance":{"default":false,"description":"maintenance status of app","example":false,"readOnly":false,"type":["boolean"]},"name":{"description":"unique name of app","example":"example","pattern":"^[a-z][a-z0-9-]{3,30}$","readOnly":false,"type":["string"]},"released_at":{"default":null,"description":"when app was released","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["null","string"]},"repo_size":{"default":null,"description":"git repo size in bytes of app","example":0,"readOnly":true,"type":["integer","null"]},"slug_size":{"default":null,"description":"slug size in bytes of app","example":0,"readOnly":true,"type":["integer","null"]},"updated_at":{"description":"when app was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"web_url":{"description":"web URL of app","example":"https://example.herokuapp.com/","format":"uri","pattern":"^https://[a-z][a-z0-9-]{3,30}\\.herokuapp\\.com/$","readOnly":true,"type":["string"]}},"links":[{"description":"Create a new app.","href":"/apps","method":"POST","rel":"create","schema":{"properties":{"name":{"$ref":"#/definitions/app/definitions/name"},"region":{"$ref":"#/definitions/region/definitions/identity"},"stack":{"$ref":"#/definitions/stack/definitions/identity"}},"type":["object"]},"targetSchema":{"$ref":"#/definitions/app"},"title":"Create"},{"description":"Delete an existing app.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}","method":"DELETE","rel":"destroy","targetSchema":{"$ref":"#/definitions/app"},"title":"Delete"},{"description":"Info for existing app.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/app"},"title":"Info"},{"description":"List existing apps.","href":"/apps","method":"GET","ranges":["id","name","updated_at"],"rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/app"},"type":["array"]},"title":"List"},{"description":"Update an existing app.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}","method":"PATCH","rel":"update","schema":{"properties":{"build_stack":{"$ref":"#/definitions/stack/definitions/identity"},"maintenance":{"$ref":"#/definitions/app/definitions/maintenance"},"name":{"$ref":"#/definitions/app/definitions/name"}},"type":["object"]},"targetSchema":{"$ref":"#/definitions/app"},"title":"Update"}],"properties":{"archived_at":{"$ref":"#/definitions/app/definitions/archived_at"},"buildpack_provided_description":{"$ref":"#/definitions/app/definitions/buildpack_provided_description"},"build_stack":{"description":"identity of the stack that will be used for new builds","properties":{"id":{"$ref":"#/definitions/stack/definitions/id"},"name":{"$ref":"#/definitions/stack/definitions/name"}},"strictProperties":true,"type":["object"]},"created_at":{"$ref":"#/definitions/app/definitions/created_at"},"git_url":{"$ref":"#/definitions/app/definitions/git_url"},"id":{"$ref":"#/definitions/app/definitions/id"},"maintenance":{"$ref":"#/definitions/app/definitions/maintenance"},"name":{"$ref":"#/definitions/app/definitions/name"},"owner":{"description":"identity of app owner","properties":{"email":{"$ref":"#/definitions/account/definitions/email"},"id":{"$ref":"#/definitions/account/definitions/id"}},"strictProperties":true,"type":["object"]},"region":{"description":"identity of app region","properties":{"id":{"$ref":"#/definitions/region/definitions/id"},"name":{"$ref":"#/definitions/region/definitions/name"}},"strictProperties":true,"type":["object"]},"released_at":{"$ref":"#/definitions/app/definitions/released_at"},"repo_size":{"$ref":"#/definitions/app/definitions/repo_size"},"slug_size":{"$ref":"#/definitions/app/definitions/slug_size"},"stack":{"description":"identity of app stack","properties":{"id":{"$ref":"#/definitions/stack/definitions/id"},"name":{"$ref":"#/definitions/stack/definitions/name"}},"strictProperties":true,"type":["object"]},"updated_at":{"$ref":"#/definitions/app/definitions/updated_at"},"web_url":{"$ref":"#/definitions/app/definitions/web_url"}}},"build-result":{"$schema":"http://json-schema.org/draft-04/hyper-schema","description":"A build result contains the output from a build.","title":"Heroku Build API - Build Result","stability":"production","strictProperties":true,"type":["object"],"definitions":{"identity":{},"exit_code":{"description":"status from the build","example":0,"readOnly":true,"type":["number"]},"line":{"description":"a single line of output to STDOUT or STDERR from the build.","strictProperties":true,"type":["object"],"example":{"stream":"STDOUT","line":"-----> Ruby app detected\n"},"readOnly":true,"definitions":{"stream":{"type":["string"],"enum":["STDOUT","STDERR"],"description":"The output stream where the line was sent.","example":"STDOUT","readOnly":true},"line":{"type":["string"],"example":"-----> Ruby app detected\n","readOnly":true,"description":"A line of output from the build."}},"properties":{"stream":{"$ref":"#/definitions/build-result/definitions/line/definitions/stream"},"line":{"$ref":"#/definitions/build-result/definitions/line/definitions/line"}}}},"links":[{"description":"Info for existing result.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/builds/{(%23%2Fdefinitions%2Fbuild%2Fdefinitions%2Fidentity)}/result","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/build-result"},"title":"Info"}],"properties":{"build":{"description":"identity of build","properties":{"id":{"$ref":"#/definitions/build/definitions/id"},"status":{"$ref":"#/definitions/build/definitions/status"}},"type":["object"]},"exit_code":{"$ref":"#/definitions/build-result/definitions/exit_code"},"lines":{"type":["array"],"items":{"$ref":"#/definitions/build-result/definitions/line"},"description":"A list of all the lines of a build's output.","example":[{"line":"-----> Ruby app detected\n","stream":"STDOUT"}]}}},"build":{"$schema":"http://json-schema.org/draft-04/hyper-schema","description":"A build represents the process of transforming a code tarball into a slug","title":"Heroku Build API - Build","stability":"production","strictProperties":true,"type":["object"],"definitions":{"buildpack":{"description":"Buildpack to execute in a build","type":["object"],"properties":{"url":{"$ref":"#/definitions/buildpack-installation/definitions/url"}}},"created_at":{"description":"when build was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"id":{"description":"unique identifier of build","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/build/definitions/id"}]},"source_blob":{"description":"location of gzipped tarball of source code used to create build","properties":{"url":{"description":"URL where gzipped tar archive of source code for build was downloaded.","example":"https://example.com/source.tgz?token=xyz","readOnly":true,"type":["string"]},"version":{"description":"Version of the gzipped tarball.","example":"v1.3.0","readOnly":true,"type":["string","null"]}},"strictProperties":true,"type":["object"]},"status":{"description":"status of build","enum":["failed","pending","succeeded"],"example":"succeeded","readOnly":true,"type":["string"]},"updated_at":{"description":"when build was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]}},"links":[{"description":"Create a new build.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/builds","method":"POST","rel":"create","schema":{"type":["object"],"properties":{"source_blob":{"$ref":"#/definitions/build/definitions/source_blob"}},"required":["source_blob"]},"targetSchema":{"$ref":"#/definitions/build"},"title":"Create"},{"description":"Info for existing build.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/builds/{(%23%2Fdefinitions%2Fbuild%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/build"},"title":"Info"},{"description":"List existing build.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/builds","method":"GET","ranges":["id","started_at"],"rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/build"},"type":["array"]},"title":"List"}],"properties":{"buildpacks":{"description":"buildpacks executed for this build, in order","type":["array"],"items":{"$ref":"#/definitions/build/definitions/buildpack"}},"created_at":{"$ref":"#/definitions/build/definitions/created_at"},"id":{"$ref":"#/definitions/build/definitions/id"},"source_blob":{"$ref":"#/definitions/build/definitions/source_blob"},"slug":{"description":"slug created by this build","properties":{"id":{"$ref":"#/definitions/slug/definitions/id"}},"strictProperties":true,"type":["object","null"]},"status":{"$ref":"#/definitions/build/definitions/status"},"updated_at":{"$ref":"#/definitions/build/definitions/updated_at"},"user":{"description":"user that started the build","properties":{"id":{"$ref":"#/definitions/account/definitions/id"},"email":{"$ref":"#/definitions/account/definitions/email"}},"strictProperties":true,"type":["object"]}}},"buildpack-installation":{"description":"An buildpack installtion represents a buildpack that will be run against an app.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - Buildpack Installations","type":["object"],"definitions":{"ordinal":{"description":"determines the order in which the buildpacks will execute","example":0,"readOnly":true,"type":["integer"]},"update":{"additionalProperties":false,"description":"Properties to update a buildpack installation","properties":{"buildpack":{"$ref":"#/definitions/buildpack-installation/definitions/url"}},"readOnly":false,"required":["buildpack"],"type":["object"]},"url":{"description":"location of the buildpack for the app","example":"https://github.com/heroku/heroku-buildpack-ruby","readOnly":false,"type":["string"]}},"links":[{"description":"Update an app's buildpack installations.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/buildpack-installations","method":"PUT","rel":"update","schema":{"properties":{"updates":{"items":{"$ref":"#/definitions/buildpack-installation/definitions/update"},"type":["array"]}},"required":["updates"],"type":["object"]},"targetSchema":{"items":{"$ref":"#/definitions/buildpack-installation"},"type":["array"]},"title":"Update"},{"description":"List an app's existing buildpack installations.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/buildpack-installations","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/buildpack-installation"},"type":["array"]},"title":"List"}],"properties":{"ordinal":{"$ref":"#/definitions/buildpack-installation/definitions/ordinal"},"buildpack":{"description":"buildpack","properties":{"url":{"$ref":"#/definitions/buildpack-installation/definitions/url"}},"type":["object"]}}},"collaborator":{"description":"A collaborator represents an account that has been given access to an app on Heroku.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - Collaborator","type":["object"],"definitions":{"created_at":{"description":"when collaborator was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"email":{"description":"invited email address of collaborator","example":"collaborator@example.com","format":"email","readOnly":false,"type":["string"]},"id":{"description":"unique identifier of collaborator","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/collaborator/definitions/email"},{"$ref":"#/definitions/collaborator/definitions/id"}]},"silent":{"default":false,"description":"whether to suppress email invitation when creating collaborator","example":false,"readOnly":false,"type":["boolean"]},"updated_at":{"description":"when collaborator was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]}},"links":[{"description":"Create a new collaborator.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/collaborators","method":"POST","rel":"create","schema":{"properties":{"silent":{"$ref":"#/definitions/collaborator/definitions/silent"},"user":{"$ref":"#/definitions/account/definitions/identity"}},"required":["user"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/collaborator"},"title":"Create"},{"description":"Delete an existing collaborator.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/collaborators/{(%23%2Fdefinitions%2Fcollaborator%2Fdefinitions%2Fidentity)}","method":"DELETE","rel":"destroy","targetSchema":{"$ref":"#/definitions/collaborator"},"title":"Delete"},{"description":"Info for existing collaborator.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/collaborators/{(%23%2Fdefinitions%2Fcollaborator%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/collaborator"},"title":"Info"},{"description":"List existing collaborators.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/collaborators","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/collaborator"},"type":["array"]},"title":"List"}],"properties":{"created_at":{"$ref":"#/definitions/collaborator/definitions/created_at"},"id":{"$ref":"#/definitions/collaborator/definitions/id"},"updated_at":{"$ref":"#/definitions/collaborator/definitions/updated_at"},"user":{"description":"identity of collaborated account","properties":{"email":{"$ref":"#/definitions/account/definitions/email"},"id":{"$ref":"#/definitions/account/definitions/id"}},"strictProperties":true,"type":["object"]}}},"config-var":{"description":"Config Vars allow you to manage the configuration information provided to an app on Heroku.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - Config Vars","type":["object"],"definitions":{"config_vars":{"additionalProperties":false,"description":"hash of config vars","example":{"FOO":"bar","BAZ":"qux"},"patternProperties":{"^\\w+$":{"type":["string","null"]}},"type":["object"]}},"links":[{"description":"Get config-vars for app.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/config-vars","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/config-var/definitions/config_vars"},"title":"Info"},{"description":"Update config-vars for app. You can update existing config-vars by setting them again, and remove by setting it to `NULL`.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/config-vars","method":"PATCH","rel":"update","schema":{"additionalProperties":false,"description":"hash of config changes – update values or delete by seting it to NULL","example":{"FOO":"bar","BAZ":"qux"},"patternProperties":{"^\\w+$":{"type":["string","null"]}},"type":["object"]},"targetSchema":{"$ref":"#/definitions/config-var/definitions/config_vars"},"title":"Update"}],"example":{"FOO":"bar","BAZ":"qux"},"patternProperties":{"^\\w+$":{"type":["string"]}}},"credit":{"$schema":"http://json-schema.org/draft-04/hyper-schema","description":"A credit represents value that will be used up before further charges are assigned to an account.","stability":"development","strictProperties":true,"title":"Heroku Platform API - Credit","type":["object"],"definitions":{"amount":{"description":"total value of credit in cents","example":10000,"type":["number"]},"balance":{"description":"remaining value of credit in cents","example":5000,"type":["number"]},"created_at":{"description":"when credit was created","example":"2012-01-01T12:00:00Z","format":"date-time","type":["string"]},"expires_at":{"description":"when credit will expire","example":"2012-01-01T12:00:00Z","format":"date-time","type":["string"]},"id":{"description":"unique identifier of credit","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/credit/definitions/id"}]},"title":{"description":"a name for credit","example":"gift card","type":["string"]},"updated_at":{"description":"when credit was updated","example":"2012-01-01T12:00:00Z","format":"date-time","type":["string"]}},"links":[{"description":"Create a new credit.","href":"/account/credits","method":"POST","rel":"create","schema":{"properties":{"code1":{"description":"first code from a discount card","example":"012abc","type":["string"]},"code2":{"description":"second code from a discount card","example":"012abc","type":["string"]}},"type":["object"]},"targetSchema":{"$ref":"#/definitions/credit"},"title":"Create"},{"description":"Info for existing credit.","href":"/account/credits/{(%23%2Fdefinitions%2Fcredit%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/credit"},"title":"Info"},{"description":"List existing credits.","href":"/account/credits","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/credit"},"type":["array"]},"title":"List"}],"properties":{"amount":{"$ref":"#/definitions/credit/definitions/amount"},"balance":{"$ref":"#/definitions/credit/definitions/balance"},"created_at":{"$ref":"#/definitions/credit/definitions/created_at"},"expires_at":{"$ref":"#/definitions/credit/definitions/expires_at"},"id":{"$ref":"#/definitions/credit/definitions/id"},"title":{"$ref":"#/definitions/credit/definitions/title"},"updated_at":{"$ref":"#/definitions/credit/definitions/updated_at"}}},"domain":{"description":"Domains define what web routes should be routed to an app on Heroku.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - Domain","type":["object"],"definitions":{"created_at":{"description":"when domain was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"hostname":{"description":"full hostname","example":"subdomain.example.com","format":"uri","readOnly":true,"type":["string"]},"id":{"description":"unique identifier of this domain","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/domain/definitions/id"},{"$ref":"#/definitions/domain/definitions/hostname"}]},"updated_at":{"description":"when domain was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]}},"links":[{"description":"Create a new domain.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/domains","method":"POST","rel":"create","schema":{"properties":{"hostname":{"$ref":"#/definitions/domain/definitions/hostname"}},"required":["hostname"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/domain"},"title":"Create"},{"description":"Delete an existing domain","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/domains/{(%23%2Fdefinitions%2Fdomain%2Fdefinitions%2Fidentity)}","method":"DELETE","rel":"destroy","targetSchema":{"$ref":"#/definitions/domain"},"title":"Delete"},{"description":"Info for existing domain.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/domains/{(%23%2Fdefinitions%2Fdomain%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/domain"},"title":"Info"},{"description":"List existing domains.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/domains","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/domain"},"type":["array"]},"title":"List"}],"properties":{"app":{"description":"app that owns the domain","properties":{"name":{"$ref":"#/definitions/app/definitions/name"},"id":{"$ref":"#/definitions/app/definitions/id"}},"type":["object"]},"created_at":{"$ref":"#/definitions/domain/definitions/created_at"},"hostname":{"$ref":"#/definitions/domain/definitions/hostname"},"id":{"$ref":"#/definitions/domain/definitions/id"},"updated_at":{"$ref":"#/definitions/domain/definitions/updated_at"}}},"dyno":{"description":"Dynos encapsulate running processes of an app on Heroku.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - Dyno","type":["object"],"definitions":{"attach":{"description":"whether to stream output or not","example":true,"readOnly":false,"type":["boolean"]},"attach_url":{"description":"a URL to stream output from for attached processes or null for non-attached processes","example":"rendezvous://rendezvous.runtime.heroku.com:5000/{rendezvous-id}","readOnly":true,"type":["string","null"]},"command":{"description":"command used to start this process","example":"bash","readOnly":false,"type":["string"]},"created_at":{"description":"when dyno was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"env":{"additionalProperties":false,"description":"custom environment to add to the dyno config vars","example":{"COLUMNS":"80","LINES":"24"},"patternProperties":{"^\\w+$":{"type":["string"]}},"readOnly":false,"strictProperties":true,"type":["object"]},"id":{"description":"unique identifier of this dyno","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/dyno/definitions/id"},{"$ref":"#/definitions/dyno/definitions/name"}]},"name":{"description":"the name of this process on this dyno","example":"run.1","readOnly":true,"type":["string"]},"size":{"description":"dyno size (default: \"1X\")","example":"1X","readOnly":false,"type":["string"]},"state":{"description":"current status of process (either: crashed, down, idle, starting, or up)","example":"up","readOnly":true,"type":["string"]},"type":{"description":"type of process","example":"run","readOnly":true,"type":["string"]},"updated_at":{"description":"when process last changed state","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]}},"links":[{"description":"Create a new dyno.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/dynos","method":"POST","rel":"create","schema":{"properties":{"attach":{"$ref":"#/definitions/dyno/definitions/attach"},"command":{"$ref":"#/definitions/dyno/definitions/command"},"env":{"$ref":"#/definitions/dyno/definitions/env"},"size":{"$ref":"#/definitions/dyno/definitions/size"}},"required":["command"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/dyno"},"title":"Create"},{"description":"Restart dyno.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/dynos/{(%23%2Fdefinitions%2Fdyno%2Fdefinitions%2Fidentity)}","method":"DELETE","rel":"empty","targetSchema":{"additionalPoperties":false,"type":["object"]},"title":"Restart"},{"description":"Restart all dynos","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/dynos","method":"DELETE","rel":"empty","targetSchema":{"additionalPoperties":false,"type":["object"]},"title":"Restart all"},{"description":"Info for existing dyno.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/dynos/{(%23%2Fdefinitions%2Fdyno%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/dyno"},"title":"Info"},{"description":"List existing dynos.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/dynos","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/dyno"},"type":["array"]},"title":"List"}],"properties":{"attach_url":{"$ref":"#/definitions/dyno/definitions/attach_url"},"command":{"$ref":"#/definitions/dyno/definitions/command"},"created_at":{"$ref":"#/definitions/dyno/definitions/created_at"},"id":{"$ref":"#/definitions/dyno/definitions/id"},"name":{"$ref":"#/definitions/dyno/definitions/name"},"release":{"description":"app release of the dyno","properties":{"id":{"$ref":"#/definitions/release/definitions/id"},"version":{"$ref":"#/definitions/release/definitions/version"}},"strictProperties":true,"type":["object"]},"size":{"$ref":"#/definitions/dyno/definitions/size"},"state":{"$ref":"#/definitions/dyno/definitions/state"},"type":{"$ref":"#/definitions/dyno/definitions/type"},"updated_at":{"$ref":"#/definitions/dyno/definitions/updated_at"}}},"event":{"description":"An event represents an action performed on another API resource.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"development","strictProperties":true,"title":"Heroku Platform API - Event","type":["object"],"definitions":{"action":{"description":"the operation performed on the resource","enum":["create","destroy","update"],"example":"create","readOnly":true,"type":["string"]},"created_at":{"description":"when the event was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"data":{"description":"the serialized resource affected by the event","example":{},"oneOf":[{"$ref":"#/definitions/addon"},{"$ref":"#/definitions/app"},{"$ref":"#/definitions/app-transfer"},{"$ref":"#/definitions/domain"},{"$ref":"#/definitions/dyno"},{"$ref":"#/definitions/formation"},{"$ref":"#/definitions/release"}],"readOnly":true,"type":["object"]},"id":{"description":"unique identifier of an event","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/event/definitions/id"}]},"published_at":{"description":"when the event was published","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["null","string"]},"resource":{"description":"the type of resource affected","enum":["addon","app","app-transfer","domain","dyno","formation","release"],"example":"create","readOnly":true,"type":["string"]},"sequence":{"description":"a numeric string representing the event's sequence","example":"1234567890","pattern":"^[0-9]{1,128}$","readOnly":true,"type":["null","string"]},"updated_at":{"description":"when the event was updated (same as created)","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"version":{"description":"the event's API version string","example":"application/vnd.heroku+json; version=3","readOnly":true,"type":["string"]}},"links":[],"properties":{"action":{"$ref":"#/definitions/event/definitions/action"},"actor":{"description":"user that performed the operation","properties":{"email":{"$ref":"#/definitions/account/definitions/email"},"id":{"$ref":"#/definitions/account/definitions/id"}},"strictProperties":true,"type":["object"]},"created_at":{"$ref":"#/definitions/event/definitions/created_at"},"data":{"$ref":"#/definitions/event/definitions/data"},"id":{"$ref":"#/definitions/event/definitions/id"},"published_at":{"$ref":"#/definitions/event/definitions/published_at"},"resource":{"$ref":"#/definitions/event/definitions/resource"},"sequence":{"$ref":"#/definitions/event/definitions/sequence"},"updated_at":{"$ref":"#/definitions/event/definitions/updated_at"},"version":{"$ref":"#/definitions/event/definitions/version"}}},"formation":{"description":"The formation of processes that should be maintained for an app. Update the formation to scale processes or change dyno sizes. Available process type names and commands are defined by the `process_types` attribute for the [slug](#slug) currently released on an app.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - Formation","type":["object"],"definitions":{"command":{"description":"command to use to launch this process","example":"bundle exec rails server -p $PORT","readOnly":false,"type":["string"]},"created_at":{"description":"when process type was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"id":{"description":"unique identifier of this process type","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/formation/definitions/id"},{"$ref":"#/definitions/formation/definitions/type"}]},"quantity":{"description":"number of processes to maintain","example":1,"readOnly":false,"type":["integer"]},"size":{"description":"dyno size (default: \"1X\")","example":"1X","readOnly":false,"type":["string"]},"type":{"description":"type of process to maintain","example":"web","readOnly":true,"type":["string"]},"updated_at":{"description":"when dyno type was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"update":{"additionalProperties":false,"description":"Properties to update a process type","properties":{"process":{"$ref":"#/definitions/formation/definitions/identity"},"quantity":{"$ref":"#/definitions/formation/definitions/quantity"},"size":{"$ref":"#/definitions/formation/definitions/size"}},"readOnly":false,"required":["process"],"type":["object"]}},"links":[{"description":"Info for a process type","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/formation/{(%23%2Fdefinitions%2Fformation%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/formation"},"title":"Info"},{"description":"List process type formation","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/formation","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/formation"},"type":["array"]},"title":"List"},{"description":"Batch update process types","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/formation","method":"PATCH","rel":"update","schema":{"properties":{"updates":{"type":["array"],"items":{"$ref":"#/definitions/formation/definitions/update"},"description":"Array with formation updates. Each element must have \"process\", the id or name of the process type to be updated, and can optionally update its \"quantity\" or \"size\".","example":[{"process":"web","quantity":1,"size":"2X"}]}},"required":["updates"],"type":["object"]},"targetSchema":{"items":{"$ref":"#/definitions/formation"},"type":["array"]},"title":"Batch update"},{"description":"Update process type","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/formation/{(%23%2Fdefinitions%2Fformation%2Fdefinitions%2Fidentity)}","method":"PATCH","rel":"update","schema":{"properties":{"quantity":{"$ref":"#/definitions/formation/definitions/quantity"},"size":{"$ref":"#/definitions/formation/definitions/size"}},"type":["object"]},"targetSchema":{"$ref":"#/definitions/formation"},"title":"Update","type":["object"]}],"properties":{"command":{"$ref":"#/definitions/formation/definitions/command"},"created_at":{"$ref":"#/definitions/formation/definitions/created_at"},"id":{"$ref":"#/definitions/formation/definitions/id"},"quantity":{"$ref":"#/definitions/formation/definitions/quantity"},"size":{"$ref":"#/definitions/formation/definitions/size"},"type":{"$ref":"#/definitions/formation/definitions/type"},"updated_at":{"$ref":"#/definitions/formation/definitions/updated_at"}}},"invoice":{"$schema":"http://json-schema.org/draft-04/hyper-schema","description":"An invoice is an itemized bill of goods for an account which includes pricing and charges.","stability":"development","strictProperties":true,"title":"Heroku Platform API - Invoice","type":["object"],"definitions":{"charges_total":{"description":"total charges on this invoice","example":100.0,"readOnly":true,"type":["number"]},"created_at":{"description":"when invoice was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"credits_total":{"description":"total credits on this invoice","example":100.0,"readOnly":true,"type":["number"]},"id":{"description":"unique identifier of this invoice","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/invoice/definitions/number"}]},"number":{"description":"human readable invoice number","example":9403943,"readOnly":true,"type":["integer"]},"total":{"description":"combined total of charges and credits on this invoice","example":100.0,"readOnly":true,"type":["number"]},"updated_at":{"description":"when invoice was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]}},"links":[{"description":"Info for existing invoice.","href":"/account/invoices/{(%23%2Fdefinitions%2Finvoice%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/invoice"},"title":"Info"},{"description":"List existing invoices.","href":"/account/invoices","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/invoice"},"type":["array"]},"title":"List"}],"properties":{"charges_total":{"$ref":"#/definitions/invoice/definitions/charges_total"},"created_at":{"$ref":"#/definitions/invoice/definitions/created_at"},"credits_total":{"$ref":"#/definitions/invoice/definitions/credits_total"},"id":{"$ref":"#/definitions/invoice/definitions/id"},"number":{"$ref":"#/definitions/invoice/definitions/number"},"total":{"$ref":"#/definitions/invoice/definitions/total"},"updated_at":{"$ref":"#/definitions/invoice/definitions/updated_at"}}},"invoice_address":{"$schema":"http://json-schema.org/draft-04/hyper-schema","description":"An invoice address represents the address that should be listed on an invoice.","title":"Heroku Vault API - Invoice Address","stability":"development","type":["object"],"definitions":{"address_1":{"type":["string"],"description":"invoice street address line 1","example":"40 Hickory Blvd."},"address_2":{"type":["string"],"description":"invoice street address line 2","example":"Suite 300"},"city":{"type":["string"],"description":"invoice city","example":"Seattle"},"country":{"type":["string"],"description":"country","example":"US"},"heroku_id":{"type":["string"],"description":"heroku_id identifier reference","example":"user930223902@heroku.com","readOnly":true},"identity":{"anyOf":[{"$ref":"#/definitions/invoice_address/definitions/heroku_id"}]},"other":{"type":["string"],"description":"metadata / additional information to go on invoice","example":"Company ABC Inc. VAT 903820"},"postal_code":{"type":["string"],"description":"invoice zip code","example":"98101"},"state":{"type":["string"],"description":"invoice state","example":"WA"},"use_invoice_address":{"type":["boolean"],"description":"flag to use the invoice address for an account or not","example":true,"default":false}},"links":[{"description":"Retrieve existing invoice address.","href":"/account/invoice-address","method":"GET","rel":"self","title":"info"},{"description":"Update invoice address for an account.","href":"/account/invoice-address","method":"PUT","rel":"self","title":"update","schema":{"properties":{"address_1":{"$ref":"#/definitions/invoice_address/definitions/address_1"},"address_2":{"$ref":"#/definitions/invoice_address/definitions/address_2"},"city":{"$ref":"#/definitions/invoice_address/definitions/city"},"country":{"$ref":"#/definitions/invoice_address/definitions/country"},"other":{"$ref":"#/definitions/invoice_address/definitions/other"},"postal_code":{"$ref":"#/definitions/invoice_address/definitions/postal_code"},"state":{"$ref":"#/definitions/invoice_address/definitions/state"},"use_invoice_address":{"$ref":"#/definitions/invoice_address/definitions/use_invoice_address"}},"type":["object"]}}],"properties":{"address_1":{"$ref":"#/definitions/invoice_address/definitions/address_1"},"address_2":{"$ref":"#/definitions/invoice_address/definitions/address_2"},"city":{"$ref":"#/definitions/invoice_address/definitions/city"},"country":{"$ref":"#/definitions/invoice_address/definitions/country"},"heroku_id":{"$ref":"#/definitions/invoice_address/definitions/identity"},"other":{"$ref":"#/definitions/invoice_address/definitions/other"},"postal_code":{"$ref":"#/definitions/invoice_address/definitions/postal_code"},"state":{"$ref":"#/definitions/invoice_address/definitions/state"},"use_invoice_address":{"$ref":"#/definitions/invoice_address/definitions/use_invoice_address"}}},"key":{"description":"Keys represent public SSH keys associated with an account and are used to authorize accounts as they are performing git operations.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - Key","type":["object"],"definitions":{"comment":{"description":"comment on the key","example":"username@host","readOnly":true,"type":["string"]},"created_at":{"description":"when key was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"email":{"deprecated":true,"description":"deprecated. Please refer to 'comment' instead","example":"username@host","readOnly":true,"type":["string"]},"fingerprint":{"description":"a unique identifying string based on contents","example":"17:63:a4:ba:24:d3:7f:af:17:c8:94:82:7e:80:56:bf","readOnly":true,"type":["string"]},"id":{"description":"unique identifier of this key","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/key/definitions/id"},{"$ref":"#/definitions/key/definitions/fingerprint"}]},"public_key":{"description":"full public_key as uploaded","example":"ssh-rsa AAAAB3NzaC1ycVc/../839Uv username@example.com","readOnly":true,"type":["string"]},"updated_at":{"description":"when key was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]}},"links":[{"description":"Create a new key.","href":"/account/keys","method":"POST","rel":"create","schema":{"properties":{"public_key":{"$ref":"#/definitions/key/definitions/public_key"}},"required":["public_key"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/key"},"title":"Create"},{"description":"Delete an existing key","href":"/account/keys/{(%23%2Fdefinitions%2Fkey%2Fdefinitions%2Fidentity)}","method":"DELETE","rel":"destroy","targetSchema":{"$ref":"#/definitions/key"},"title":"Delete"},{"description":"Info for existing key.","href":"/account/keys/{(%23%2Fdefinitions%2Fkey%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/key"},"title":"Info"},{"description":"List existing keys.","href":"/account/keys","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/key"},"type":["array"]},"title":"List"}],"properties":{"comment":{"$ref":"#/definitions/key/definitions/comment"},"created_at":{"$ref":"#/definitions/key/definitions/created_at"},"email":{"$ref":"#/definitions/key/definitions/email"},"fingerprint":{"$ref":"#/definitions/key/definitions/fingerprint"},"id":{"$ref":"#/definitions/key/definitions/id"},"public_key":{"$ref":"#/definitions/key/definitions/public_key"},"updated_at":{"$ref":"#/definitions/key/definitions/updated_at"}}},"log-drain":{"description":"[Log drains](https://devcenter.heroku.com/articles/log-drains) provide a way to forward your Heroku logs to an external syslog server for long-term archiving. This external service must be configured to receive syslog packets from Heroku, whereupon its URL can be added to an app using this API. Some addons will add a log drain when they are provisioned to an app. These drains can only be removed by removing the add-on.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - Log Drain","type":["object"],"definitions":{"addon":{"description":"addon that created the drain","example":{"id":"01234567-89ab-cdef-0123-456789abcdef","name":"singing-swiftly-1242"},"properties":{"id":{"$ref":"#/definitions/addon/definitions/id"},"name":{"$ref":"#/definitions/addon/definitions/name"}},"readOnly":true,"type":["object","null"]},"created_at":{"description":"when log drain was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"id":{"description":"unique identifier of this log drain","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/log-drain/definitions/id"},{"$ref":"#/definitions/log-drain/definitions/url"}]},"token":{"description":"token associated with the log drain","example":"d.01234567-89ab-cdef-0123-456789abcdef","readOnly":true,"type":["string"]},"updated_at":{"description":"when log drain was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"url":{"description":"url associated with the log drain","example":"https://example.com/drain","readOnly":true,"type":["string"]}},"links":[{"description":"Create a new log drain.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/log-drains","method":"POST","rel":"create","schema":{"properties":{"url":{"$ref":"#/definitions/log-drain/definitions/url"}},"required":["url"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/log-drain"},"title":"Create"},{"description":"Delete an existing log drain. Log drains added by add-ons can only be removed by removing the add-on.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/log-drains/{(%23%2Fdefinitions%2Flog-drain%2Fdefinitions%2Fidentity)}","method":"DELETE","rel":"destroy","targetSchema":{"$ref":"#/definitions/log-drain"},"title":"Delete"},{"description":"Info for existing log drain.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/log-drains/{(%23%2Fdefinitions%2Flog-drain%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/log-drain"},"title":"Info"},{"description":"List existing log drains.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/log-drains","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/log-drain"},"type":["array"]},"title":"List"}],"properties":{"addon":{"$ref":"#/definitions/log-drain/definitions/addon"},"created_at":{"$ref":"#/definitions/log-drain/definitions/created_at"},"id":{"$ref":"#/definitions/log-drain/definitions/id"},"token":{"$ref":"#/definitions/log-drain/definitions/token"},"updated_at":{"$ref":"#/definitions/log-drain/definitions/updated_at"},"url":{"$ref":"#/definitions/log-drain/definitions/url"}}},"log-session":{"description":"A log session is a reference to the http based log stream for an app.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - Log Session","type":["object"],"definitions":{"created_at":{"description":"when log connection was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"dyno":{"description":"dyno to limit results to","example":"web.1","readOnly":false,"type":["string"]},"id":{"description":"unique identifier of this log session","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/log-session/definitions/id"}]},"lines":{"description":"number of log lines to stream at once","example":10,"readOnly":false,"type":["integer"]},"logplex_url":{"description":"URL for log streaming session","example":"https://logplex.heroku.com/sessions/01234567-89ab-cdef-0123-456789abcdef?srv=1325419200","readOnly":true,"type":["string"]},"source":{"description":"log source to limit results to","example":"app","readOnly":false,"type":["string"]},"tail":{"description":"whether to stream ongoing logs","example":true,"readOnly":false,"type":["boolean"]},"updated_at":{"description":"when log session was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]}},"links":[{"description":"Create a new log session.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/log-sessions","method":"POST","rel":"create","schema":{"properties":{"dyno":{"$ref":"#/definitions/log-session/definitions/dyno"},"lines":{"$ref":"#/definitions/log-session/definitions/lines"},"source":{"$ref":"#/definitions/log-session/definitions/source"},"tail":{"$ref":"#/definitions/log-session/definitions/tail"}},"type":["object"]},"targetSchema":{"$ref":"#/definitions/log-session"},"title":"Create"}],"properties":{"created_at":{"$ref":"#/definitions/log-session/definitions/created_at"},"id":{"$ref":"#/definitions/log-session/definitions/id"},"logplex_url":{"$ref":"#/definitions/log-session/definitions/logplex_url"},"updated_at":{"$ref":"#/definitions/log-session/definitions/updated_at"}}},"oauth-authorization":{"description":"OAuth authorizations represent clients that a Heroku user has authorized to automate, customize or extend their usage of the platform. For more information please refer to the [Heroku OAuth documentation](https://devcenter.heroku.com/articles/oauth)","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - OAuth Authorization","type":["object"],"definitions":{"created_at":{"description":"when OAuth authorization was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"description":{"description":"human-friendly description of this OAuth authorization","example":"sample authorization","readOnly":true,"type":["string"]},"id":{"description":"unique identifier of OAuth authorization","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/oauth-authorization/definitions/id"}]},"scope":{"description":"The scope of access OAuth authorization allows","example":["global"],"readOnly":true,"type":["array"],"items":{"type":["string"]}},"updated_at":{"description":"when OAuth authorization was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]}},"links":[{"description":"Create a new OAuth authorization.","href":"/oauth/authorizations","method":"POST","rel":"create","schema":{"properties":{"client":{"$ref":"#/definitions/oauth-client/definitions/identity"},"description":{"$ref":"#/definitions/oauth-authorization/definitions/description"},"expires_in":{"$ref":"#/definitions/oauth-token/definitions/expires_in"},"scope":{"$ref":"#/definitions/oauth-authorization/definitions/scope"}},"required":["scope"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/oauth-authorization"},"title":"Create"},{"description":"Delete OAuth authorization.","href":"/oauth/authorizations/{(%23%2Fdefinitions%2Foauth-authorization%2Fdefinitions%2Fidentity)}","method":"DELETE","rel":"destroy","targetSchema":{"$ref":"#/definitions/oauth-authorization"},"title":"Delete"},{"description":"Info for an OAuth authorization.","href":"/oauth/authorizations/{(%23%2Fdefinitions%2Foauth-authorization%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/oauth-authorization"},"title":"Info"},{"description":"List OAuth authorizations.","href":"/oauth/authorizations","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/oauth-authorization"},"type":["array"]},"title":"List"},{"description":"Regenerate OAuth tokens. This endpoint is only available to direct authorizations or privileged OAuth clients.","href":"/oauth/authorizations/{(%23%2Fdefinitions%2Foauth-authorization%2Fdefinitions%2Fidentity)}/actions/regenerate-tokens","method":"POST","rel":"update","targetSchema":{"$ref":"#/definitions/oauth-authorization"},"title":"Regenerate"}],"properties":{"access_token":{"description":"access token for this authorization","properties":{"expires_in":{"$ref":"#/definitions/oauth-token/definitions/expires_in"},"id":{"$ref":"#/definitions/oauth-token/definitions/id"},"token":{"$ref":"#/definitions/oauth-token/definitions/token"}},"type":["null","object"]},"client":{"description":"identifier of the client that obtained this authorization, if any","properties":{"id":{"$ref":"#/definitions/oauth-client/definitions/id"},"name":{"$ref":"#/definitions/oauth-client/definitions/name"},"redirect_uri":{"$ref":"#/definitions/oauth-client/definitions/redirect_uri"}},"type":["null","object"]},"created_at":{"$ref":"#/definitions/oauth-authorization/definitions/created_at"},"grant":{"description":"this authorization's grant","properties":{"code":{"$ref":"#/definitions/oauth-grant/definitions/code"},"expires_in":{"$ref":"#/definitions/oauth-grant/definitions/expires_in"},"id":{"$ref":"#/definitions/oauth-grant/definitions/id"}},"strictProperties":true,"type":["null","object"]},"id":{"$ref":"#/definitions/oauth-authorization/definitions/id"},"refresh_token":{"description":"refresh token for this authorization","properties":{"expires_in":{"$ref":"#/definitions/oauth-token/definitions/expires_in"},"id":{"$ref":"#/definitions/oauth-token/definitions/id"},"token":{"$ref":"#/definitions/oauth-token/definitions/token"}},"strictProperties":true,"type":["null","object"]},"scope":{"$ref":"#/definitions/oauth-authorization/definitions/scope"},"updated_at":{"$ref":"#/definitions/oauth-authorization/definitions/updated_at"}}},"oauth-client":{"description":"OAuth clients are applications that Heroku users can authorize to automate, customize or extend their usage of the platform. For more information please refer to the [Heroku OAuth documentation](https://devcenter.heroku.com/articles/oauth).","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - OAuth Client","type":["object"],"definitions":{"created_at":{"description":"when OAuth client was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"id":{"description":"unique identifier of this OAuth client","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/oauth-client/definitions/id"}]},"ignores_delinquent":{"description":"whether the client is still operable given a delinquent account","example":false,"readOnly":true,"type":["boolean","null"]},"name":{"description":"OAuth client name","example":"example","readOnly":true,"type":["string"]},"redirect_uri":{"description":"endpoint for redirection after authorization with OAuth client","example":"https://example.com/auth/heroku/callback","readOnly":true,"type":["string"]},"secret":{"description":"secret used to obtain OAuth authorizations under this client","example":"01234567-89ab-cdef-0123-456789abcdef","readOnly":true,"type":["string"]},"updated_at":{"description":"when OAuth client was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]}},"links":[{"description":"Create a new OAuth client.","href":"/oauth/clients","method":"POST","rel":"create","schema":{"properties":{"name":{"$ref":"#/definitions/oauth-client/definitions/name"},"redirect_uri":{"$ref":"#/definitions/oauth-client/definitions/redirect_uri"}},"required":["name","redirect_uri"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/oauth-client"},"title":"Create"},{"description":"Delete OAuth client.","href":"/oauth/clients/{(%23%2Fdefinitions%2Foauth-client%2Fdefinitions%2Fidentity)}","method":"DELETE","rel":"destroy","targetSchema":{"$ref":"#/definitions/oauth-client"},"title":"Delete"},{"description":"Info for an OAuth client","href":"/oauth/clients/{(%23%2Fdefinitions%2Foauth-client%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","title":"Info"},{"description":"List OAuth clients","href":"/oauth/clients","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/oauth-client"},"type":["array"]},"title":"List"},{"description":"Update OAuth client","href":"/oauth/clients/{(%23%2Fdefinitions%2Foauth-client%2Fdefinitions%2Fidentity)}","method":"PATCH","rel":"update","schema":{"properties":{"name":{"$ref":"#/definitions/oauth-client/definitions/name"},"redirect_uri":{"$ref":"#/definitions/oauth-client/definitions/redirect_uri"}},"type":["object"]},"targetSchema":{"$ref":"#/definitions/oauth-client"},"title":"Update"}],"properties":{"created_at":{"$ref":"#/definitions/oauth-client/definitions/created_at"},"id":{"$ref":"#/definitions/oauth-client/definitions/id"},"ignores_delinquent":{"$ref":"#/definitions/oauth-client/definitions/ignores_delinquent"},"name":{"$ref":"#/definitions/oauth-client/definitions/name"},"redirect_uri":{"$ref":"#/definitions/oauth-client/definitions/redirect_uri"},"secret":{"$ref":"#/definitions/oauth-client/definitions/secret"},"updated_at":{"$ref":"#/definitions/oauth-client/definitions/updated_at"}}},"oauth-grant":{"description":"OAuth grants are used to obtain authorizations on behalf of a user. For more information please refer to the [Heroku OAuth documentation](https://devcenter.heroku.com/articles/oauth)","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - OAuth Grant","type":["object"],"definitions":{"code":{"description":"grant code received from OAuth web application authorization","example":"01234567-89ab-cdef-0123-456789abcdef","readOnly":true,"type":["string"]},"expires_in":{"description":"seconds until OAuth grant expires","example":2592000,"readOnly":true,"type":["integer"]},"id":{"description":"unique identifier of OAuth grant","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/oauth-grant/definitions/id"}]},"type":{"description":"type of grant requested, one of `authorization_code` or `refresh_token`","example":"authorization_code","readOnly":false,"type":["string"]}},"links":[],"properties":{}},"oauth-token":{"description":"OAuth tokens provide access for authorized clients to act on behalf of a Heroku user to automate, customize or extend their usage of the platform. For more information please refer to the [Heroku OAuth documentation](https://devcenter.heroku.com/articles/oauth)","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - OAuth Token","type":["object"],"definitions":{"created_at":{"description":"when OAuth token was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"expires_in":{"description":"seconds until OAuth token expires; may be `null` for tokens with indefinite lifetime","example":2592000,"readOnly":true,"type":["null","integer"]},"id":{"description":"unique identifier of OAuth token","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/oauth-token/definitions/id"}]},"token":{"description":"contents of the token to be used for authorization","example":"01234567-89ab-cdef-0123-456789abcdef","readOnly":true,"type":["string"]},"updated_at":{"description":"when OAuth token was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]}},"links":[{"description":"Create a new OAuth token.","href":"/oauth/tokens","method":"POST","rel":"create","schema":{"properties":{"client":{"type":["object"],"properties":{"secret":{"$ref":"#/definitions/oauth-client/definitions/secret"}}},"grant":{"type":["object"],"properties":{"code":{"$ref":"#/definitions/oauth-grant/definitions/code"},"type":{"$ref":"#/definitions/oauth-grant/definitions/type"}}},"refresh_token":{"type":["object"],"properties":{"token":{"$ref":"#/definitions/oauth-token/definitions/token"}}}},"required":["grant","client","refresh_token"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/oauth-token"},"title":"Create"}],"properties":{"access_token":{"description":"current access token","properties":{"expires_in":{"$ref":"#/definitions/oauth-token/definitions/expires_in"},"id":{"$ref":"#/definitions/oauth-token/definitions/id"},"token":{"$ref":"#/definitions/oauth-token/definitions/token"}},"strictProperties":true,"type":["object"]},"authorization":{"description":"authorization for this set of tokens","properties":{"id":{"$ref":"#/definitions/oauth-authorization/definitions/id"}},"strictProperties":true,"type":["object"]},"client":{"description":"OAuth client secret used to obtain token","properties":{"secret":{"$ref":"#/definitions/oauth-client/definitions/secret"}},"strictProperties":true,"type":["null","object"]},"created_at":{"$ref":"#/definitions/oauth-token/definitions/created_at"},"grant":{"description":"grant used on the underlying authorization","properties":{"code":{"$ref":"#/definitions/oauth-grant/definitions/code"},"type":{"$ref":"#/definitions/oauth-grant/definitions/type"}},"strictProperties":true,"type":["object"]},"id":{"$ref":"#/definitions/oauth-token/definitions/id"},"refresh_token":{"description":"refresh token for this authorization","properties":{"expires_in":{"$ref":"#/definitions/oauth-token/definitions/expires_in"},"id":{"$ref":"#/definitions/oauth-token/definitions/id"},"token":{"$ref":"#/definitions/oauth-token/definitions/token"}},"strictProperties":true,"type":["object"]},"session":{"description":"OAuth session using this token","properties":{"id":{"$ref":"#/definitions/oauth-token/definitions/id"}},"strictProperties":true,"type":["object"]},"updated_at":{"$ref":"#/definitions/oauth-token/definitions/updated_at"},"user":{"description":"Reference to the user associated with this token","properties":{"id":{"$ref":"#/definitions/account/definitions/id"}},"strictProperties":true,"type":["object"]}}},"organization-app-collaborator":{"description":"An organization collaborator represents an account that has been given access to an organization app on Heroku.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"prototype","strictProperties":true,"title":"Heroku Platform API - Organization App Collaborator","type":["object"],"definitions":{"identity":{"anyOf":[{"$ref":"#/definitions/collaborator/definitions/email"}]}},"links":[{"description":"Create a new collaborator on an organization app. Use this endpoint instead of the `/apps/{app_id_or_name}/collaborator` endpoint when you want the collaborator to be granted [privileges] (https://devcenter.heroku.com/articles/org-users-access#roles) according to their role in the organization.","href":"/organizations/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/collaborators","method":"POST","rel":"create","schema":{"properties":{"silent":{"$ref":"#/definitions/collaborator/definitions/silent"},"user":{"$ref":"#/definitions/account/definitions/identity"}},"required":["user"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/organization-app-collaborator"},"title":"Create"},{"description":"Delete an existing collaborator from an organization app.","href":"/organizations/apps/{(%23%2Fdefinitions%2Forganization-app%2Fdefinitions%2Fidentity)}/collaborators/{(%23%2Fdefinitions%2Forganization-app-collaborator%2Fdefinitions%2Fidentity)}","method":"DELETE","rel":"destroy","targetSchema":{"$ref":"#/definitions/organization-app-collaborator"},"title":"Delete"},{"description":"Info for a collaborator on an organization app.","href":"/organizations/apps/{(%23%2Fdefinitions%2Forganization-app%2Fdefinitions%2Fidentity)}/collaborators/{(%23%2Fdefinitions%2Forganization-app-collaborator%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/organization-app-collaborator"},"title":"Info"},{"description":"List collaborators on an organization app.","href":"/organizations/apps/{(%23%2Fdefinitions%2Forganization-app%2Fdefinitions%2Fidentity)}/collaborators","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/organization-app-collaborator"},"type":["array"]},"title":"List"}],"properties":{"created_at":{"$ref":"#/definitions/collaborator/definitions/created_at"},"id":{"$ref":"#/definitions/collaborator/definitions/id"},"role":{"$ref":"#/definitions/organization/definitions/role"},"updated_at":{"$ref":"#/definitions/collaborator/definitions/updated_at"},"user":{"description":"identity of collaborated account","properties":{"email":{"$ref":"#/definitions/account/definitions/email"},"id":{"$ref":"#/definitions/account/definitions/id"}},"strictProperties":true,"type":["object"]}}},"organization-app":{"$schema":"http://json-schema.org/draft-04/hyper-schema","description":"An organization app encapsulates the organization specific functionality of Heroku apps.","stability":"prototype","title":"Heroku Platform API - Organization App","type":["object"],"definitions":{"locked":{"default":false,"description":"are other organization members forbidden from joining this app.","example":false,"type":["boolean"]},"identity":{"anyOf":[{"$ref":"#/definitions/app/definitions/name"}]},"joined":{"default":false,"description":"is the current member a collaborator on this app.","example":false,"type":["boolean"]},"personal":{"default":false,"description":"force creation of the app in the user account even if a default org is set.","example":false,"type":["boolean"]}},"links":[{"description":"Create a new app in the specified organization, in the default organization if unspecified, or in personal account, if default organization is not set.","href":"/organizations/apps","method":"POST","rel":"create","schema":{"properties":{"locked":{"$ref":"#/definitions/organization-app/definitions/locked"},"name":{"$ref":"#/definitions/app/definitions/name"},"organization":{"$ref":"#/definitions/organization/definitions/name"},"personal":{"$ref":"#/definitions/organization-app/definitions/personal"},"region":{"$ref":"#/definitions/region/definitions/name"},"stack":{"$ref":"#/definitions/stack/definitions/name"}},"type":["object"]},"title":"Create"},{"description":"List apps in the default organization, or in personal account, if default organization is not set.","href":"/organizations/apps","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/organization-app"},"type":["array"]},"title":"List"},{"description":"List organization apps.","href":"/organizations/{(%23%2Fdefinitions%2Forganization%2Fdefinitions%2Fidentity)}/apps","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/organization-app"},"type":["array"]},"title":"List For Organization"},{"description":"Info for an organization app.","href":"/organizations/apps/{(%23%2Fdefinitions%2Forganization-app%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","title":"Info"},{"description":"Lock or unlock an organization app.","href":"/organizations/apps/{(%23%2Fdefinitions%2Forganization-app%2Fdefinitions%2Fidentity)}","method":"PATCH","rel":"update","schema":{"properties":{"locked":{"$ref":"#/definitions/organization-app/definitions/locked"}},"required":["locked"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/organization-app"},"title":"Update Locked"},{"description":"Transfer an existing organization app to another Heroku account.","href":"/organizations/apps/{(%23%2Fdefinitions%2Forganization-app%2Fdefinitions%2Fidentity)}","method":"PATCH","rel":"update","schema":{"properties":{"owner":{"$ref":"#/definitions/account/definitions/identity"}},"required":["owner"],"type":["object"]},"title":"Transfer to Account"},{"description":"Transfer an existing organization app to another organization.","href":"/organizations/apps/{(%23%2Fdefinitions%2Forganization-app%2Fdefinitions%2Fidentity)}","method":"PATCH","rel":"update","schema":{"properties":{"owner":{"$ref":"#/definitions/organization/definitions/name"}},"required":["owner"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/organization-app"},"title":"Transfer to Organization"}],"properties":{"archived_at":{"$ref":"#/definitions/app/definitions/archived_at"},"buildpack_provided_description":{"$ref":"#/definitions/app/definitions/buildpack_provided_description"},"created_at":{"$ref":"#/definitions/app/definitions/created_at"},"git_url":{"$ref":"#/definitions/app/definitions/git_url"},"id":{"$ref":"#/definitions/app/definitions/id"},"joined":{"$ref":"#/definitions/organization-app/definitions/joined"},"locked":{"$ref":"#/definitions/organization-app/definitions/locked"},"maintenance":{"$ref":"#/definitions/app/definitions/maintenance"},"name":{"$ref":"#/definitions/app/definitions/name"},"organization":{"description":"organization that owns this app","properties":{"name":{"$ref":"#/definitions/organization/definitions/name"}},"type":["null","object"]},"owner":{"description":"identity of app owner","properties":{"email":{"$ref":"#/definitions/account/definitions/email"},"id":{"$ref":"#/definitions/account/definitions/id"}},"type":["null","object"]},"region":{"description":"identity of app region","properties":{"id":{"$ref":"#/definitions/region/definitions/id"},"name":{"$ref":"#/definitions/region/definitions/name"}},"type":["object"]},"released_at":{"$ref":"#/definitions/app/definitions/released_at"},"repo_size":{"$ref":"#/definitions/app/definitions/repo_size"},"slug_size":{"$ref":"#/definitions/app/definitions/slug_size"},"stack":{"description":"identity of app stack","properties":{"id":{"$ref":"#/definitions/stack/definitions/id"},"name":{"$ref":"#/definitions/stack/definitions/name"}},"type":["object"]},"updated_at":{"$ref":"#/definitions/app/definitions/updated_at"},"web_url":{"$ref":"#/definitions/app/definitions/web_url"}}},"organization-invoice":{"$schema":"http://json-schema.org/draft-04/hyper-schema","description":"An organization invoice is an itemized bill of goods for an organization which includes pricing and charges.","stability":"prototype","strictProperties":true,"title":"Heroku Platform API - Organization Invoice","type":["object"],"definitions":{"addons_total":{"description":"total addons charges in on this invoice","example":25000,"readOnly":true,"type":["integer"]},"database_total":{"description":"total database charges on this invoice","example":25000,"readOnly":true,"type":["integer"]},"charges_total":{"description":"total charges on this invoice","example":0,"readOnly":true,"type":["integer"]},"created_at":{"description":"when invoice was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"credits_total":{"description":"total credits on this invoice","example":100000,"readOnly":true,"type":["integer"]},"dyno_units":{"description":"The total amount of dyno units consumed across dyno types.","example":1.92,"readOnly":true,"type":["number"]},"id":{"description":"unique identifier of this invoice","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/organization-invoice/definitions/number"}]},"number":{"description":"human readable invoice number","example":9403943,"readOnly":true,"type":["integer"]},"payment_status":{"description":"Status of the invoice payment.","example":"Paid","readOnly":true,"type":["string"]},"platform_total":{"description":"total platform charges on this invoice","example":50000,"readOnly":true,"type":["integer"]},"period_end":{"description":"the ending date that the invoice covers","example":"01/31/2014","readOnly":true,"type":["string"]},"period_start":{"description":"the starting date that this invoice covers","example":"01/01/2014","readOnly":true,"type":["string"]},"state":{"description":"payment status for this invoice (pending, successful, failed)","example":1,"readOnly":true,"type":["integer"]},"total":{"description":"combined total of charges and credits on this invoice","example":100000,"readOnly":true,"type":["integer"]},"updated_at":{"description":"when invoice was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"weighted_dyno_hours":{"description":"The total amount of hours consumed across dyno types.","example":1488,"readOnly":true,"type":["number"]}},"links":[{"description":"Info for existing invoice.","href":"/organizations/{(%23%2Fdefinitions%2Forganization%2Fdefinitions%2Fidentity)}/invoices/{(%23%2Fdefinitions%2Forganization-invoice%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/organization-invoice"},"title":"Info"},{"description":"List existing invoices.","href":"/organizations/{(%23%2Fdefinitions%2Forganization%2Fdefinitions%2Fidentity)}/invoices","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/organization-invoice"},"type":["array"]},"title":"List"}],"properties":{"addons_total":{"$ref":"#/definitions/organization-invoice/definitions/addons_total"},"database_total":{"$ref":"#/definitions/organization-invoice/definitions/database_total"},"charges_total":{"$ref":"#/definitions/organization-invoice/definitions/charges_total"},"created_at":{"$ref":"#/definitions/organization-invoice/definitions/created_at"},"credits_total":{"$ref":"#/definitions/organization-invoice/definitions/credits_total"},"dyno_units":{"$ref":"#/definitions/organization-invoice/definitions/dyno_units"},"id":{"$ref":"#/definitions/organization-invoice/definitions/id"},"number":{"$ref":"#/definitions/organization-invoice/definitions/number"},"payment_status":{"$ref":"#/definitions/organization-invoice/definitions/payment_status"},"period_end":{"$ref":"#/definitions/organization-invoice/definitions/period_end"},"period_start":{"$ref":"#/definitions/organization-invoice/definitions/period_start"},"platform_total":{"$ref":"#/definitions/organization-invoice/definitions/platform_total"},"state":{"$ref":"#/definitions/organization-invoice/definitions/state"},"total":{"$ref":"#/definitions/organization-invoice/definitions/total"},"updated_at":{"$ref":"#/definitions/organization-invoice/definitions/updated_at"},"weighted_dyno_hours":{"$ref":"#/definitions/organization-invoice/definitions/weighted_dyno_hours"}}},"organization-member":{"$schema":"http://json-schema.org/draft-04/hyper-schema","description":"An organization member is an individual with access to an organization.","stability":"prototype","strictProperties":true,"title":"Heroku Platform API - Organization Member","type":["object"],"definitions":{"created_at":{"description":"when the membership record was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"email":{"description":"email address of the organization member","example":"someone@example.org","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/organization-member/definitions/email"}]},"two_factor_authentication":{"description":"whether the organization member has two factor authentication enabled","example":true,"readOnly":true,"type":["boolean"]},"updated_at":{"description":"when the membership record was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]}},"links":[{"description":"Create a new organization member, or update their role.","href":"/organizations/{(%23%2Fdefinitions%2Forganization%2Fdefinitions%2Fidentity)}/members","method":"PUT","rel":"create","schema":{"properties":{"email":{"$ref":"#/definitions/organization-member/definitions/email"},"role":{"$ref":"#/definitions/organization/definitions/role"}},"required":["email","role"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/organization-member"},"title":"Create or Update"},{"description":"Remove a member from the organization.","href":"/organizations/{(%23%2Fdefinitions%2Forganization%2Fdefinitions%2Fidentity)}/members/{(%23%2Fdefinitions%2Forganization-member%2Fdefinitions%2Fidentity)}","method":"DELETE","rel":"destroy","targetSchema":{"$ref":"#/definitions/organization-member"},"title":"Delete"},{"description":"List members of the organization.","href":"/organizations/{(%23%2Fdefinitions%2Forganization%2Fdefinitions%2Fidentity)}/members","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/organization-member"},"type":["array"]},"title":"List"}],"properties":{"created_at":{"$ref":"#/definitions/organization-member/definitions/created_at"},"email":{"$ref":"#/definitions/organization-member/definitions/email"},"role":{"$ref":"#/definitions/organization/definitions/role"},"two_factor_authentication":{"$ref":"#/definitions/organization-member/definitions/two_factor_authentication"},"updated_at":{"$ref":"#/definitions/organization-member/definitions/updated_at"}}},"organization":{"$schema":"http://json-schema.org/draft-04/hyper-schema","description":"Organizations allow you to manage access to a shared group of applications across your development team.","stability":"prototype","strictProperties":true,"title":"Heroku Platform API - Organization","type":["object"],"definitions":{"created_at":{"description":"when the organization was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"credit_card_collections":{"description":"whether charges incurred by the org are paid by credit card.","example":true,"readOnly":true,"type":["boolean"]},"default":{"description":"whether to use this organization when none is specified","example":true,"readOnly":false,"type":["boolean"]},"id":{"description":"unique identifier of organization","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/organization/definitions/name"}]},"name":{"description":"unique name of organization","example":"example","readOnly":true,"type":["string"]},"provisioned_licenses":{"description":"whether the org is provisioned licenses by salesforce.","example":true,"readOnly":true,"type":["boolean"]},"role":{"description":"role in the organization","enum":["admin","member","collaborator"],"example":"admin","readOnly":true,"type":["string"]},"updated_at":{"description":"when the organization was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]}},"links":[{"description":"List organizations in which you are a member.","href":"/organizations","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/organization"},"type":["array"]},"title":"List"},{"description":"Info for an organization.","href":"/organizations/{(%23%2Fdefinitions%2Forganization%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","title":"Info"},{"description":"Set or unset the organization as your default organization.","href":"/organizations/{(%23%2Fdefinitions%2Forganization%2Fdefinitions%2Fidentity)}","method":"PATCH","rel":"update","schema":{"properties":{"default":{"$ref":"#/definitions/organization/definitions/default"}},"type":["object"]},"targetSchema":{"$ref":"#/definitions/organization"},"title":"Update"}],"properties":{"created_at":{"$ref":"#/definitions/organization/definitions/created_at"},"credit_card_collections":{"$ref":"#/definitions/organization/definitions/credit_card_collections"},"default":{"$ref":"#/definitions/organization/definitions/default"},"name":{"$ref":"#/definitions/organization/definitions/name"},"provisioned_licenses":{"$ref":"#/definitions/organization/definitions/provisioned_licenses"},"role":{"$ref":"#/definitions/organization/definitions/role"},"updated_at":{"$ref":"#/definitions/organization/definitions/updated_at"}}},"otp-secret":{"description":"This renders a secret that clients can use to build a one-time password to be supplied as a 2nd factor of authentication.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"development","strictProperties":true,"title":"Heroku Platform API - OTP Secret","type":["object"],"definitions":{"created_at":{"description":"when OTP secret was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"id":{"description":"unique identifier of OTP secret","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/otp-secret/definitions/id"}]},"updated_at":{"description":"when OTP secret was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"url":{"description":"OTP secret rendered in URL format","example":"otpauth://totp/username@example.com?issuer=Heroku&secret=abcd1234","readOnly":true,"type":["string"]}},"links":[{"description":"Create new OTP secret. This invalidates any existing OTP secrets on the account.","href":"/account/otp-secret","method":"POST","rel":"create","targetSchema":{"$ref":"#/definitions/otp-secret"},"title":"Create"}],"properties":{"created_at":{"$ref":"#/definitions/otp-secret/definitions/created_at"},"id":{"$ref":"#/definitions/otp-secret/definitions/id"},"updated_at":{"$ref":"#/definitions/otp-secret/definitions/updated_at"},"url":{"$ref":"#/definitions/otp-secret/definitions/url"}}},"payment":{"$schema":"http://json-schema.org/draft-04/hyper-schema","description":"A payment represents money collected for an account","title":"Heroku Vault API - Payments","stability":"prototype","type":["object"],"definitions":{"account_id":{"type":["integer"],"description":"account that payment belongs to","example":8403923,"readOnly":true},"amount":{"type":["number"],"description":"amount of payment in cents","example":50000,"readOnly":false},"created_at":{"description":"when payment was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"id":{"type":["integer"],"description":"legacy unique identifier of payment","example":9403943,"readOnly":true},"identity":{"anyOf":[{"$ref":"#/definitions/payment/definitions/id"}]},"state":{"enum":["failure","pending","success"],"type":["string"],"description":"state of the payment","example":"pending","readOnly":true},"updated_at":{"description":"when credit was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"uuid":{"description":"unique identifier for a payment transaction","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":false,"type":["string"]}},"links":[{"description":"Create a payment on an existing account","href":"/account/payments","method":"POST","rel":"self","schema":{"properties":{"amount":{"$ref":"#/definitions/payment/definitions/amount"},"invoice":{"$ref":"#/definitions/invoice/definitions/identity"},"uuid":{"$ref":"#/definitions/payment/definitions/uuid"}},"required":["amount","invoice","uuid"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/payment"},"title":"create"}],"properties":{"amount":{"$ref":"#/definitions/payment/definitions/amount"},"created_at":{"$ref":"#/definitions/payment/definitions/created_at"},"id":{"$ref":"#/definitions/payment/definitions/id"},"invoice":{"description":"identity of invoice","properties":{"id":{"$ref":"#/definitions/invoice/definitions/id"},"number":{"$ref":"#/definitions/invoice/definitions/number"}},"type":["null","object"]},"updated_at":{"$ref":"#/definitions/payment/definitions/updated_at"},"user":{"description":"identity of user issuing payment","properties":{"email":{"$ref":"#/definitions/account/definitions/email"},"id":{"$ref":"#/definitions/account/definitions/id"}},"strictProperties":true,"type":["object"]},"state":{"$ref":"#/definitions/payment/definitions/state"}}},"payment_method":{"$schema":"http://json-schema.org/draft-04/hyper-schema","description":"The on file payment method for an account","stability":"prototype","title":"Heroku Vault API - Payment Method","type":["object"],"definitions":{"address_1":{"type":["string"],"description":"street address line 1","example":"40 Hickory Lane"},"address_2":{"type":["string"],"description":"street address line 2","example":"Suite 103"},"card_number":{"type":["string"],"description":"encrypted card number of payment method","example":"encrypted-card-number"},"city":{"type":["string"],"description":"city","example":"San Francisco"},"country":{"type":["string"],"description":"country","example":"US"},"cvv":{"type":["string"],"description":"card verification value","example":"123"},"expiration_month":{"type":["string"],"description":"expiration month","example":"11"},"expiration_year":{"type":["string"],"description":"expiration year","example":"2014"},"first_name":{"type":["string"],"description":"the first name for payment method","example":"Jason"},"last_name":{"type":["string"],"description":"the last name for payment method","example":"Walker"},"other":{"type":["string"],"description":"metadata","example":"Additional information for payment method"},"postal_code":{"type":["string"],"description":"postal code","example":"90210"},"state":{"type":["string"],"description":"state","example":"CA"},"card_last4":{"type":["string"],"description":"last 4 digits of credit card number","example":"1234","readOnly":true},"card_type":{"type":["string"],"description":"name of credit card issuer","example":"VISA","readOnly":true},"heroku_id":{"type":["string"],"description":"heroku_id identifier reference","example":"user930223902@heroku.com","readOnly":true},"identity":{"anyOf":[{"$ref":"#/definitions/invoice_address/definitions/heroku_id"}]}},"links":[{"description":"Update an existing payment method for an account.","href":"/account/payment-method","method":"PATCH","rel":"empty","schema":{"properties":{"address_1":{"$ref":"#/definitions/payment_method/definitions/address_1"},"address_2":{"$ref":"#/definitions/payment_method/definitions/address_2"},"card_number":{"$ref":"#/definitions/payment_method/definitions/card_number"},"city":{"$ref":"#/definitions/payment_method/definitions/city"},"country":{"$ref":"#/definitions/payment_method/definitions/country"},"cvv":{"$ref":"#/definitions/payment_method/definitions/cvv"},"expiration_month":{"$ref":"#/definitions/payment_method/definitions/expiration_month"},"expiration_year":{"$ref":"#/definitions/payment_method/definitions/expiration_year"},"first_name":{"$ref":"#/definitions/payment_method/definitions/first_name"},"last_name":{"$ref":"#/definitions/payment_method/definitions/last_name"},"other":{"$ref":"#/definitions/payment_method/definitions/other"},"postal_code":{"$ref":"#/definitions/payment_method/definitions/postal_code"},"state":{"$ref":"#/definitions/payment_method/definitions/state"}},"required":["address_1","address_2","card_number","city","country","cvv","expiration_month","expiration_year","first_name","last_name","postal_code","state"],"type":["object"]},"title":"update"},{"description":"Get the current payment method for an account.","href":"/account/payment-method","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/payment_method"},"title":"get"}],"properties":{"address_1":{"$ref":"#/definitions/payment_method/definitions/address_1"},"address_2":{"$ref":"#/definitions/payment_method/definitions/address_2"},"card_last4":{"$ref":"#/definitions/payment_method/definitions/card_last4"},"card_type":{"$ref":"#/definitions/payment_method/definitions/card_type"},"city":{"$ref":"#/definitions/payment_method/definitions/city"},"country":{"$ref":"#/definitions/payment_method/definitions/country"},"expiration_month":{"$ref":"#/definitions/payment_method/definitions/expiration_month"},"expiration_year":{"$ref":"#/definitions/payment_method/definitions/expiration_year"},"first_name":{"$ref":"#/definitions/payment_method/definitions/first_name"},"last_name":{"$ref":"#/definitions/payment_method/definitions/last_name"},"other":{"$ref":"#/definitions/payment_method/definitions/other"},"postal_code":{"$ref":"#/definitions/payment_method/definitions/postal_code"},"state":{"$ref":"#/definitions/payment_method/definitions/state"}}},"plan":{"description":"Plans represent different configurations of add-ons that may be added to apps. Endpoints under add-on services can be accessed without authentication.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - Plan","type":["object"],"definitions":{"created_at":{"description":"when plan was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"default":{"description":"whether this plan is the default for its addon service","example":false,"readOnly":true,"type":["boolean"]},"description":{"description":"description of plan","example":"Heroku Postgres Dev","readOnly":true,"type":["string"]},"human_name":{"description":"human readable name of the addon plan","example":"Dev","readOnly":true,"type":["string"]},"id":{"description":"unique identifier of this plan","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/plan/definitions/id"},{"$ref":"#/definitions/plan/definitions/name"}]},"name":{"description":"unique name of this plan","example":"heroku-postgresql:dev","readOnly":true,"type":["string"]},"cents":{"description":"price in cents per unit of plan","example":0,"readOnly":true,"type":["integer"]},"unit":{"description":"unit of price for plan","example":"month","readOnly":true,"type":["string"]},"state":{"description":"release status for plan","example":"public","readOnly":true,"type":["string"]},"updated_at":{"description":"when plan was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]}},"links":[{"description":"Info for existing plan.","href":"/addon-services/{(%23%2Fdefinitions%2Faddon-service%2Fdefinitions%2Fidentity)}/plans/{(%23%2Fdefinitions%2Fplan%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/plan"},"title":"Info"},{"description":"List existing plans.","href":"/addon-services/{(%23%2Fdefinitions%2Faddon-service%2Fdefinitions%2Fidentity)}/plans","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/plan"},"type":["array"]},"title":"List"}],"properties":{"created_at":{"$ref":"#/definitions/plan/definitions/created_at"},"default":{"$ref":"#/definitions/plan/definitions/default"},"description":{"$ref":"#/definitions/plan/definitions/description"},"human_name":{"$ref":"#/definitions/plan/definitions/human_name"},"id":{"$ref":"#/definitions/plan/definitions/id"},"name":{"$ref":"#/definitions/plan/definitions/name"},"price":{"description":"price","properties":{"cents":{"$ref":"#/definitions/plan/definitions/cents"},"unit":{"$ref":"#/definitions/plan/definitions/unit"}},"strictProperties":true,"type":["object"]},"state":{"$ref":"#/definitions/plan/definitions/state"},"updated_at":{"$ref":"#/definitions/plan/definitions/updated_at"}}},"rate-limit":{"description":"Rate Limit represents the number of request tokens each account holds. Requests to this endpoint do not count towards the rate limit.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - Rate Limit","type":["object"],"definitions":{"identity":{},"remaining":{"description":"allowed requests remaining in current interval","example":2399,"readOnly":true,"type":["integer"]}},"links":[{"description":"Info for rate limits.","href":"/account/rate-limits","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/rate-limit"},"title":"Info"}],"properties":{"remaining":{"$ref":"#/definitions/rate-limit/definitions/remaining"}}},"recovery-code":{"description":"Recovery codes grant access to accounts with two-factor authentication enabled.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"development","strictProperties":true,"title":"Heroku Platform API - Recovery Code","type":["array"],"items":{"example":"0123456789abcdef","type":["string"]},"links":[{"description":"Generate new recovery codes. This invalidates any existing codes on the account.","href":"/account/recovery-codes","method":"POST","rel":"create","targetSchema":{"$ref":"#/definitions/recovery-code"},"title":"Create"}]},"region":{"description":"A region represents a geographic location in which your application may run.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - Region","type":["object"],"definitions":{"created_at":{"description":"when region was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"description":{"description":"description of region","example":"United States","readOnly":true,"type":["string"]},"id":{"description":"unique identifier of region","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/region/definitions/id"},{"$ref":"#/definitions/region/definitions/name"}]},"name":{"description":"unique name of region","example":"us","readOnly":true,"type":["string"]},"updated_at":{"description":"when region was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]}},"links":[{"description":"Info for existing region.","href":"/regions/{(%23%2Fdefinitions%2Fregion%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/region"},"title":"Info"},{"description":"List existing regions.","href":"/regions","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/region"},"type":["array"]},"title":"List"}],"properties":{"created_at":{"$ref":"#/definitions/region/definitions/created_at"},"description":{"$ref":"#/definitions/region/definitions/description"},"id":{"$ref":"#/definitions/region/definitions/id"},"name":{"$ref":"#/definitions/region/definitions/name"},"updated_at":{"$ref":"#/definitions/region/definitions/updated_at"}}},"release":{"description":"A release represents a combination of code, config vars and add-ons for an app on Heroku.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - Release","type":["object"],"definitions":{"created_at":{"description":"when release was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"description":{"description":"description of changes in this release","example":"Added new feature","readOnly":true,"type":["string"]},"id":{"description":"unique identifier of release","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/release/definitions/id"},{"$ref":"#/definitions/release/definitions/version"}]},"updated_at":{"description":"when release was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"version":{"description":"unique version assigned to the release","example":11,"readOnly":true,"type":["integer"]}},"links":[{"description":"Info for existing release.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/releases/{(%23%2Fdefinitions%2Frelease%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/release"},"title":"Info"},{"description":"List existing releases.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/releases","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/release"},"type":["array"]},"title":"List"},{"description":"Create new release. The API cannot be used to create releases on Bamboo apps.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/releases","method":"POST","rel":"create","schema":{"properties":{"description":{"$ref":"#/definitions/release/definitions/description"},"slug":{"$ref":"#/definitions/slug/definitions/identity"}},"required":["slug"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/release"},"title":"Create"},{"description":"Rollback to an existing release.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/releases","method":"POST","rel":"create","schema":{"properties":{"release":{"$ref":"#/definitions/release/definitions/id"}},"required":["release"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/release"},"title":"Rollback"}],"properties":{"app":{"description":"app involved in the release","properties":{"name":{"$ref":"#/definitions/app/definitions/name"},"id":{"$ref":"#/definitions/app/definitions/id"}},"type":["object"]},"created_at":{"$ref":"#/definitions/release/definitions/created_at"},"description":{"$ref":"#/definitions/release/definitions/description"},"id":{"$ref":"#/definitions/release/definitions/id"},"updated_at":{"$ref":"#/definitions/release/definitions/updated_at"},"slug":{"description":"slug running in this release","properties":{"id":{"$ref":"#/definitions/slug/definitions/id"}},"strictProperties":true,"type":["object","null"]},"user":{"description":"user that created the release","properties":{"id":{"$ref":"#/definitions/account/definitions/id"},"email":{"$ref":"#/definitions/account/definitions/email"}},"strictProperties":true,"type":["object"]},"version":{"$ref":"#/definitions/release/definitions/version"}}},"slug":{"description":"A slug is a snapshot of your application code that is ready to run on the platform.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - Slug","type":["object"],"definitions":{"buildpack_provided_description":{"description":"description from buildpack of slug","example":"Ruby/Rack","readOnly":false,"type":["null","string"]},"commit":{"description":"identification of the code with your version control system (eg: SHA of the git HEAD)","example":"60883d9e8947a57e04dc9124f25df004866a2051","readOnly":false,"type":["null","string"]},"commit_description":{"description":"an optional description of the provided commit","example":"fixed a bug with API documentation","readOnly":false,"type":["null","string"]},"created_at":{"description":"when slug was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"id":{"description":"unique identifier of slug","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/slug/definitions/id"}]},"method":{"description":"method to be used to interact with the slug blob","example":"GET","readOnly":true,"type":["string"]},"process_types":{"additionalProperties":false,"description":"hash mapping process type names to their respective command","example":{"web":"./bin/web -p $PORT"},"patternProperties":{"^\\w+$":{"type":["string"]}},"readOnly":false,"type":["object"]},"size":{"default":null,"description":"size of slug, in bytes","example":2048,"readOnly":true,"type":["integer","null"]},"updated_at":{"description":"when slug was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"url":{"description":"URL to interact with the slug blob","example":"https://api.heroku.com/slugs/1234.tgz","readOnly":true,"type":["string"]}},"links":[{"description":"Info for existing slug.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/slugs/{(%23%2Fdefinitions%2Fslug%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/slug"},"title":"Info"},{"description":"Create a new slug. For more information please refer to [Deploying Slugs using the Platform API](https://devcenter.heroku.com/articles/platform-api-deploying-slugs?preview=1).","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/slugs","method":"POST","rel":"create","schema":{"properties":{"buildpack_provided_description":{"$ref":"#/definitions/slug/definitions/buildpack_provided_description"},"commit":{"$ref":"#/definitions/slug/definitions/commit"},"commit_description":{"$ref":"#/definitions/slug/definitions/commit_description"},"process_types":{"$ref":"#/definitions/slug/definitions/process_types"},"stack":{"$ref":"#/definitions/stack/definitions/identity"}},"required":["process_types"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/slug"},"title":"Create"}],"properties":{"blob":{"description":"pointer to the url where clients can fetch or store the actual release binary","properties":{"method":{"$ref":"#/definitions/slug/definitions/method"},"url":{"$ref":"#/definitions/slug/definitions/url"}},"strictProperties":true,"type":["object"]},"buildpack_provided_description":{"$ref":"#/definitions/slug/definitions/buildpack_provided_description"},"commit":{"$ref":"#/definitions/slug/definitions/commit"},"commit_description":{"$ref":"#/definitions/slug/definitions/commit_description"},"created_at":{"$ref":"#/definitions/slug/definitions/created_at"},"id":{"$ref":"#/definitions/slug/definitions/id"},"process_types":{"$ref":"#/definitions/slug/definitions/process_types"},"size":{"$ref":"#/definitions/slug/definitions/size"},"stack":{"description":"identity of slug stack","properties":{"id":{"$ref":"#/definitions/stack/definitions/id"},"name":{"$ref":"#/definitions/stack/definitions/name"}},"strictProperties":true,"type":["object"]},"updated_at":{"$ref":"#/definitions/slug/definitions/updated_at"}}},"source":{"description":"A source is a location for uploading and downloading an application's source code.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - Source","type":["object"],"definitions":{"get_url":{"description":"URL to download the source","example":"https://api.heroku.com/sources/1234.tgz","readOnly":true,"type":["string"]},"put_url":{"description":"URL to upload the source","example":"https://api.heroku.com/sources/1234.tgz","readOnly":true,"type":["string"]}},"links":[{"description":"Create URLs for uploading and downloading source.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/sources","method":"POST","rel":"create","targetSchema":{"$ref":"#/definitions/source"},"title":"Create"}],"properties":{"source_blob":{"description":"pointer to the URL where clients can fetch or store the source","properties":{"get_url":{"$ref":"#/definitions/source/definitions/get_url"},"put_url":{"$ref":"#/definitions/source/definitions/put_url"}},"strictProperties":true,"type":["object"]}}},"ssl-endpoint":{"description":"[SSL Endpoint](https://devcenter.heroku.com/articles/ssl-endpoint) is a public address serving custom SSL cert for HTTPS traffic to a Heroku app. Note that an app must have the `ssl:endpoint` addon installed before it can provision an SSL Endpoint using these APIs.","$schema":"http://json-schema.org/draft-04/hyper-schema","title":"Heroku Platform API - SSL Endpoint","stability":"production","strictProperties":true,"type":["object"],"definitions":{"certificate_chain":{"description":"raw contents of the public certificate chain (eg: .crt or .pem file)","example":"-----BEGIN CERTIFICATE----- ...","readOnly":false,"type":["string"]},"cname":{"description":"canonical name record, the address to point a domain at","example":"example.herokussl.com","readOnly":false,"type":["string"]},"created_at":{"description":"when endpoint was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"id":{"description":"unique identifier of this SSL endpoint","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/ssl-endpoint/definitions/id"},{"$ref":"#/definitions/ssl-endpoint/definitions/name"}]},"name":{"description":"unique name for SSL endpoint","example":"example","pattern":"^[a-z][a-z0-9-]{3,30}$","readOnly":true,"type":["string"]},"preprocess":{"default":true,"description":"allow Heroku to modify an uploaded public certificate chain if deemed advantageous by adding missing intermediaries, stripping unnecessary ones, etc.","example":true,"readOnly":false,"type":["boolean"]},"private_key":{"description":"contents of the private key (eg .key file)","example":"-----BEGIN RSA PRIVATE KEY----- ...","readOnly":false,"type":["string"]},"rollback":{"default":false,"description":"indicates that a rollback should be performed","example":false,"readOnly":false,"type":["boolean"]},"updated_at":{"description":"when endpoint was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]}},"links":[{"description":"Create a new SSL endpoint.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/ssl-endpoints","method":"POST","rel":"create","schema":{"properties":{"certificate_chain":{"$ref":"#/definitions/ssl-endpoint/definitions/certificate_chain"},"preprocess":{"$ref":"#/definitions/ssl-endpoint/definitions/preprocess"},"private_key":{"$ref":"#/definitions/ssl-endpoint/definitions/private_key"}},"required":["certificate_chain","private_key"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/ssl-endpoint"},"title":"Create"},{"description":"Delete existing SSL endpoint.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/ssl-endpoints/{(%23%2Fdefinitions%2Fssl-endpoint%2Fdefinitions%2Fidentity)}","method":"DELETE","rel":"destroy","targetSchema":{"$ref":"#/definitions/ssl-endpoint"},"title":"Delete"},{"description":"Info for existing SSL endpoint.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/ssl-endpoints/{(%23%2Fdefinitions%2Fssl-endpoint%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/ssl-endpoint"},"title":"Info"},{"description":"List existing SSL endpoints.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/ssl-endpoints","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/ssl-endpoint"},"type":["array"]},"title":"List"},{"description":"Update an existing SSL endpoint.","href":"/apps/{(%23%2Fdefinitions%2Fapp%2Fdefinitions%2Fidentity)}/ssl-endpoints/{(%23%2Fdefinitions%2Fssl-endpoint%2Fdefinitions%2Fidentity)}","method":"PATCH","rel":"update","schema":{"properties":{"certificate_chain":{"$ref":"#/definitions/ssl-endpoint/definitions/certificate_chain"},"preprocess":{"$ref":"#/definitions/ssl-endpoint/definitions/preprocess"},"private_key":{"$ref":"#/definitions/ssl-endpoint/definitions/private_key"},"rollback":{"$ref":"#/definitions/ssl-endpoint/definitions/rollback"}},"type":["object"]},"targetSchema":{"$ref":"#/definitions/ssl-endpoint"},"title":"Update"}],"properties":{"certificate_chain":{"$ref":"#/definitions/ssl-endpoint/definitions/certificate_chain"},"cname":{"$ref":"#/definitions/ssl-endpoint/definitions/cname"},"created_at":{"$ref":"#/definitions/ssl-endpoint/definitions/created_at"},"id":{"$ref":"#/definitions/ssl-endpoint/definitions/id"},"name":{"$ref":"#/definitions/ssl-endpoint/definitions/name"},"updated_at":{"$ref":"#/definitions/ssl-endpoint/definitions/updated_at"}}},"stack":{"description":"Stacks are the different application execution environments available in the Heroku platform.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - Stack","type":["object"],"definitions":{"created_at":{"description":"when stack was introduced","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"id":{"description":"unique identifier of stack","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/stack/definitions/name"},{"$ref":"#/definitions/stack/definitions/id"}]},"name":{"description":"unique name of stack","example":"cedar-14","readOnly":true,"type":["string"]},"state":{"description":"availability of this stack: beta, deprecated or public","example":"public","readOnly":true,"type":["string"]},"updated_at":{"description":"when stack was last modified","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]}},"links":[{"description":"Stack info.","href":"/stacks/{(%23%2Fdefinitions%2Fstack%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/stack"},"title":"Info"},{"description":"List available stacks.","href":"/stacks","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/stack"},"type":["array"]},"title":"List"}],"properties":{"created_at":{"$ref":"#/definitions/stack/definitions/created_at"},"id":{"$ref":"#/definitions/stack/definitions/id"},"name":{"$ref":"#/definitions/stack/definitions/name"},"state":{"$ref":"#/definitions/stack/definitions/state"},"updated_at":{"$ref":"#/definitions/stack/definitions/updated_at"}}},"account-feature":{"description":"An account feature represents a Heroku labs capability that can be enabled or disabled for an account on Heroku.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - Account Feature","type":["object"],"definitions":{"created_at":{"description":"when account feature was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"description":{"description":"description of account feature","example":"Causes account to example.","readOnly":true,"type":["string"]},"doc_url":{"description":"documentation URL of account feature","example":"http://devcenter.heroku.com/articles/example","readOnly":true,"type":["string"]},"enabled":{"description":"whether or not account feature has been enabled","example":true,"readOnly":false,"type":["boolean"]},"id":{"description":"unique identifier of account feature","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/account-feature/definitions/id"},{"$ref":"#/definitions/account-feature/definitions/name"}]},"name":{"description":"unique name of account feature","example":"name","readOnly":true,"type":["string"]},"state":{"description":"state of account feature","example":"public","readOnly":true,"type":["string"]},"updated_at":{"description":"when account feature was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]}},"links":[{"description":"Info for an existing account feature.","href":"/account/features/{(%23%2Fdefinitions%2Faccount-feature%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/account-feature"},"title":"Info"},{"description":"List existing account features.","href":"/account/features","method":"GET","rel":"instances","targetSchema":{"items":{"$ref":"#/definitions/account-feature"},"type":["array"]},"title":"List"},{"description":"Update an existing account feature.","href":"/account/features/{(%23%2Fdefinitions%2Faccount-feature%2Fdefinitions%2Fidentity)}","method":"PATCH","rel":"update","schema":{"properties":{"enabled":{"$ref":"#/definitions/account-feature/definitions/enabled"}},"required":["enabled"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/account-feature"},"title":"Update"}],"properties":{"created_at":{"$ref":"#/definitions/account-feature/definitions/created_at"},"description":{"$ref":"#/definitions/account-feature/definitions/description"},"doc_url":{"$ref":"#/definitions/account-feature/definitions/doc_url"},"enabled":{"$ref":"#/definitions/account-feature/definitions/enabled"},"id":{"$ref":"#/definitions/account-feature/definitions/id"},"name":{"$ref":"#/definitions/account-feature/definitions/name"},"state":{"$ref":"#/definitions/account-feature/definitions/state"},"updated_at":{"$ref":"#/definitions/account-feature/definitions/updated_at"}}},"user-preferences":{"description":"Tracks a user's preferences and message dismissals","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - User Preferences","type":["object"],"definitions":{"timezone":{"description":"User's default timezone","example":"UTC","readOnly":false,"type":["string","null"]},"dismissed-github-banner":{"description":"Whether the user has dismissed the GitHub link banner","example":true,"readOnly":false,"type":["boolean","null"]},"dismissed-getting-started":{"description":"Whether the user has dismissed the getting started banner","example":true,"readOnly":false,"type":["boolean","null"]},"dismissed-org-access-controls":{"description":"Whether the user has dismissed the Organization Access Controls banner","example":true,"readOnly":false,"type":["boolean","null"]},"dismissed-org-wizard-notification":{"description":"Whether the user has dismissed the Organization Wizard","example":true,"readOnly":false,"type":["boolean","null"]},"dismissed-pricing-callout":{"description":"Whether the user has dismissed the new pricing banner","example":true,"readOnly":false,"type":["boolean","null"]},"dismissed-sms-banner":{"description":"Whether the user has dismissed the 2FA SMS banner","example":true,"readOnly":false,"type":["boolean","null"]}},"links":[{"description":"Retrieve User Preferences","href":"/users/~/preferences","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/user-preferences"},"title":"User Preferences"},{"description":"Update User Preferences","href":"/users/~/preferences","method":"PATCH","rel":"update","schema":{"properties":{"timezone":{"$ref":"#/definitions/user-preferences/definitions/timezone"},"dismissed-github-banner":{"$ref":"#/definitions/user-preferences/definitions/dismissed-github-banner"},"dismissed-getting-started":{"$ref":"#/definitions/user-preferences/definitions/dismissed-getting-started"},"dismissed-org-access-controls":{"$ref":"#/definitions/user-preferences/definitions/dismissed-org-access-controls"},"dismissed-org-wizard-notification":{"$ref":"#/definitions/user-preferences/definitions/dismissed-org-wizard-notification"},"dismissed-pricing-callout":{"$ref":"#/definitions/user-preferences/definitions/dismissed-pricing-callout"},"dismissed-sms-banner":{"$ref":"#/definitions/user-preferences/definitions/dismissed-sms-banner"}}},"targetSchema":{"$ref":"#/definitions/user-preferences"},"title":"Update"}],"properties":{"timezone":{"$ref":"#/definitions/user-preferences/definitions/timezone"},"dismissed-github-banner":{"$ref":"#/definitions/user-preferences/definitions/dismissed-github-banner"},"dismissed-getting-started":{"$ref":"#/definitions/user-preferences/definitions/dismissed-getting-started"},"dismissed-org-access-controls":{"$ref":"#/definitions/user-preferences/definitions/dismissed-org-access-controls"},"dismissed-org-wizard-notification":{"$ref":"#/definitions/user-preferences/definitions/dismissed-org-wizard-notification"},"dismissed-pricing-callout":{"$ref":"#/definitions/user-preferences/definitions/dismissed-pricing-callout"},"dismissed-sms-banner":{"$ref":"#/definitions/user-preferences/definitions/dismissed-sms-banner"}}},"account":{"description":"An account represents an individual signed up to use the Heroku platform.","$schema":"http://json-schema.org/draft-04/hyper-schema","stability":"production","strictProperties":true,"title":"Heroku Platform API - Account","type":["object"],"definitions":{"allow_tracking":{"default":true,"description":"whether to allow third party web activity tracking","example":true,"readOnly":false,"type":["boolean"]},"beta":{"default":false,"description":"whether allowed to utilize beta Heroku features","example":false,"readOnly":false,"type":["boolean"]},"created_at":{"description":"when account was created","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"email":{"description":"unique email address of account","example":"username@example.com","format":"email","readOnly":false,"type":["string"]},"id":{"description":"unique identifier of an account","example":"01234567-89ab-cdef-0123-456789abcdef","format":"uuid","readOnly":true,"type":["string"]},"identity":{"anyOf":[{"$ref":"#/definitions/account/definitions/email"},{"$ref":"#/definitions/account/definitions/id"}]},"last_login":{"description":"when account last authorized with Heroku","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"name":{"description":"full name of the account owner","example":"Tina Edmonds","readOnly":false,"type":["string","null"]},"new_password":{"description":"the new password for the account when changing the password","example":"newpassword","readOnly":true,"type":["string"]},"password":{"description":"current password on the account","example":"currentpassword","readOnly":true,"type":["string"]},"two_factor_authentication":{"description":"whether two-factor auth is enabled on the account","example":false,"readOnly":true,"type":["boolean"]},"updated_at":{"description":"when account was updated","example":"2012-01-01T12:00:00Z","format":"date-time","readOnly":true,"type":["string"]},"verified":{"default":false,"description":"whether account has been verified with billing information","example":false,"readOnly":true,"type":["boolean"]}},"links":[{"description":"Info for account.","href":"/account","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/account"},"title":"Info"},{"description":"Update account.","href":"/account","method":"PATCH","rel":"update","schema":{"properties":{"allow_tracking":{"$ref":"#/definitions/account/definitions/allow_tracking"},"beta":{"$ref":"#/definitions/account/definitions/beta"},"name":{"$ref":"#/definitions/account/definitions/name"},"password":{"$ref":"#/definitions/account/definitions/password"}},"type":["object"]},"targetSchema":{"$ref":"#/definitions/account"},"title":"Update"},{"description":"Change Email for account.","href":"/account","method":"PATCH","rel":"update","schema":{"properties":{"email":{"$ref":"#/definitions/account/definitions/email"},"password":{"$ref":"#/definitions/account/definitions/password"}},"required":["password","email"],"type":["object"]},"title":"Change Email"},{"description":"Change Password for account.","href":"/account","method":"PATCH","rel":"update","schema":{"properties":{"new_password":{"$ref":"#/definitions/account/definitions/new_password"},"password":{"$ref":"#/definitions/account/definitions/password"}},"required":["new_password","password"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/account"},"title":"Change Password"},{"description":"Delete account. Note that this action cannot be undone.","href":"/account","method":"DELETE","rel":"destroy","targetSchema":{"$ref":"#/definitions/account"},"title":"Delete"},{"description":"Info for account.","href":"/users/{(%23%2Fdefinitions%2Faccount%2Fdefinitions%2Fidentity)}","method":"GET","rel":"self","targetSchema":{"$ref":"#/definitions/account"},"title":"Info"},{"description":"Update account.","href":"/users/{(%23%2Fdefinitions%2Faccount%2Fdefinitions%2Fidentity)}","method":"PATCH","rel":"update","schema":{"properties":{"allow_tracking":{"$ref":"#/definitions/account/definitions/allow_tracking"},"beta":{"$ref":"#/definitions/account/definitions/beta"},"name":{"$ref":"#/definitions/account/definitions/name"},"password":{"$ref":"#/definitions/account/definitions/password"}},"type":["object"]},"targetSchema":{"$ref":"#/definitions/account"},"title":"Update"},{"description":"Change Email for account.","href":"/users/{(%23%2Fdefinitions%2Faccount%2Fdefinitions%2Fidentity)}","method":"PATCH","rel":"update","schema":{"properties":{"email":{"$ref":"#/definitions/account/definitions/email"},"password":{"$ref":"#/definitions/account/definitions/password"}},"required":["password","email"],"type":["object"]},"title":"Change Email"},{"description":"Change Password for account.","href":"/users/{(%23%2Fdefinitions%2Faccount%2Fdefinitions%2Fidentity)}","method":"PATCH","rel":"update","schema":{"properties":{"new_password":{"$ref":"#/definitions/account/definitions/new_password"},"password":{"$ref":"#/definitions/account/definitions/password"}},"required":["new_password","password"],"type":["object"]},"targetSchema":{"$ref":"#/definitions/account"},"title":"Change Password"},{"description":"Delete account. Note that this action cannot be undone.","href":"/users/{(%23%2Fdefinitions%2Faccount%2Fdefinitions%2Fidentity)}","method":"DELETE","rel":"destroy","targetSchema":{"$ref":"#/definitions/account"},"title":"Delete"}],"properties":{"allow_tracking":{"$ref":"#/definitions/account/definitions/allow_tracking"},"beta":{"$ref":"#/definitions/account/definitions/beta"},"created_at":{"$ref":"#/definitions/account/definitions/created_at"},"email":{"$ref":"#/definitions/account/definitions/email"},"id":{"$ref":"#/definitions/account/definitions/id"},"last_login":{"$ref":"#/definitions/account/definitions/last_login"},"name":{"$ref":"#/definitions/account/definitions/name"},"two_factor_authentication":{"$ref":"#/definitions/account/definitions/two_factor_authentication"},"updated_at":{"$ref":"#/definitions/account/definitions/updated_at"},"verified":{"$ref":"#/definitions/account/definitions/verified"},"default_organization":{"description":"organization selected by default","properties":{"id":{"$ref":"#/definitions/organization/definitions/id"},"name":{"$ref":"#/definitions/organization/definitions/name"}},"strictProperties":true,"type":["object","null"]}}}},"properties":{"addon-attachment":{"$ref":"#/definitions/addon-attachment"},"addon-service":{"$ref":"#/definitions/addon-service"},"addon":{"$ref":"#/definitions/addon"},"app-feature":{"$ref":"#/definitions/app-feature"},"app-setup":{"$ref":"#/definitions/app-setup"},"app-transfer":{"$ref":"#/definitions/app-transfer"},"app":{"$ref":"#/definitions/app"},"build-result":{"$ref":"#/definitions/build-result"},"build":{"$ref":"#/definitions/build"},"buildpack-installation":{"$ref":"#/definitions/buildpack-installation"},"collaborator":{"$ref":"#/definitions/collaborator"},"config-var":{"$ref":"#/definitions/config-var"},"credit":{"$ref":"#/definitions/credit"},"domain":{"$ref":"#/definitions/domain"},"dyno":{"$ref":"#/definitions/dyno"},"event":{"$ref":"#/definitions/event"},"formation":{"$ref":"#/definitions/formation"},"invoice":{"$ref":"#/definitions/invoice"},"invoice_address":{"$ref":"#/definitions/invoice_address"},"key":{"$ref":"#/definitions/key"},"log-drain":{"$ref":"#/definitions/log-drain"},"log-session":{"$ref":"#/definitions/log-session"},"oauth-authorization":{"$ref":"#/definitions/oauth-authorization"},"oauth-client":{"$ref":"#/definitions/oauth-client"},"oauth-grant":{"$ref":"#/definitions/oauth-grant"},"oauth-token":{"$ref":"#/definitions/oauth-token"},"organization-app-collaborator":{"$ref":"#/definitions/organization-app-collaborator"},"organization-app":{"$ref":"#/definitions/organization-app"},"organization-invoice":{"$ref":"#/definitions/organization-invoice"},"organization-member":{"$ref":"#/definitions/organization-member"},"organization":{"$ref":"#/definitions/organization"},"otp-secret":{"$ref":"#/definitions/otp-secret"},"payment":{"$ref":"#/definitions/payment"},"payment_method":{"$ref":"#/definitions/payment_method"},"plan":{"$ref":"#/definitions/plan"},"rate-limit":{"$ref":"#/definitions/rate-limit"},"recovery-code":{"$ref":"#/definitions/recovery-code"},"region":{"$ref":"#/definitions/region"},"release":{"$ref":"#/definitions/release"},"slug":{"$ref":"#/definitions/slug"},"source":{"$ref":"#/definitions/source"},"ssl-endpoint":{"$ref":"#/definitions/ssl-endpoint"},"stack":{"$ref":"#/definitions/stack"},"account-feature":{"$ref":"#/definitions/account-feature"},"user-preferences":{"$ref":"#/definitions/user-preferences"},"account":{"$ref":"#/definitions/account"}},"description":"The platform API empowers developers to automate, extend and combine Heroku with other services.","id":"http://api.heroku.com/schema#","links":[{"href":"https://api.heroku.com","rel":"self"},{"href":"/schema","method":"GET","rel":"self","targetSchema":{"additionalProperties":true}}],"title":"Heroku Platform API"}
1703
- HEROICS_SCHEMA
1704
- end
1
+ bundler: command not found: heroics-generate
2
+ Install missing gem executables with `bundle install`