/*
* incident.io
*
* This is the API reference for incident.io. It documents available API endpoints, provides examples of how to use it, and instructions around things like authentication and error handling. The API is hosted at: - https://api.incident.io/ And you will need to create an API key via your [incident.io dashboard](https://app.incident.io/settings/api-keys) to make requests. # Making requests Here are the key concepts required to make requests to the incident.io API. ## Authentication For all requests made to the incident.io API, you'll need an API key. To create an API key, head to the incident dashboard and visit [API keys](https://app.incident.io/settings/api-keys). When you create the key, you'll be able to choose what actions it can take for your account: choose carefully, as those roles can only be set when you first create the key. We'll only show you the token once, so make sure you store it somewhere safe. API keys are global to your incident.io account, and can be managed by anyone who has the right permissions. We display the user that created the API key, and the API key will remain valid if that user becomes deactivated. Once you have the key, you should make requests to the API that set the `Authorization` request header using a \"Bearer\" authentication scheme: ``` Authorization: Bearer <YOUR_API_KEY> ``` ## Rate Limits The incident.io API enforces rate limits to ensure consistent performance for all users. The default rate limit is 1200 requests/minute per API key. This limit applies to most endpoints across the API. Limits are token buckets that refill continuously rather than resetting on a fixed window boundary. The default bucket holds 1200 requests and refills at 20 per second, so you can burst up to the full bucket and then sustain 20 requests/second indefinitely. There is no boundary at which your quota resets to full in one step. Some endpoints have lower rate limits, particularly those that interact with external third-party systems that impose their own limitations. These specific limits vary by endpoint. ### Rate limit headers Responses to requests authenticated with an API key carry your current allowance, so you can pace yourself rather than waiting to be throttled: ``` X-RateLimit-Limit: 60, 1200;window=60, 60;window=60 X-RateLimit-Remaining: 59 X-RateLimit-Used: 1 X-RateLimit-Reset: 1785173199 ``` | Header | Meaning | | --- | --- | | `X-RateLimit-Limit` | The quota that binds this request, followed by every limit that applied and the window it applies over | | `X-RateLimit-Remaining` | Requests you can make right now against the binding limit | | `X-RateLimit-Used` | Requests you have spent against it | | `X-RateLimit-Reset` | Unix timestamp (seconds) at which that limit will be back to full | More than one limit can apply to a request: your API key's overall limit, and for some endpoints a lower limit of their own. `X-RateLimit-Limit` lists all of them, each with its window, so `1200;window=60` means 1200 requests per minute. Because our limits refill continuously rather than resetting on a boundary, that window is what tells you the rate you can sustain: 1200 per 60 seconds is 20 requests/second indefinitely. `Remaining`, `Used` and `Reset` describe whichever limit has the least allowance left, since that is the one you will hit first. `X-RateLimit-Remaining` may lag by a small number of requests under high concurrency, and can move by more than the requests you made, because limits scoped to your whole organisation are shared with your other API keys. Headers are omitted rather than guessed if we cannot determine your allowance for a request. ### Exceeding a rate limit When you exceed a rate limit the API responds with `429 Too Many Requests` and a `Retry-After` header giving the number of seconds to wait: ``` X-RateLimit-Limit: 1200, 1200;window=60 X-RateLimit-Remaining: 0 X-RateLimit-Used: 1200 X-RateLimit-Reset: 1785173199 Retry-After: 1 ``` Prefer `Retry-After` over `X-RateLimit-Reset` when deciding how long to back off. `Retry-After` is when a single request will succeed; `X-RateLimit-Reset` is the later point at which your whole allowance has returned. It is a duration rather than a timestamp, so it does not depend on your clock agreeing with ours. The 429 also carries a JSON body with the same information: ```json { \"type\": \"too_many_requests\", \"status\": 429, \"request_id\": \"b839a403-7704-41c1-bf6a-39a2d68caefa\", \"rate_limit\": { \"name\": \"api_key_name\", \"limit\": 1200, \"remaining\": 0, \"retry_after\": \"2025-04-17T11:17:18Z\" }, \"errors\": [ { \"code\": \"too_many_requests\", \"message\": \"Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\" } ] } ``` The response includes: * The name of the API key (`name`) * The bucket limit (`limit`) * The number of requests remaining (`remaining`) * When you can retry requests (`retry_after`), as an RFC3339 timestamp ## Errors We use standard HTTP response codes to indicate the status or failure of API requests. The API response body will be JSON, and contain more detailed information on the nature of the error. An example error when a request is made without an API key: ```json { \"type\": \"authentication_error\", \"status\": 401, \"request_id\": \"8e3cc412-b49d-4957-9073-2c19d2c61804\", \"errors\": [ { \"code\": \"missing_authorization_material\", \"message\": \"No authorization material provided in request\" } ] } ``` Note that the error: - Contains the HTTP status (`401`) - References the type of error (`authentication_error`) - Includes a `request_id` that can be provided to incident.io support to help debug questions with your API request - Provides a list of individual errors, which go into detail about why the error occurred The most common error will be a 422 Validation Error, which is returned when the request was rejected due to failing validations. These errors look like this: ```json { \"type\": \"validation_error\", \"status\": 422, \"request_id\": \"631766c4-4afd-4803-997c-cd700928fa4b\", \"errors\": [ { \"code\": \"is_required\", \"message\": \"A severity is required to open an incident\", \"source\": { \"field\": \"severity_id\" } } ] } ``` This error is caused by not providing a severity identifier, which should be at the `severity_id` field of the request payload. Errors like these can be mapped to forms, should you be integrating with the API from a user-interface. ## Compatibility We won't make breaking changes to existing API services or endpoints, but will expect integrators to upgrade themselves to the latest API endpoints within 3 months of us deprecating the old service. We will make changes that are considered backwards compatible, which include: - Adding new API endpoints and services - Adding new properties to responses from existing API endpoints - Reordering properties returned from existing API endpoints - Adding optional request parameters to existing API endpoints - Altering the format or length of IDs - Adding new values to enums It is important that clients are robust to these changes, to ensure reliable integrations. As an example, if you are generating a client using an openapi-generator, ensure the generated client is configured to support unknown enum values, often configured via the `enumUnknownDefaultCase` parameter. When breaking changes are unavoidable, we'll create a new service version on a separate path, and run them in parallel. For example: - https://api.incident.io/v1/incidents - https://api.incident.io/v2/incidents For any questions, email support@incident.io.
*
* The version of the OpenAPI document: 1.0.0
*
* Generated by: https://openapi-generator.tech
*/
use crate::models;
use serde::{Deserialize, Serialize};
/// PayReportV2 : A pay report values the time a set of users spent on-call over a date window, using the rates from a pay config. This is a summary: the headline totals, and the parameters the report was generated with. The shifts behind those totals, and the per-user and per-schedule breakdowns, come from downloading the report as CSV. Reports are immutable snapshots: once generated, changing the pay config or the schedules behind it will not change the report. Generate a new one instead. A report starts as a draft and becomes visible to everyone in your organisation when you publish it. Reports are generated in the background, so a report you have just asked for has no totals yet. Its status says whether they are still coming, and a report that failed carries the reason it will never have them.
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
#[non_exhaustive]
pub struct PayReportV2 {
/// When this report was created
#[serde(rename = "created_at")]
pub created_at: chrono::DateTime<chrono::FixedOffset>,
#[serde(rename = "creator", skip_serializing_if = "Option::is_none")]
pub creator: Option<Box<models::ActorV2>>,
/// Last date (YYYY-MM-DD) this report includes shifts from, inclusive
#[serde(rename = "end_date")]
pub end_date: String,
/// Why a report could not be generated
#[serde(rename = "error_code", skip_serializing_if = "Option::is_none")]
pub error_code: Option<ErrorCode>,
/// What went wrong, written for whoever asked for the report. Only set on a failed report.
#[serde(rename = "error_message", skip_serializing_if = "Option::is_none")]
pub error_message: Option<String>,
/// Unique identifier for this pay report
#[serde(rename = "id")]
pub id: String,
/// Human readable name for this report
#[serde(rename = "name")]
pub name: String,
/// How time spent on more than one schedule at once was paid
#[serde(rename = "overlapping_shifts")]
pub overlapping_shifts: OverlappingShifts,
/// When this report was published. Unset while the report is still a draft.
#[serde(rename = "published_at", skip_serializing_if = "Option::is_none")]
pub published_at: Option<chrono::DateTime<chrono::FixedOffset>>,
/// The schedules this report covers
#[serde(rename = "schedule_ids")]
pub schedule_ids: Vec<String>,
/// First date (YYYY-MM-DD) this report includes shifts from, inclusive
#[serde(rename = "start_date")]
pub start_date: String,
/// How far a report has got through being generated
#[serde(rename = "status")]
pub status: Status,
/// Total time spent on-call across every shift in this report, in seconds. Unset until the report is complete, and for a legacy report, which we do not summarise.
#[serde(
rename = "total_duration_seconds",
skip_serializing_if = "Option::is_none"
)]
pub total_duration_seconds: Option<i64>,
/// Total owed for this report, keyed by ISO 4217 currency code, in the lowest denomination of that currency. Reports spanning pay configs with different currencies have an entry per currency, and those totals must not be summed. Unset until the report is complete, and for a legacy report, which we do not summarise.
#[serde(
rename = "total_pay_by_currency",
skip_serializing_if = "Option::is_none"
)]
pub total_pay_by_currency: Option<std::collections::HashMap<String, i64>>,
/// Whether shifts that priced to zero are part of the report
#[serde(rename = "unpaid_shifts")]
pub unpaid_shifts: UnpaidShifts,
/// When this report was last updated
#[serde(rename = "updated_at")]
pub updated_at: chrono::DateTime<chrono::FixedOffset>,
}
impl PayReportV2 {
/// A value with every field at its default.
///
/// This is a response type, so you receive one rather than
/// building it. Set the fields you need with the `set_*`
/// methods below — deliberately not a required-argument
/// constructor, because then the schema adding a required
/// property would change this signature and break you.
pub fn new() -> Self {
Default::default()
}
}
/// Why a report could not be generated
#[derive(Clone, Debug, Eq, PartialEq, Hash, Serialize, Deserialize)]
#[non_exhaustive]
pub enum ErrorCode {
#[serde(rename = "invalid_request")]
InvalidRequest,
#[serde(rename = "timed_out")]
TimedOut,
/// A value this build of the SDK does not know about.
///
/// The API adds enum values as a backwards-compatible change. This holds
/// the value verbatim and serializes back to it unchanged, so writing back
/// a resource you read does not discard it.
#[serde(untagged)]
Unknown(String),
}
impl Default for ErrorCode {
fn default() -> ErrorCode {
Self::InvalidRequest
}
}
/// How time spent on more than one schedule at once was paid
#[derive(Clone, Debug, Eq, PartialEq, Hash, Serialize, Deserialize)]
#[non_exhaustive]
pub enum OverlappingShifts {
#[serde(rename = "paid_once")]
PaidOnce,
#[serde(rename = "paid_per_schedule")]
PaidPerSchedule,
/// A value this build of the SDK does not know about.
///
/// The API adds enum values as a backwards-compatible change. This holds
/// the value verbatim and serializes back to it unchanged, so writing back
/// a resource you read does not discard it.
#[serde(untagged)]
Unknown(String),
}
impl Default for OverlappingShifts {
fn default() -> OverlappingShifts {
Self::PaidOnce
}
}
/// How far a report has got through being generated
#[derive(Clone, Debug, Eq, PartialEq, Hash, Serialize, Deserialize)]
#[non_exhaustive]
pub enum Status {
#[serde(rename = "pending")]
Pending,
#[serde(rename = "generating")]
Generating,
#[serde(rename = "complete")]
Complete,
#[serde(rename = "failed")]
Failed,
/// A value this build of the SDK does not know about.
///
/// The API adds enum values as a backwards-compatible change. This holds
/// the value verbatim and serializes back to it unchanged, so writing back
/// a resource you read does not discard it.
#[serde(untagged)]
Unknown(String),
}
impl Default for Status {
fn default() -> Status {
Self::Pending
}
}
/// Whether shifts that priced to zero are part of the report
#[derive(Clone, Debug, Eq, PartialEq, Hash, Serialize, Deserialize)]
#[non_exhaustive]
pub enum UnpaidShifts {
#[serde(rename = "included")]
Included,
#[serde(rename = "excluded")]
Excluded,
/// A value this build of the SDK does not know about.
///
/// The API adds enum values as a backwards-compatible change. This holds
/// the value verbatim and serializes back to it unchanged, so writing back
/// a resource you read does not discard it.
#[serde(untagged)]
Unknown(String),
}
impl Default for UnpaidShifts {
fn default() -> UnpaidShifts {
Self::Included
}
}
// --- generated by scripts/fix_generated.py ---
impl PayReportV2 {
/// Sets `created_at`.
#[must_use]
pub fn set_created_at(mut self, value: chrono::DateTime<chrono::FixedOffset>) -> Self {
self.created_at = value;
self
}
/// Sets `creator`.
#[must_use]
pub fn set_creator(mut self, value: models::ActorV2) -> Self {
self.creator = Some(Box::new(value));
self
}
/// Sets `end_date`.
#[must_use]
pub fn set_end_date(mut self, value: impl Into<String>) -> Self {
self.end_date = value.into();
self
}
/// Sets `error_code`.
#[must_use]
pub fn set_error_code(mut self, value: ErrorCode) -> Self {
self.error_code = Some(value);
self
}
/// Sets `error_message`.
#[must_use]
pub fn set_error_message(mut self, value: impl Into<String>) -> Self {
self.error_message = Some(value.into());
self
}
/// Sets `id`.
#[must_use]
pub fn set_id(mut self, value: impl Into<String>) -> Self {
self.id = value.into();
self
}
/// Sets `name`.
#[must_use]
pub fn set_name(mut self, value: impl Into<String>) -> Self {
self.name = value.into();
self
}
/// Sets `overlapping_shifts`.
#[must_use]
pub fn set_overlapping_shifts(mut self, value: OverlappingShifts) -> Self {
self.overlapping_shifts = value;
self
}
/// Sets `published_at`.
#[must_use]
pub fn set_published_at(mut self, value: chrono::DateTime<chrono::FixedOffset>) -> Self {
self.published_at = Some(value);
self
}
/// Sets `schedule_ids`.
#[must_use]
pub fn set_schedule_ids(mut self, value: Vec<String>) -> Self {
self.schedule_ids = value;
self
}
/// Sets `start_date`.
#[must_use]
pub fn set_start_date(mut self, value: impl Into<String>) -> Self {
self.start_date = value.into();
self
}
/// Sets `status`.
#[must_use]
pub fn set_status(mut self, value: Status) -> Self {
self.status = value;
self
}
/// Sets `total_duration_seconds`.
#[must_use]
pub fn set_total_duration_seconds(mut self, value: i64) -> Self {
self.total_duration_seconds = Some(value);
self
}
/// Sets `total_pay_by_currency`.
#[must_use]
pub fn set_total_pay_by_currency(
mut self,
value: std::collections::HashMap<String, i64>,
) -> Self {
self.total_pay_by_currency = Some(value);
self
}
/// Sets `unpaid_shifts`.
#[must_use]
pub fn set_unpaid_shifts(mut self, value: UnpaidShifts) -> Self {
self.unpaid_shifts = value;
self
}
/// Sets `updated_at`.
#[must_use]
pub fn set_updated_at(mut self, value: chrono::DateTime<chrono::FixedOffset>) -> Self {
self.updated_at = value;
self
}
}