Change a warranty

maintenance.warranty.update

POST/api/v1/households/{household_id}/commands/maintenance.warranty.update

Command
Rigel runs it
Applies offline

Changes only the fields given; null clears provider, coverage and the dates. New evidence replaces the old. Errors: invalid_range (it would end before it starts).

Parameters#

Change a warranty: parameters
Field	Description
`household_id`pathstringrequired	The household's ID.
`Idempotency-Key`headerstringoptional	The command's ID. Reuse it when retrying the same command.

Request body#

JSON, as application/json.

Change a warranty: request body fields
Field	Description
`warranty_id`stringrequired	A warranty ID, such as wty_01JC0000000000000000000000.
`provider`string or nulloptional	Who provides the coverage, as written: "Carrier", "Home Depot protection plan". at most 200 characters
`coverage`string or nulloptional	What it covers and its limits. at most 20,000 characters
`starts_on`string (date) or nulloptional	When coverage starts, YYYY-MM-DD.
`ends_on`string (date) or nulloptional	When coverage ends, YYYY-MM-DD.
`evidence`objectoptional	Where the coverage was read: the warranty card, the receipt.
`evidence.file_id`stringoptional	A photo, manual or invoice already uploaded to the household's files.
`evidence.url`string (uri)optional	A web address. at most 2,000 characters
`evidence.said_by_person_id`stringoptional	Who said it, when the source is something a person said.
`evidence.locator`stringoptional	Where in the source: "p. 14", "rating plate". at most 200 characters
`evidence.excerpt`stringoptional	The exact text the value was read from. at most 2,000 characters

Response#

200 The command was applied.

Change a warranty: response fields
Field	Description
`result`objectrequired	What the command returned, such as the IDs it created.
`version`integerrequired	The household version after the command.

Errors#

Every error has the same envelope: error.code, error.message, error.details, error.recovery and error.request_id.

Change a warranty: errors
Status	Code	When
`400`	`validation_failed`	A field is missing, misspelled or out of range. details.fields lists each problem.
`401`	`unauthenticated`	The request has no valid session.
`404`	`warranty_not_found`	A warranty that isn't there.
`404`	`not_found`	The household doesn't exist, or you aren't a member of it.
`409`	`invalid_range`	It would end before it starts. The new end is checked against the old start. The new start is checked against the old end.
`409`	`idempotency_key_reused`	The Idempotency-Key was already used for a different command.

Examples#

These are real. Each scenario is one of the command's test cases, run on a household when this site was built, and the response is what the API returned.

Changes what's given; new evidence replaces the old

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.warranty.update' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "warranty_id": "wty_01JC0000000000000000000001",
  "coverage": "Parts and labor",
  "evidence": {
    "locator": "card"
  }
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.warranty.update", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01JC4N0000AAAAAAAAAAAAAAAA",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    warranty_id: "wty_01JC0000000000000000000001",
    coverage: "Parts and labor",
    evidence: {
      locator: "card",
    },
  }),
});
const data = await response.json();

Request, HTTP

POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.warranty.update HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA

{
  "warranty_id": "wty_01JC0000000000000000000001",
  "coverage": "Parts and labor",
  "evidence": {
    "locator": "card"
  }
}

Response, 200

HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01K9D9S2R055B6QXKGXRW495V2

{
  "result": {},
  "version": 1
}

Null clears a date

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.warranty.update' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "warranty_id": "wty_01JC0000000000000000000001",
  "ends_on": null
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.warranty.update", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01JC4N0000AAAAAAAAAAAAAAAA",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    warranty_id: "wty_01JC0000000000000000000001",
    ends_on: null,
  }),
});
const data = await response.json();

Request, HTTP

POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.warranty.update HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA

{
  "warranty_id": "wty_01JC0000000000000000000001",
  "ends_on": null
}

Response, 200

HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01K9D9S2R0RYM25P1RK2GDM2GY

{
  "result": {},
  "version": 1
}

The new end is checked against the old start

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.warranty.update' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "warranty_id": "wty_01JC0000000000000000000001",
  "ends_on": "2019-06-14"
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.warranty.update", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01JC4N0000AAAAAAAAAAAAAAAA",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    warranty_id: "wty_01JC0000000000000000000001",
    ends_on: "2019-06-14",
  }),
});
const data = await response.json();

Request, HTTP

POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.warranty.update HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA

{
  "warranty_id": "wty_01JC0000000000000000000001",
  "ends_on": "2019-06-14"
}

Response, 409

HTTP/1.1 409 Conflict
Content-Type: application/json
X-Request-Id: req_01K9D9S2R0Q7NAT18NS4SW1SCA

{
  "error": {
    "code": "invalid_range",
    "message": "The coverage can't end before it starts. No changes were applied.",
    "details": {
      "starts_on": "2019-06-15",
      "ends_on": "2019-06-14"
    },
    "recovery": "Read the current state, then send a command that fits it.",
    "request_id": "req_01K9D9S2R0Q7NAT18NS4SW1SCA"
  }
}

The new start is checked against the old end

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.warranty.update' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "warranty_id": "wty_01JC0000000000000000000001",
  "starts_on": "2019-06-16"
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.warranty.update", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01JC4N0000AAAAAAAAAAAAAAAA",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    warranty_id: "wty_01JC0000000000000000000001",
    starts_on: "2019-06-16",
  }),
});
const data = await response.json();

Request, HTTP

POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.warranty.update HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA

{
  "warranty_id": "wty_01JC0000000000000000000001",
  "starts_on": "2019-06-16"
}

Response, 409

HTTP/1.1 409 Conflict
Content-Type: application/json
X-Request-Id: req_01K9D9S2R05S9QZ6ATJ85HWX7A

{
  "error": {
    "code": "invalid_range",
    "message": "The coverage can't end before it starts. No changes were applied.",
    "details": {
      "starts_on": "2019-06-16",
      "ends_on": "2019-06-15"
    },
    "recovery": "Read the current state, then send a command that fits it.",
    "request_id": "req_01K9D9S2R05S9QZ6ATJ85HWX7A"
  }
}

A warranty that isn't there

Request, curl

curl -X POST 'https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.warranty.update' \
  -H "Cookie: rigel_session=$RIGEL_SESSION" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA' \
  -d '{
  "warranty_id": "wty_01JC0000000000000000000001",
  "coverage": "x"
}'

Request, TypeScript

const response = await fetch("https://rigel.house/api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.warranty.update", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Idempotency-Key": "cmd_01JC4N0000AAAAAAAAAAAAAAAA",
    Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
  },
  body: JSON.stringify({
    warranty_id: "wty_01JC0000000000000000000001",
    coverage: "x",
  }),
});
const data = await response.json();

Request, HTTP

POST /api/v1/households/hh_01K9BKKP003AHRZ6DMV29GQY5C/commands/maintenance.warranty.update HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>
Content-Type: application/json
Idempotency-Key: cmd_01JC4N0000AAAAAAAAAAAAAAAA

{
  "warranty_id": "wty_01JC0000000000000000000001",
  "coverage": "x"
}

Response, 404

HTTP/1.1 404 Not Found
Content-Type: application/json
X-Request-Id: req_01K9D9S2R0S12VDN7QHQK4H8DS

{
  "error": {
    "code": "warranty_not_found",
    "message": "That warranty isn't recorded any more. No changes were applied.",
    "details": {
      "warranty_id": "wty_01JC0000000000000000000001"
    },
    "recovery": "Read the current state, then send a command that fits it.",
    "request_id": "req_01K9D9S2R0S12VDN7QHQK4H8DS"
  }
}

For Rigel#

Rigel's tool for this command is maintenance_warranty_update. Rigel runs this on its own, then says what it did. The agent guide has the rest.