@greatwait/contracts 0.1.0-alpha.3 → 0.1.0-alpha.5

package/generated/v1/schemas/billing.invoicehistory.response.json

@@ -0,0 +1,88 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "data": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 255
+          },
+          "createdAt": {
+            "type": "string",
+            "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
+          },
+          "amount": {
+            "type": "object",
+            "properties": {
+              "currency": {
+                "type": "string",
+                "const": "USD"
+              },
+              "microdollars": {
+                "type": "string",
+                "pattern": "^(?:0|[1-9]\\d*)$"
+              },
+              "scale": {
+                "type": "number",
+                "const": 6
+              }
+            },
+            "required": ["currency", "microdollars", "scale"]
+          },
+          "state": {
+            "type": "string",
+            "enum": ["paid", "open", "void", "uncollectible"]
+          },
+          "receiptUrl": {
+            "type": "string",
+            "format": "uri"
+          }
+        },
+        "required": ["id", "createdAt", "amount", "state"]
+      }
+    },
+    "freshness": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "type": "string",
+              "const": "authoritative"
+            }
+          },
+          "required": ["kind"]
+        },
+        {
+          "type": "object",
+          "properties": {
+            "asOf": {
+              "type": "string",
+              "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
+            },
+            "kind": {
+              "type": "string",
+              "const": "projected"
+            },
+            "lagSeconds": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 9007199254740991
+            }
+          },
+          "required": ["asOf", "kind", "lagSeconds"]
+        }
+      ]
+    },
+    "nextCursor": {
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "required": ["data", "freshness"]
+}

package/generated/v1/schemas/billing.invoices.response.json

@@ -0,0 +1,51 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "data": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 255
+          },
+          "createdAt": {
+            "type": "string",
+            "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
+          },
+          "amount": {
+            "type": "object",
+            "properties": {
+              "currency": {
+                "type": "string",
+                "const": "USD"
+              },
+              "microdollars": {
+                "type": "string",
+                "pattern": "^(?:0|[1-9]\\d*)$"
+              },
+              "scale": {
+                "type": "number",
+                "const": 6
+              }
+            },
+            "required": ["currency", "microdollars", "scale"]
+          },
+          "state": {
+            "type": "string",
+            "enum": ["paid", "open", "void", "uncollectible"]
+          },
+          "receiptUrl": {
+            "type": "string",
+            "format": "uri"
+          }
+        },
+        "required": ["id", "createdAt", "amount", "state"]
+      }
+    }
+  },
+  "required": ["data"]
+}

package/generated/v1/schemas/billing.ledger.query.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "cursor": {
+      "type": "string",
+      "minLength": 1
+    },
+    "limit": {
+      "default": 25,
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 100
+    }
+  }
+}

package/generated/v1/schemas/billing.ledger.response.json

@@ -0,0 +1,130 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "data": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "amount": {
+            "type": "object",
+            "properties": {
+              "currency": {
+                "type": "string",
+                "const": "USD"
+              },
+              "microdollars": {
+                "type": "string",
+                "pattern": "^-?(?:0|[1-9]\\d*)$"
+              },
+              "scale": {
+                "type": "number",
+                "const": 6
+              }
+            },
+            "required": ["currency", "microdollars", "scale"]
+          },
+          "kind": {
+            "type": "string",
+            "enum": [
+              "credit_granted",
+              "credit_reversed",
+              "attempt_debited",
+              "attempt_released",
+              "shadow_attempt_debited",
+              "shadow_attempt_released",
+              "late_evidence_waived",
+              "policy_installed",
+              "budget_policy_updated",
+              "budget_threshold_reached",
+              "budget_exhausted",
+              "budget_recovered",
+              "automatic_charge_ceiling_updated",
+              "payment_reserved",
+              "payment_submitted",
+              "payment_pending",
+              "payment_paid",
+              "payment_failed",
+              "payment_canceled",
+              "payment_authentication_required",
+              "payment_action_required",
+              "payment_refunded",
+              "payment_disputed",
+              "payment_reversed",
+              "payment_dispute_restored",
+              "refund_requested",
+              "payment_refund_canceled",
+              "automatic_top_up_cap_reached",
+              "automatic_charge_threshold_reached",
+              "automatic_charge_threshold_recovered",
+              "low_credit_reached",
+              "low_credit_recovered",
+              "notification_settings_updated",
+              "service_blocked",
+              "service_restored"
+            ]
+          },
+          "note": {
+            "type": "string",
+            "enum": ["provider-details-attached"],
+            "description": "Present when an entry moved no money despite its kind. provider-details-attached: the provider reported details of a payment already recorded; the amount is zero."
+          },
+          "period": {
+            "type": "string",
+            "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
+          },
+          "recordedAt": {
+            "type": "string",
+            "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
+          },
+          "reference": {
+            "type": "object",
+            "properties": {
+              "attempt": {
+                "type": "string",
+                "pattern": "^att_[0-9abcdefghjkmnpqrstvwxyz]{26}$"
+              },
+              "creditLot": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 128
+              },
+              "event": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 255
+              },
+              "paymentOperation": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 255
+              }
+            },
+            "required": ["event"]
+          },
+          "sequence": {
+            "type": "string",
+            "pattern": "^(?:0|[1-9]\\d*)$"
+          }
+        },
+        "required": ["amount", "kind", "recordedAt", "reference", "sequence"]
+      }
+    },
+    "freshness": {
+      "type": "object",
+      "properties": {
+        "kind": {
+          "type": "string",
+          "const": "authoritative"
+        }
+      },
+      "required": ["kind"]
+    },
+    "nextCursor": {
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "required": ["data", "freshness"]
+}

package/generated/v1/schemas/billing.notices.query.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "cursor": {
+      "type": "string",
+      "minLength": 1
+    },
+    "limit": {
+      "default": 25,
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 100
+    }
+  }
+}

package/generated/v1/schemas/billing.notices.response.json

@@ -0,0 +1,278 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "data": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "amounts": {
+            "type": "object",
+            "properties": {
+              "available": {
+                "type": "object",
+                "properties": {
+                  "currency": {
+                    "type": "string",
+                    "const": "USD"
+                  },
+                  "microdollars": {
+                    "type": "string",
+                    "pattern": "^(?:0|[1-9]\\d*)$"
+                  },
+                  "scale": {
+                    "type": "number",
+                    "const": 6
+                  }
+                },
+                "required": ["currency", "microdollars", "scale"]
+              },
+              "gross": {
+                "type": "object",
+                "properties": {
+                  "currency": {
+                    "type": "string",
+                    "const": "USD"
+                  },
+                  "microdollars": {
+                    "type": "string",
+                    "pattern": "^(?:0|[1-9]\\d*)$"
+                  },
+                  "scale": {
+                    "type": "number",
+                    "const": 6
+                  }
+                },
+                "required": ["currency", "microdollars", "scale"]
+              },
+              "limit": {
+                "type": "object",
+                "properties": {
+                  "currency": {
+                    "type": "string",
+                    "const": "USD"
+                  },
+                  "microdollars": {
+                    "type": "string",
+                    "pattern": "^(?:0|[1-9]\\d*)$"
+                  },
+                  "scale": {
+                    "type": "number",
+                    "const": 6
+                  }
+                },
+                "required": ["currency", "microdollars", "scale"]
+              },
+              "threshold": {
+                "type": "object",
+                "properties": {
+                  "currency": {
+                    "type": "string",
+                    "const": "USD"
+                  },
+                  "microdollars": {
+                    "type": "string",
+                    "pattern": "^(?:0|[1-9]\\d*)$"
+                  },
+                  "scale": {
+                    "type": "number",
+                    "const": 6
+                  }
+                },
+                "required": ["currency", "microdollars", "scale"]
+              }
+            }
+          },
+          "detail": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 512
+          },
+          "email": {
+            "type": "object",
+            "properties": {
+              "attempts": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 100
+              },
+              "failureCode": {
+                "type": "string",
+                "pattern": "^[a-z][a-z0-9-]{0,127}$"
+              },
+              "lastAttemptAt": {
+                "anyOf": [
+                  {
+                    "type": "string",
+                    "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              },
+              "state": {
+                "type": "string",
+                "enum": ["pending", "delivered", "failed", "suppressed"]
+              }
+            },
+            "required": ["attempts", "lastAttemptAt", "state"]
+          },
+          "id": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 128
+          },
+          "kind": {
+            "type": "string",
+            "enum": [
+              "budget-warning",
+              "budget-exhausted",
+              "low-credit",
+              "automatic-top-up-cap-reached",
+              "funding-blocked",
+              "payment-pending",
+              "payment-succeeded",
+              "payment-failed",
+              "payment-authentication-required",
+              "payment-outcome-unresolved",
+              "service-restored"
+            ]
+          },
+          "occurredAt": {
+            "type": "string",
+            "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
+          },
+          "payment": {
+            "anyOf": [
+              {
+                "type": "object",
+                "properties": {
+                  "operation": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 255
+                  },
+                  "state": {
+                    "type": "string",
+                    "enum": [
+                      "pending",
+                      "paid",
+                      "failed",
+                      "authentication-required",
+                      "action-required",
+                      "canceled",
+                      "refunded",
+                      "reversed",
+                      "disputed"
+                    ]
+                  }
+                },
+                "required": ["operation", "state"]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "recoveryPath": {
+            "type": "string",
+            "enum": [
+              "#billing",
+              "#billing-funding",
+              "#billing-notification-settings"
+            ]
+          },
+          "resolvedAt": {
+            "anyOf": [
+              {
+                "type": "string",
+                "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          },
+          "scope": {
+            "oneOf": [
+              {
+                "type": "object",
+                "properties": {
+                  "kind": {
+                    "type": "string",
+                    "const": "organization"
+                  }
+                },
+                "required": ["kind"]
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "kind": {
+                    "type": "string",
+                    "const": "project"
+                  },
+                  "project": {
+                    "type": "string",
+                    "pattern": "^proj_[0-9abcdefghjkmnpqrstvwxyz]{26}$"
+                  }
+                },
+                "required": ["kind", "project"]
+              }
+            ]
+          },
+          "severity": {
+            "type": "string",
+            "enum": ["warning", "critical", "recovery"]
+          },
+          "state": {
+            "type": "string",
+            "enum": ["active", "resolved"]
+          },
+          "title": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 160
+          },
+          "updatedAt": {
+            "type": "string",
+            "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
+          }
+        },
+        "required": [
+          "amounts",
+          "detail",
+          "email",
+          "id",
+          "kind",
+          "occurredAt",
+          "payment",
+          "recoveryPath",
+          "resolvedAt",
+          "scope",
+          "severity",
+          "state",
+          "title",
+          "updatedAt"
+        ]
+      }
+    },
+    "freshness": {
+      "type": "object",
+      "properties": {
+        "kind": {
+          "type": "string",
+          "const": "authoritative"
+        }
+      },
+      "required": ["kind"]
+    },
+    "nextCursor": {
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "required": ["data", "freshness"]
+}

package/generated/v1/schemas/billing.notificationsettings.response.json

@@ -0,0 +1,70 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "criticalEmail": {
+      "type": "boolean",
+      "const": true
+    },
+    "freshness": {
+      "type": "object",
+      "properties": {
+        "kind": {
+          "type": "string",
+          "const": "authoritative"
+        }
+      },
+      "required": ["kind"]
+    },
+    "lowCreditThreshold": {
+      "type": "object",
+      "properties": {
+        "currency": {
+          "type": "string",
+          "const": "USD"
+        },
+        "microdollars": {
+          "type": "string",
+          "pattern": "^(?:0|(?:[1-9]\\d{0,13}|[1-8]\\d{14}|9[01]\\d{13}|92[01]\\d{12}|922[0-2]\\d{11}|9223[0-2]\\d{10}|92233[0-6]\\d{9}|922337[01]\\d{8}|92233720[0-2]\\d{6}|922337203[0-5]\\d{5}|9223372036[0-7]\\d{4}|92233720368[0-4]\\d{3}|922337203685[0-3]\\d{2}|9223372036854[0-6]\\d|92233720368547[0-7])0000)$",
+          "description": "A canonical nonnegative integer multiple of 10,000 microdollars, no greater than 9,223,372,036,854,770,000.",
+          "maxLength": 19
+        },
+        "scale": {
+          "type": "number",
+          "const": 6
+        }
+      },
+      "required": ["currency", "microdollars", "scale"]
+    },
+    "noncriticalEmail": {
+      "type": "boolean"
+    },
+    "recipients": {
+      "type": "object",
+      "properties": {
+        "billingContacts": {
+          "type": "string",
+          "const": "active-billing-role-members"
+        },
+        "owners": {
+          "type": "boolean",
+          "const": true
+        }
+      },
+      "required": ["billingContacts", "owners"]
+    },
+    "revision": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991
+    }
+  },
+  "required": [
+    "criticalEmail",
+    "freshness",
+    "lowCreditThreshold",
+    "noncriticalEmail",
+    "recipients",
+    "revision"
+  ]
+}

package/generated/v1/schemas/billing.notificationsettingsupdate.request-headers.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "Idempotency-Key": {
+      "type": "string",
+      "minLength": 16,
+      "maxLength": 255,
+      "pattern": "^[\\x20-\\x7e]+$"
+    }
+  },
+  "required": ["Idempotency-Key"]
+}