Skip to content

ServicePlanApi.md

Latest commit

 

History

History
131 lines (71 loc) · 4.72 KB

ServicePlanApi.md

File metadata and controls

131 lines (71 loc) · 4.72 KB

\ServicePlanApi

All URIs are relative to https://api.beamable.com

Method HTTP request Description
api_service_plans_get GET /api/service-plans
api_service_plans_name_delete DELETE /api/service-plans/{name}
api_service_plans_name_get GET /api/service-plans/{name}
api_service_plans_post POST /api/service-plans

api_service_plans_get

models::ServicePlanActorServicePlansResponse api_service_plans_get(x_beam_scope, x_beam_gamertag)

Parameters

Name Type Description Required Notes
x_beam_scope Option<String> Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token
x_beam_gamertag Option<String> Override the playerId of the requester. This is only necessary when not using a JWT bearer token.

Return type

models::ServicePlanActorServicePlansResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_service_plans_name_delete

serde_json::Value api_service_plans_name_delete(name, x_beam_scope, x_beam_gamertag)

Parameters

Name Type Description Required Notes
name String [required]
x_beam_scope Option<String> Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token
x_beam_gamertag Option<String> Override the playerId of the requester. This is only necessary when not using a JWT bearer token.

Return type

serde_json::Value

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_service_plans_name_get

models::ServicePlanActorServicePlan api_service_plans_name_get(name, x_beam_scope, x_beam_gamertag)

Parameters

Name Type Description Required Notes
name String [required]
x_beam_scope Option<String> Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token
x_beam_gamertag Option<String> Override the playerId of the requester. This is only necessary when not using a JWT bearer token.

Return type

models::ServicePlanActorServicePlan

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

api_service_plans_post

serde_json::Value api_service_plans_post(x_beam_scope, x_beam_gamertag, create_service_plan_request)

Parameters

Name Type Description Required Notes
x_beam_scope Option<String> Customer and project scope. This should be in the form of '{customerId}.{projectId}'. This is only necessary when not using a JWT bearer token
x_beam_gamertag Option<String> Override the playerId of the requester. This is only necessary when not using a JWT bearer token.
create_service_plan_request Option<CreateServicePlanRequest>

Return type

serde_json::Value

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]