UNPKG

openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

1 lines 201 kB
{"openapi":"3.0.0","info":{"title":"IllumiDesk","version":"1.0","x-apisguru-categories":["open_data"],"x-logo":{"backgroundColor":"#FFFFFF","url":"https://avatars3.githubusercontent.com/u/12212444?v=4&s=200"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/3Blades/openapi/master/tbs_swagger.yml","version":"2.0"}],"x-providerName":"illumidesk.com"},"security":[{"jwt":[]}],"paths":{"/auth/jwt-token-auth/":{"post":{"operationId":"auth_jwt-token-auth","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JWTData"}}}},"responses":{"201":{"description":"JWT created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JWT"},"examples":{"response":{"value":{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ"}}}},"text/html":{"schema":{"$ref":"#/components/schemas/JWT"}}}},"400":{"description":"Invalid data supplied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JWTError"}},"text/html":{"schema":{"$ref":"#/components/schemas/JWTError"}}}}},"security":[],"summary":"Create JSON Web Token (JWT)","tags":["auth"]}},"/auth/jwt-token-refresh/":{"post":{"description":"Obtains a new JSON Web Token using existing user credentials.","operationId":"auth_jwt-token-refresh","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshJSONWebTokenData"}}}},"responses":{"201":{"description":"RefreshJSONWebToken created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshJSONWebToken"}},"text/html":{"schema":{"$ref":"#/components/schemas/RefreshJSONWebToken"}}}},"400":{"description":"Invalid data supplied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshJSONWebTokenError"}},"text/html":{"schema":{"$ref":"#/components/schemas/RefreshJSONWebTokenError"}}}}},"security":[],"summary":"Refresh a JSON Web Token (JWT)","tags":["auth"]}},"/auth/jwt-token-verify/":{"post":{"description":"Checks veraciy of token.","operationId":"auth_jwt-token-verify","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyJSONWebTokenData"}}}},"responses":{"201":{"description":"VerifyJSONWebToken created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyJSONWebToken"},"examples":{"response":{"value":{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ"}}}},"text/html":{"schema":{"$ref":"#/components/schemas/VerifyJSONWebToken"}}}},"400":{"description":"Invalid data supplied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyJSONWebTokenError"}},"text/html":{"schema":{"$ref":"#/components/schemas/VerifyJSONWebTokenError"}}}}},"security":[],"summary":"Validate JSON Web Token (JWT)","tags":["auth"]}},"/auth/login/{provider}/":{"get":{"operationId":"oauth_login","parameters":[{"description":"OAuth2 provider","in":"path","name":"provider","required":true,"schema":{"type":"string","enum":["github","google","slack"]}}],"responses":{"302":{"description":"Redirect to backend auth page"}},"tags":["auth"]}},"/auth/register/":{"post":{"description":"User registration requires confirming email address to activate user.","operationId":"auth_register","requestBody":{"$ref":"#/components/requestBodies/UserData"},"responses":{"201":{"description":"User created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"examples":{"response":{"value":{"email":"user@email.com","first_name":"John","id":"536686d7-0096-4c72-a4c3-5d710a361a0a","last_name":"Doe","profile":{"avatar_url":"http://example.com/","bio":"I like tests","company":"IllumiDesk","location":"Atlanta, GA","timezone":"America/New_York","url":"http://about.me/myprofile"},"username":"johndoe"}}}},"text/html":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"description":"Invalid data supplied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserError"}},"text/html":{"schema":{"$ref":"#/components/schemas/UserError"}}}}},"security":[],"summary":"Register a user","tags":["auth"]}},"/v1/me":{"get":{"operationId":"me","responses":{"200":{"description":"User information retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"examples":{"response":{"value":{"email":"johndoe@email.com","first_name":"John","id":"66949654-1f75-4c6f-a5c5-e3572eae6527","last_name":"Doe","profile":{"avatar_url":"http://example.com/","bio":"I like tests","company":"3Blades","location":"Atlanta, GA","timezone":"America/New_York","url":"http://about.me/myprofile"},"username":"johndoe"}}}},"text/html":{"schema":{"$ref":"#/components/schemas/User"}}}}},"summary":"A convenience endpoint that is equivalent to GET /v1/users/profiles/<my user id>/","tags":["users"]}},"/v1/servers/options/server-size/":{"get":{"operationId":"servers_options_sizes_list","parameters":[{"description":"Set limit when retrieving items.","in":"query","name":"limit","required":false,"schema":{"type":"string"}},{"description":"Offset when retrieving items.","in":"query","name":"offset","required":false,"schema":{"type":"string"}},{"description":"Set order when retrieving items.","in":"query","name":"ordering","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Server size list.","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ServerSize"},"type":"array"},"examples":{"response":{"value":[]}}},"text/html":{"schema":{"items":{"$ref":"#/components/schemas/ServerSize"},"type":"array"}}}}},"summary":"Retrieve available server sizes","tags":["servers"]},"post":{"description":"Only super users with on-premises version have acceess to this endpoint.","operationId":"servers_options_server_size_create","requestBody":{"$ref":"#/components/requestBodies/ServerSizeData"},"responses":{"201":{"description":"ServerSize created. This operation is available only to super users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerSize"},"examples":{"response":{"value":{"active":true,"cpu":1,"id":"2f4a5830-169d-4111-b913-e68c7b94fdbe","memory":512,"name":"myResource"}}}},"text/html":{"schema":{"$ref":"#/components/schemas/ServerSize"}}}},"400":{"description":"Invalid data supplied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerSizeError"}},"text/html":{"schema":{"$ref":"#/components/schemas/ServerSizeError"}}}}},"summary":"Create a new server size item","tags":["servers"]}},"/v1/servers/options/server-size/{size}/":{"delete":{"description":"Only super users with on-premises version have acceess to this endpoint.","operationId":"servers_options_server_size_delete","parameters":[{"description":"Server size unique identifier expressed as UUID or name.","in":"path","name":"size","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Server size deleted. This operation is available only to super users"},"404":{"description":"ServerSize not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Delete a server size by id","tags":["servers"]},"get":{"operationId":"servers_options_resources_read","parameters":[{"description":"Server size unique identifier expressed as UUID or name.","in":"path","name":"size","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Environment resource retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerSize"},"examples":{"response":{"value":{"active":true,"cpu":1,"id":"2f4a5830-169d-4111-b913-e68c7b94fdbe","memory":512,"name":"myResource"}}}},"text/html":{"schema":{"$ref":"#/components/schemas/ServerSize"}}}},"404":{"description":"Environment resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Get a server size by id","tags":["servers"]},"patch":{"description":"Only super users with on-premises version have acceess to this endpoint.","operationId":"servers_options_server_size_update","parameters":[{"description":"Server size unique identifier expressed as UUID or name.","in":"path","name":"size","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/ServerSizeData"},"responses":{"200":{"description":"Server size updated. This operation is available only to super users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerSize"},"examples":{"response":{"value":{"active":true,"cpu":1,"id":"b673c7ab-65ad-4d6e-859e-0483eea86ad6","memory":512,"name":"myServerSizeWithPatch"}}}},"text/html":{"schema":{"$ref":"#/components/schemas/ServerSize"}}}},"400":{"description":"Invalid data supplied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerSizeError"}},"text/html":{"schema":{"$ref":"#/components/schemas/ServerSizeError"}}}},"404":{"description":"Server size not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Update a server size by id","tags":["servers"]},"put":{"description":"Only super users with on-premises version have acceess to this endpoint.","operationId":"servers_options_server_size_replace","parameters":[{"description":"Server size unique identifier expressed as UUID or name.","in":"path","name":"size","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/ServerSizeData"},"responses":{"200":{"description":"Server size replaced. This operation is available only to super users.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerSize"},"examples":{"response":{"value":{"active":true,"cpu":1,"id":"b673c7ab-65ad-4d6e-859e-0483eea86ad6","memory":512,"name":"myResourceWithPut"}}}},"text/html":{"schema":{"$ref":"#/components/schemas/ServerSize"}}}},"400":{"description":"Invalid data supplied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerSizeError"}},"text/html":{"schema":{"$ref":"#/components/schemas/ServerSizeError"}}}},"404":{"description":"ServerSize not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Replace a server size by id","tags":["servers"]}},"/v1/teams/":{"get":{"operationId":"teams_list","parameters":[{"description":"Limit when getting data.","in":"query","name":"limit","required":false,"schema":{"type":"string"}},{"description":"Offset when getting data.","in":"query","name":"offset","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team list","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Team"},"type":"array"},"examples":{"response":{"value":[]}}},"text/html":{"schema":{"items":{"$ref":"#/components/schemas/Team"},"type":"array"}}}}},"summary":"Get teams","tags":["teams"]},"post":{"operationId":"teams_create","requestBody":{"$ref":"#/components/requestBodies/TeamData"},"responses":{"201":{"description":"Team created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}},"text/html":{"schema":{"$ref":"#/components/schemas/Team"}}}},"400":{"description":"Invalid data supplied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamError"}},"text/html":{"schema":{"$ref":"#/components/schemas/TeamError"}}}}},"summary":"Create a new team","tags":["teams"]}},"/v1/teams/{team}/":{"delete":{"operationId":"teams_delete","parameters":[{"description":"Team unique identifier expressed as UUID or name.","in":"path","name":"team","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Team deleted."},"404":{"description":"Team not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Delete a team","tags":["teams"]},"get":{"operationId":"teams_read","parameters":[{"description":"Team unique identifier expressed as UUID or name.","in":"path","name":"team","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}},"text/html":{"schema":{"$ref":"#/components/schemas/Team"}}}},"404":{"description":"Team not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Get a team","tags":["teams"]},"patch":{"operationId":"teams_update","parameters":[{"description":"Team unique identifier expressed as UUID or name.","in":"path","name":"team","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/TeamData"},"responses":{"200":{"description":"Team updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}},"text/html":{"schema":{"$ref":"#/components/schemas/Team"}}}},"400":{"description":"Invalid data supplied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamError"}},"text/html":{"schema":{"$ref":"#/components/schemas/TeamError"}}}},"404":{"description":"Team not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Update a team","tags":["teams"]},"put":{"operationId":"teams_replace","parameters":[{"description":"Team unique identifier expressed as UUID or name.","in":"path","name":"team","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/TeamData"},"responses":{"200":{"description":"Team updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Team"}},"text/html":{"schema":{"$ref":"#/components/schemas/Team"}}}},"400":{"description":"Invalid data supplied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeamError"}},"text/html":{"schema":{"$ref":"#/components/schemas/TeamError"}}}}},"summary":"Replace a team","tags":["teams"]}},"/v1/teams/{team}/billing/invoices/":{"get":{"operationId":"teams_billing_invoices_list","parameters":[{"description":"Team unique identifier expressed as UUID or name.","in":"path","name":"team","required":true,"schema":{"type":"string"}},{"description":"Limit when getting items.","in":"query","name":"limit","required":false,"schema":{"type":"string"}},{"description":"Offset when getting items.","in":"query","name":"offset","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Invoice list.","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Invoice"},"type":"array"},"examples":{"response":{"value":[]}}},"text/html":{"schema":{"items":{"$ref":"#/components/schemas/Invoice"},"type":"array"}}}}},"summary":"Get team invoices","tags":["teams","billing"]}},"/v1/teams/{team}/billing/invoices/{id}/":{"get":{"operationId":"teams_billing_invoices_read","parameters":[{"description":"Team unique identifier expressed as UUID or name.","in":"path","name":"team","required":true,"schema":{"type":"string"}},{"description":"Invoice unique identifier expressed as UUID.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team invoice retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Invoice"}},"text/html":{"schema":{"$ref":"#/components/schemas/Invoice"}}}},"404":{"description":"Team invoice not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Get an invoice","tags":["teams","billing"]}},"/v1/teams/{team}/billing/invoices/{invoice_id}/invoice-items/":{"get":{"operationId":"teams_billing_invoice_items_list","parameters":[{"description":"Team unique identifier expressed as UUID or name.","in":"path","name":"team","required":true,"schema":{"type":"string"}},{"description":"Invoice id, expressed as UUID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"Limit when getting items.","in":"query","name":"limit","required":false,"schema":{"type":"string"}},{"description":"Offset when getting items.","in":"query","name":"offset","required":false,"schema":{"type":"string"}},{"description":"Ordering when getting items.","in":"query","name":"ordering","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team invoiceItem list.","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/InvoiceItem"},"type":"array"},"examples":{"response":{"value":[]}}},"text/html":{"schema":{"items":{"$ref":"#/components/schemas/InvoiceItem"},"type":"array"}}}}},"summary":"Get team invoice items for a given invoice.","tags":["teams","billing"]}},"/v1/teams/{team}/billing/invoices/{invoice_id}/invoice-items/{id}":{"get":{"operationId":"teams_billing_invoice_items_read","parameters":[{"description":"Team unique identifier expressed as UUID or name.","in":"path","name":"team","required":true,"schema":{"type":"string"}},{"description":"Invoice id, expressed as UUID.","in":"path","name":"invoice_id","required":true,"schema":{"type":"string"}},{"description":"InvoiceItem id, expressed as UUID.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team invoiceItem retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceItem"}},"text/html":{"schema":{"$ref":"#/components/schemas/InvoiceItem"}}}},"404":{"description":"InvoiceItem not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Get a specific team InvoiceItem.","tags":["teams","billing"]}},"/v1/teams/{team}/billing/subscriptions/":{"get":{"operationId":"teams_billing_subscriptions_list","parameters":[{"description":"Team unique identifier expressed as UUID or name.","in":"path","name":"team","required":true,"schema":{"type":"string"}},{"description":"Limit when getting items.","in":"query","name":"limit","required":false,"schema":{"type":"string"}},{"description":"Offset when getting items.","in":"query","name":"offset","required":false,"schema":{"type":"string"}},{"description":"Ordering when getting items.","in":"query","name":"ordering","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Teams subscription list.","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Subscription"},"type":"array"},"examples":{"response":{"value":[{"application_fee_percent":0,"cancel_at_period_end":false,"canceled_at":"","created":"2025-04-15T13:49:50.752Z","current_period_end":"2025-04-15T13:49:50.752Z","current_period_start":"2025-04-15T13:49:50.752Z","ended_at":"","id":"579208c3-4f5c-4b5d-baa3-309a06db681c","livemode":false,"plan":"efb36cb0-0ef2-4af3-ae5d-10d9ae73845d","quantity":1,"start":"2025-04-15T13:49:50.752Z","status":"trialing","stripe_id":"sub_B5KyO9BZ6lUNPP","trial_end":"2025-04-15T13:49:50.752Z","trial_start":"2025-04-15T13:49:50.752Z"}]}}},"text/html":{"schema":{"items":{"$ref":"#/components/schemas/Subscription"},"type":"array"}}}}},"summary":"Get active team subscriptons","tags":["teams","billing"]},"post":{"operationId":"teams_billing_subscriptions_create","parameters":[{"description":"Team unique identifier expressed as UUID or name.","in":"path","name":"team","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/SubscriptionData"},"responses":{"201":{"description":"Team subscription created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"},"examples":{"response":{"value":{"application_fee_percent":0,"cancel_at_period_end":false,"canceled_at":"","created":"2025-04-15T13:49:50.752Z","current_period_end":"2025-04-15T13:49:50.752Z","current_period_start":"2025-04-15T13:49:50.752Z","ended_at":"","id":"579208c3-4f5c-4b5d-baa3-309a06db681c","livemode":false,"plan":"efb36cb0-0ef2-4af3-ae5d-10d9ae73845d","quantity":1,"start":"2025-04-15T13:49:50.752Z","status":"trialing","stripe_id":"sub_B5KyO9BZ6lUNPP","trial_end":"2025-04-15T13:49:50.752Z","trial_start":"2025-04-15T13:49:50.752Z"}}}},"text/html":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"400":{"description":"Invalid data supplied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionError"}},"text/html":{"schema":{"$ref":"#/components/schemas/SubscriptionError"}}}}},"summary":"Create a new team subscription","tags":["teams","billing"]}},"/v1/teams/{team}/billing/subscriptions/{id}/":{"delete":{"operationId":"teams_billing_subscriptions_delete","parameters":[{"description":"Team unique identifier expressed as UUID or name.","in":"path","name":"team","required":true,"schema":{"type":"string"}},{"description":"Subscription unique identifier expressed as UUID.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Subscription deleted."},"404":{"description":"Subscription not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Delete a subscription","tags":["teams","billing"]},"get":{"operationId":"teams_billing_subscriptions_read","parameters":[{"description":"Team unique identifier expressed as UUID or name.","in":"path","name":"team","required":true,"schema":{"type":"string"}},{"description":"Unique identifier expressed as UUID.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team subscription retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}},"text/html":{"schema":{"$ref":"#/components/schemas/Subscription"}}}},"404":{"description":"Subscription not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Get team subscriptions","tags":["teams","billing"]}},"/v1/teams/{team}/groups/":{"get":{"operationId":"teams_groups_list","parameters":[{"description":"Team unique identifier expressed as UUID or name.","in":"path","name":"team","required":true,"schema":{"type":"string"}},{"description":"Limit when getting data.","in":"query","name":"limit","required":false,"schema":{"type":"string"}},{"description":"Offset when getting data.","in":"query","name":"offset","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Team groups list","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Group"},"type":"array"}},"text/html":{"schema":{"items":{"$ref":"#/components/schemas/Group"},"type":"array"}}}}},"summary":"Get team groups","tags":["teams"]}},"/v1/teams/{team}/groups/{group}/":{"delete":{"operationId":"teams_groups_delete","parameters":[{"description":"Team unique identifier expressed as UUID or name.","in":"path","name":"team","required":true,"schema":{"type":"string"}},{"description":"Group unique identifier expressed as UUID or name.","in":"path","name":"group","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Group deleted"},"404":{"description":"Group not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Delete team group","tags":["teams"]},"get":{"operationId":"teams_groups_read","parameters":[{"description":"Team unique identifier expressed as UUID or name.","in":"path","name":"team","required":true,"schema":{"type":"string"}},{"description":"Group unique identifier expressed as UUID or name.","in":"path","name":"group","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Group retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}},"text/html":{"schema":{"$ref":"#/components/schemas/Group"}}}}},"summary":"Get team group","tags":["teams"]},"patch":{"operationId":"teams_groups_update","parameters":[{"description":"Team unique identifier expressed as UUID or name.","in":"path","name":"team","required":true,"schema":{"type":"string"}},{"description":"Group unique identifier expressed as UUID or name.","in":"path","name":"group","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/GroupData"},"responses":{"200":{"description":"Group updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}},"text/html":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"description":"Invalid data supplied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupError"}},"text/html":{"schema":{"$ref":"#/components/schemas/GroupError"}}}},"404":{"description":"Group not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Patch team group","tags":["teams"]},"put":{"operationId":"teams_groups_replace","parameters":[{"description":"Team unique identifier expressed as UUID or name.","in":"path","name":"team","required":true,"schema":{"type":"string"}},{"description":"Group unique identifier expressed as UUID or name.","in":"path","name":"group","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/GroupData"},"responses":{"200":{"description":"Group replaced","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}},"text/html":{"schema":{"$ref":"#/components/schemas/Group"}}}},"400":{"description":"Invalid data supplied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupError"}},"text/html":{"schema":{"$ref":"#/components/schemas/GroupError"}}}}},"summary":"Patch team group","tags":["teams"]}},"/v1/teams/{team}/groups/{group}/add/":{"post":{"operationId":"teams_groups_add_to_group","parameters":[{"description":"Team unique identifier expressed as UUID or name.","in":"path","name":"team","required":true,"schema":{"type":"string"}},{"description":"Group unique identifier expressed as UUID or name.","in":"path","name":"group","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User added to group.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupUser"}},"text/html":{"schema":{"$ref":"#/components/schemas/GroupUser"}}}},"400":{"description":"Invalid data supplied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupUserError"}},"text/html":{"schema":{"$ref":"#/components/schemas/GroupUserError"}}}},"404":{"description":"Group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Add user to group","tags":["teams"]}},"/v1/teams/{team}/groups/{group}/remove/":{"post":{"operationId":"teams_groups_remove_from_group","parameters":[{"description":"Team unique identifier expressed as UUID or name.","in":"path","name":"team","required":true,"schema":{"type":"string"}},{"description":"Group unique identifier expressed as UUID or name.","in":"path","name":"group","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User removed from group."},"400":{"description":"Invalid data supplied"},"404":{"description":"Group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"User removed from group","tags":["teams"]}},"/v1/users/profiles/":{"get":{"operationId":"users_list","parameters":[{"description":"Limit user list.","in":"query","name":"limit","required":false,"schema":{"type":"string"}},{"description":"Offset when getting users.","in":"query","name":"offset","required":false,"schema":{"type":"string"}},{"description":"User username.","in":"query","name":"username","required":false,"schema":{"type":"string"}},{"description":"User email.","in":"query","name":"email","required":false,"schema":{"type":"string"}},{"description":"Ordering when getting users.","in":"query","name":"ordering","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"User list","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/User"},"type":"array"},"examples":{"response":{"value":[{"email":"johndoe@email.com","first_name":"John","id":"66949654-1f75-4c6f-a5c5-e3572eae6527","last_name":"Doe","profile":{"avatar_url":"http://example.com/","bio":"I like tests","company":"3Blades","location":"Atlanta, GA","timezone":"America/New_York","url":"http://about.me/myprofile"},"username":"johndoe"},{"email":"janedoe@email.com","first_name":"John","id":"66949654-1f75-4c6f-a5c5-e3572eae6527","last_name":"Doe","profile":{"avatar_url":"http://example.com/","bio":"I like tests","company":"3Blades","location":"Atlanta, GA","timezone":"America/New_York","url":"http://about.me/myprofile"},"username":"janedoe"}]}}},"text/html":{"schema":{"items":{"$ref":"#/components/schemas/User"},"type":"array"}}}}},"summary":"Get user list","tags":["users"]},"post":{"description":"Only admin users can create new users. New users have active status by default.","operationId":"users_create","requestBody":{"$ref":"#/components/requestBodies/UserData"},"responses":{"201":{"description":"User created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"examples":{"response":{"value":{"email":"johndoe@email.com","first_name":"John","id":"66949654-1f75-4c6f-a5c5-e3572eae6527","last_name":"Doe","profile":{"avatar_url":"http://example.com/","bio":"I like tests","company":"3Blades","location":"Atlanta, GA","timezone":"America/New_York","url":"http://about.me/myprofile"},"username":"johndoe"}}}},"text/html":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"description":"Invalid data supplied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserError"}},"text/html":{"schema":{"$ref":"#/components/schemas/UserError"}}}}},"summary":"Create new user","tags":["users"]}},"/v1/users/profiles/{user}/":{"delete":{"operationId":"users_delete","parameters":[{"description":"User identifier expressed as UUID or username.","in":"path","name":"user","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"User deleted."},"404":{"description":"User not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Delete a user","tags":["users"]},"get":{"operationId":"users_read","parameters":[{"description":"Unique identifier expressed as UUID or username.","in":"path","name":"user","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"examples":{"response":{"value":{"email":"johndoe@email.com","first_name":"John","id":"66949654-1f75-4c6f-a5c5-e3572eae6527","last_name":"Doe","profile":{"avatar_url":"http://example.com/","bio":"I like tests","company":"3Blades","location":"Atlanta, GA","timezone":"America/New_York","url":"http://about.me/myprofile"},"username":"johndoe"}}}},"text/html":{"schema":{"$ref":"#/components/schemas/User"}}}},"404":{"description":"User not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Retrieve a user","tags":["users"]},"patch":{"operationId":"users_update","parameters":[{"description":"User unique identifier expressed as UUID or username.","in":"path","name":"user","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/UserData"},"responses":{"200":{"description":"User updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"},"examples":{"response":{"value":{"email":"runB@email.com","first_name":"John","id":"66949654-1f75-4c6f-a5c5-e3572eae6527","last_name":"Doe","profile":{"avatar_url":"http://example.com/","bio":"Data updated with patch","company":"3Blades","location":"Atlanta, GA","timezone":"America/New_York","url":"http://about.me/myprofile"},"username":"johndoe"}}}},"text/html":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"description":"Invalid data supplied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserError"}},"text/html":{"schema":{"$ref":"#/components/schemas/UserError"}}}},"404":{"description":"User not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Update a user","tags":["users"]}},"/v1/users/{user}/api-key/":{"get":{"operationId":"users_api-key_list","parameters":[{"description":"User unique identifier expressed as UUID or username.","in":"path","name":"user","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Api Key"}},"summary":"Retrieve account's API key","tags":["users"]}},"/v1/users/{user}/avatar/":{"delete":{"operationId":"user_avatar_delete","parameters":[{"description":"User unique identifier expressed as UUID or username.","in":"path","name":"user","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Avatar deleted"},"404":{"description":"Avatar not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Delete avatar","tags":["users"]},"get":{"operationId":"user_avatar_get","parameters":[{"description":"User unique identifier expressed as UUIDor username.","in":"path","name":"user","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"User avatar"}},"summary":"Retrieve user's avatar","tags":["users"]},"patch":{"operationId":"user_avatar_update","parameters":[{"description":"User unique identifier expressed as UUID or username.","in":"path","name":"user","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Avatar updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}},"text/html":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"description":"Invalid data supplied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserError"}},"text/html":{"schema":{"$ref":"#/components/schemas/UserError"}}}},"404":{"description":"Avatar not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Update a project file","tags":["users"]},"post":{"operationId":"user_avatar_set","parameters":[{"description":"User unique identifier expressed as UUID or username.","in":"path","name":"user","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Added user avatar","content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}},"text/html":{"schema":{"$ref":"#/components/schemas/User"}}}},"400":{"description":"Invalid data supplied"}},"summary":"Add user avatar","tags":["users"]}},"/v1/users/{user}/emails/":{"get":{"operationId":"users_emails_list","parameters":[{"description":"User unique identifier as expressed as UUID or username.","in":"path","name":"user","required":true,"schema":{"type":"string"}},{"description":"Limite when getting email list.","in":"query","name":"limit","required":false,"schema":{"type":"string"}},{"description":"Offset when getting email list.","in":"query","name":"offset","required":false,"schema":{"type":"string"}},{"description":"Ordering when getting email list.","in":"query","name":"ordering","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Email list","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Email"},"type":"array"},"examples":{"response":{"value":[]}}},"text/html":{"schema":{"items":{"$ref":"#/components/schemas/Email"},"type":"array"}}}}},"summary":"Retrieve account email addresses","tags":["users"]},"post":{"operationId":"users_emails_create","parameters":[{"description":"User unique identifier expressed as UUID or username.","in":"path","name":"user","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/EmailData"},"responses":{"201":{"description":"Email created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Email"},"examples":{"response":{"value":{"address":"post@email.com","id":"383e0d16-2052-4196-95b8-d9d73ed043a9","public":true,"unsubscribed":false}}}},"text/html":{"schema":{"$ref":"#/components/schemas/Email"}}}},"400":{"description":"Invalid data supplied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailError"}},"text/html":{"schema":{"$ref":"#/components/schemas/EmailError"}}}}},"summary":"Create an email address","tags":["users"]}},"/v1/users/{user}/emails/{email_id}/":{"delete":{"operationId":"users_emails_delete","parameters":[{"description":"Email unique identifier expressed as UUID.","in":"path","name":"email_id","required":true,"schema":{"type":"string"}},{"description":"User unique identifier expressed as UUID or username.","in":"path","name":"user","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Email deleted."},"404":{"description":"Email not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Delete an email address","tags":["users"]},"get":{"operationId":"users_emails_read","parameters":[{"description":"Email unique identifier expressed as UUID.","in":"path","name":"email_id","required":true,"schema":{"type":"string"}},{"description":"User unique identifier expressed as UUID or username.","in":"path","name":"user","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Email retrieved","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Email"},"examples":{"response":{"value":{"address":"post@email.com","id":"383e0d16-2052-4196-95b8-d9d73ed043a9","public":true,"unsubscribed":false}}}},"text/html":{"schema":{"$ref":"#/components/schemas/Email"}}}},"404":{"description":"Email not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Retrieve a user's email addresses","tags":["users"]},"patch":{"operationId":"users_emails_update","parameters":[{"description":"Email unique identifier expressed as UUID.","in":"path","name":"email_id","required":true,"schema":{"type":"string"}},{"description":"User unique identifier expressed as UUID or username.","in":"path","name":"user","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/EmailData"},"responses":{"200":{"description":"Email updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Email"},"examples":{"response":{"value":{"address":"patch@email.com","id":"383e0d16-2052-4196-95b8-d9d73ed043a9","public":false,"unsubscribed":false}}}},"text/html":{"schema":{"$ref":"#/components/schemas/Email"}}}},"400":{"description":"Invalid data supplied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailError"}},"text/html":{"schema":{"$ref":"#/components/schemas/EmailError"}}}},"404":{"description":"Email not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Update an email address","tags":["users"]},"put":{"operationId":"users_emails_replace","parameters":[{"description":"Email unique identifier expressed as UUID.","in":"path","name":"email_id","required":true,"schema":{"type":"string"}},{"description":"User unique identifier expressed as UUID or username.","in":"path","name":"user","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/EmailData"},"responses":{"200":{"description":"Email updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Email"},"examples":{"response":{"value":{"address":"put@email.com","id":"383e0d16-2052-4196-95b8-d9d73ed043a9","public":false,"unsubscribed":true}}}},"text/html":{"schema":{"$ref":"#/components/schemas/Email"}}}},"400":{"description":"Invalid data supplied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailError"}},"text/html":{"schema":{"$ref":"#/components/schemas/EmailError"}}}}},"summary":"Replace an email address","tags":["users"]}},"/v1/users/{user}/ssh-key/":{"get":{"operationId":"users_ssh-key_list","parameters":[{"description":"User unique identifier expressed as UUID or username.","in":"path","name":"user","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"SSH Key.","content":{"application/json":{"examples":{"response":{"value":{"key":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQCqadyIPIEOF4M7SDoI+MHnAj6q2CY2j62Eg0sNbBbjnuekxnhSWVVKPte+NVtK4MWIyw3wnCCzTjwe0p2pQpMqxjqnCAkBPGhOjrRWTvV54hHTihBxiAEmXqbaBg5e6SaXcqP1OajWYzDqhts4ISer0uymzi0hW65At5i5k87Xu9HSM/Q0ySVJGm0rMuDCIoaTIeQdTkAI9ww/cmOM7uvIDO0OJv2xai9xLB9APVq8zCtqWdivMaqo2waPDT/I9bwtSZxRsnRMakGmj3CWvciHv13UsGlbB7nTeDKX0eyQl/5SADLO0bU+hY/8BpRjjtdq57Pqn/Xyw22YarDkG74gjLG5GBFZkBxcpENoUtCUyE2bhBT4x9yXlTeycMBTopGtzTfIHrJtIgNCFMhg9LbK4IKP/1pLj8SrVaQ9/k/QkxmDFoqfwdGd3AWOghMCAbAB7KaDKrj/XBf/KgTd8ZozjvkTzu2YRf4o3DebxRJipPQumrH3iXX5Kfe9lBWkR7Smewwp2XZrdgBeXN/54hd+Ic3upi528IGzEzu3/xtLT/e7kLi1QH7CVVN1sskZkIRr7aukw4YiVWgVOAlqKzJEoE/BPZSOA0NlgG0h37ZmyhdY1VqtoD+Vnj7Qh272PlTB14ndEVTqGuZhsCSxIhXev+METZ6XezK5n1VQeHGveQ=="}}}}}}},"summary":"Retrieve an SSH key","tags":["users"]}},"/v1/users/{user}/ssh-key/reset/":{"post":{"operationId":"users_ssh-key_reset","parameters":[{"description":"User unique identifier expressed as UUID or username.","in":"path","name":"user","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Reset SSH Key successfully.","content":{"application/json":{"examples":{"response":{"value":{"key":"ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQDhMvg2+n2yNu0H2Hg8uiXfQtAid0WGRigNckb5J0T9GFINmqkYalI/AsWZbl4UfNMviD73h9xowUx+d7s2vB3E8bFxB9OWM22eLSp8fnbuhdI5mKBflq0jr6ms1cR/SD3YsbZ9sX6BqycQrjjYYl7WLM9rgec6b+EYyr/6nbDH/wql06TrNl6LUNkqI+YIqjRvqMeNEY9ux3sB+f46FRKO683u/cRCcp1eWAYf1ByYupIGREbQFLxhYv/NcKD8uIo7DRAuutwHKGOgnAl4WGUVsT5dplhaDYKlDTf2iMiJ+QDT25QABdrkHcIsu5D21AIdH3FI5UQnnu4unyEA77IDLp2EwKRr9k1XQc1o3zQ61+9Gm7Rt80WWgRsnhmshvAIDNcBv1+82kmA9jyeUf3M7KoRJLk6nIbZ1NwoVCX0VF3lRIB0Hvm/dL7Rpk8m/hE0SIIWIGaXbOT4ANFj+TxcF1Mfk7C3/T5/AYLHcq9ocYFKe4Q3Jv7tuHm600edpUfORdpCpjytcKStza07dRDa+OU577r6a1zHMrEMh8oEUtVO5pC1+EaRijTVaOR62DoarHdxJ23Ctk44o0JZfzj9VoVaAwVAhL1aT3pAQxQlWiTKpmYaHUYUp9SRJhyeFr/gpeIGTydKdawkh9Mz8KMlnu1GUolDDuOvSnvidzWaEaw=="}}}}}},"400":{"description":"Invalid data supplied."}},"summary":"Recreate an SSH key","tags":["users"]}},"/v1/{namespace}/billing/cards/":{"get":{"operationId":"billing_cards_list","parameters":[{"description":"User or team name.","in":"path","name":"namespace","required":true,"schema":{"type":"string"}},{"description":"Set limit when retrieving credit or debit cards.","in":"query","name":"limit","required":false,"schema":{"type":"string"}},{"description":"Set offset when retriving cards.","in":"query","name":"offset","required":false,"schema":{"type":"string"}},{"description":"Order when retrieving cards.","in":"query","name":"ordering","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Card list","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Card"},"type":"array"},"examples":{"response":{"value":[]}}},"text/html":{"schema":{"items":{"$ref":"#/components/schemas/Card"},"type":"array"}}}}},"summary":"Get credit cards","tags":["billing"]},"post":{"operationId":"billing_cards_create","parameters":[{"description":"User or team name.","in":"path","name":"namespace","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardDataPost"}}}},"responses":{"201":{"description":"Card created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"},"examples":{"response":{"value":{"address_city":"Atlanta","address_country":"United States","address_line1":"3423 Piedmont Rd NE","address_line1_check":"pass","address_line2":"","address_state":"Georgia","address_zip":"30305","address_zip_check":"pass","brand":"Visa","created":"2025-04-15T13:49:50.752Z","customer":"7e102c7b-55cd-49a0-9b23-58865eba1cc3","cvc_check":"","exp_month":1,"exp_year":2019,"fingerprint":"WpZ4zQymdmF5LhbH","funding":"credit","id":"4126086e-525a-4027-b9e7-ae8de47210b2","last4":"4242","name":"John Doe","stripe_id":"card_1Aj8HuLUHPUzUsaQlDbaXjzA"}}}},"text/html":{"schema":{"$ref":"#/components/schemas/Card"}}}},"400":{"description":"Invalid data supplied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardError"}},"text/html":{"schema":{"$ref":"#/components/schemas/CardError"}}}}},"summary":"Create new credit card","tags":["billing"]}},"/v1/{namespace}/billing/cards/{id}/":{"delete":{"operationId":"billing_cards_delete","parameters":[{"description":"User or team name.","in":"path","name":"namespace","required":true,"schema":{"type":"string"}},{"description":"Card unique identifier expressed as UUID.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Card deleted."},"404":{"description":"Card not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Delete a credit card","tags":["billing"]},"get":{"operationId":"billing_cards_read","parameters":[{"description":"User or team name.","in":"path","name":"namespace","required":true,"schema":{"type":"string"}},{"description":"User unique identifier expressed as UUID.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Card retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"},"examples":{"response":{"value":{"address_city":"Atlanta","address_country":"United States","address_line1":"3423 Piedmont Rd NE","address_line1_check":"pass","address_line2":"","address_state":"Georgia","address_zip":"30305","address_zip_check":"pass","brand":"Visa","created":"2025-04-15T13:49:50.752Z","customer":"7e102c7b-55cd-49a0-9b23-58865eba1cc3","cvc_check":"","exp_month":1,"exp_year":2019,"fingerprint":"WpZ4zQymdmF5LhbH","funding":"credit","id":"4126086e-525a-4027-b9e7-ae8de47210b2","last4":"4242","name":"John Doe","stripe_id":"card_1Aj8HuLUHPUzUsaQlDbaXjzA"}}}},"text/html":{"schema":{"$ref":"#/components/schemas/Card"}}}},"404":{"description":"Card not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Get credit card by id","tags":["billing"]},"patch":{"operationId":"billing_cards_update","parameters":[{"description":"User or team name.","in":"path","name":"namespace","required":true,"schema":{"type":"string"}},{"description":"Card unique identifier.","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/CardDataPutandPatch"},"responses":{"200":{"description":"Card updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"},"examples":{"response":{"value":{"address_city":"Atlanta","address_country":"United States","address_line1":"3423 Piedmont Rd NE","address_line1_check":"pass","address_line2":"","address_state":"Georgia","address_zip":"30305","address_zip_check":"pass","brand":"Visa","created":"2025-04-15T13:49:50.753Z","customer":"7e102c7b-55cd-49a0-9b23-58865eba1cc3","cvc_check":"","exp_month":1,"exp_year":2025,"fingerprint":"WpZ4zQymdmF5LhbH","funding":"credit","id":"4126086e-525a-4027-b9e7-ae8de47210b2","last4":"4242","name":"John Doe","stripe_id":"card_1Aj8HuLUHPUzUsaQlDbaXjzA"}}}},"text/html":{"schema":{"$ref":"#/components/schemas/Card"}}}},"400":{"description":"Invalid data supplied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardUpdateError"}},"text/html":{"schema":{"$ref":"#/components/schemas/CardUpdateError"}}}},"404":{"description":"Card not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFound"}},"text/html":{"schema":{"$ref":"#/components/schemas/NotFound"}}}}},"summary":"Update a credit card","tags":["billing"]},"put":{"operationId":"billing_cards_replace","parameters":[{"description":"User or team name.","in":"path","name":"namespace","required":true,"schema":{"type":"string"}},{"description":"","in":"path","name":"id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/CardDataPutandPatch"},"responses":{"200":{"description":"Card updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Card"},"examples":{"response":{"value":{"address_city":"Atlan