@seamapi/types 1.928.0 → 1.930.0

package/dist/index.cjs

@@ -96,6 +96,45 @@ var access_code_name_constraint = zod.z.object({
   max_length: zod.z.number().optional().describe(`Maximum name length constraint for access codes.`)
 }).describe(`Name constraint for access codes.`);
 var access_code_constraint = zod.z.union([access_code_code_constraint, access_code_name_constraint]).describe(`Access code constraint.`);
+var time_frame_option_time_pair = zod.z.object({
+  display_name: zod.z.string().describe("Label for the check-in/check-out time pairing."),
+  check_in_time: zod.z.string().describe(
+    "Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`."
+  ),
+  check_out_time: zod.z.string().describe(
+    "Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date."
+  )
+}).describe(
+  "Fixed check-in/check-out time pairing. The caller picks one whole pairing; the two times cannot be mixed across pairs."
+);
+var time_frame_option = zod.z.object({
+  display_name: zod.z.string().describe(
+    "Label for this option. For a single-option device, the product name (for example, `algoPIN` or `SmartPIN`); for a multi-option device, a label that distinguishes it (for example, `Hourly` or `Fixed check-in times`)."
+  ),
+  min_duration: zod.z.string().optional().describe(
+    "Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum."
+  ),
+  max_duration: zod.z.string().optional().describe(
+    "Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum."
+  ),
+  matching_start_end_time: zod.z.literal(true).optional().describe(
+    "When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`."
+  ),
+  time_pairs: zod.z.array(time_frame_option_time_pair).optional().describe(
+    "Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`."
+  ),
+  start_date_recurrence_rule: zod.z.string().optional().describe(
+    "iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules."
+  ),
+  end_date_recurrence_rule: zod.z.string().optional().describe(
+    "iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules."
+  ),
+  time_zone: zod.z.string().optional().describe(
+    "IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates."
+  )
+}).describe(
+  "One way to make a code: a duration band plus the time-of-day and date rules that apply within it. Absence of a rule means unrestricted on that axis."
+);
 var access_code_capability_properties = zod.z.object({
   _experimental_supported_code_from_access_codes_lengths: zod.z.array(zod.z.number()).optional().describe(`
           ---
@@ -112,6 +151,16 @@ var access_code_capability_properties = zod.z.object({
           property_group_key: access_codes
           ---
           Supported code lengths for access codes.`),
+  offline_time_frame_options: zod.z.array(time_frame_option).optional().describe(`
+          ---
+          property_group_key: access_codes
+          ---
+          Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by \`display_name\` when they do) and satisfies that one option's rules. When \`undefined\`, any time frame works.`),
+  online_time_frame_options: zod.z.array(time_frame_option).optional().describe(`
+          ---
+          property_group_key: access_codes
+          ---
+          Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by \`display_name\` when they do) and satisfies that one option's rules. When \`undefined\`, any time frame works.`),
   max_active_codes_supported: zod.z.number().optional().describe(`
           ---
           property_group_key: access_codes
@@ -2625,10 +2674,10 @@ var code_modified_external_to_seam_warning = common_access_code_warning.extend({
 }).describe(
   "Code was modified or removed externally after Seam successfully set it on the device."
 );
-var provider_issue_warning = common_access_code_warning.extend({
-  warning_code: zod.z.literal("provider_issue").describe(warning_code_description3)
+var code_rotates_periodically = common_access_code_warning.extend({
+  warning_code: zod.z.literal("code_rotates_periodically").describe(warning_code_description3)
 }).describe(
-  "Indicates a provider-specific issue that may affect the access code. Check the warning message for details."
+  "The access code's PIN rotates periodically when the code is renewed. Retrieve the latest code before each use."
 );
 var schlage_access_code_ambiguous_timezone_dst_risk = common_access_code_warning.extend({
   warning_code: zod.z.literal("schlage_access_code_ambiguous_timezone_dst_risk").describe(warning_code_description3)
@@ -2661,7 +2710,7 @@ var being_deleted2 = common_access_code_warning.extend({
   warning_code: zod.z.literal("being_deleted").describe(warning_code_description3)
 }).describe("Access code is being deleted.");
 var access_code_warning = zod.z.discriminatedUnion("warning_code", [
-  provider_issue_warning,
+  code_rotates_periodically,
   schlage_access_code_ambiguous_timezone_dst_risk,
   code_modified_external_to_seam_warning,
   delay_in_setting_on_device,
@@ -2675,7 +2724,7 @@ var access_code_warning = zod.z.discriminatedUnion("warning_code", [
   "Warnings associated with the [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes)."
 );
 zod.z.object({
-  provider_issue: provider_issue_warning.optional().nullable(),
+  code_rotates_periodically: code_rotates_periodically.optional().nullable(),
   schlage_access_code_ambiguous_timezone_dst_risk: schlage_access_code_ambiguous_timezone_dst_risk.optional().nullable(),
   code_modified_external_to_seam_warning: code_modified_external_to_seam_warning.optional().nullable(),
   delay_in_setting_on_device: delay_in_setting_on_device.optional().nullable(),
@@ -8779,7 +8828,7 @@ var openapi = {
               discriminator: { propertyName: "warning_code" },
               oneOf: [
                 {
-                  description: "Indicates a provider-specific issue that may affect the access code. Check the warning message for details.",
+                  description: "The access code's PIN rotates periodically when the code is renewed. Retrieve the latest code before each use.",
                   properties: {
                     created_at: {
                       description: "Date and time at which Seam created the warning.",
@@ -8792,7 +8841,7 @@ var openapi = {
                     },
                     warning_code: {
                       description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
-                      enum: ["provider_issue"],
+                      enum: ["code_rotates_periodically"],
                       type: "string"
                     }
                   },
@@ -21265,6 +21314,142 @@ var openapi = {
                         type: "number",
                         "x-property-group-key": "access_codes"
                       },
+                      offline_time_frame_options: {
+                        description: "Time frames that may be requested when creating an offline access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works.",
+                        items: {
+                          description: "One way to make a code: a duration band plus the time-of-day and date rules that apply within it. Absence of a rule means unrestricted on that axis.",
+                          properties: {
+                            display_name: {
+                              description: "Label for this option. For a single-option device, the product name (for example, `algoPIN` or `SmartPIN`); for a multi-option device, a label that distinguishes it (for example, `Hourly` or `Fixed check-in times`).",
+                              type: "string"
+                            },
+                            end_date_recurrence_rule: {
+                              description: "iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules.",
+                              type: "string"
+                            },
+                            matching_start_end_time: {
+                              description: "When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`.",
+                              enum: [true],
+                              type: "boolean"
+                            },
+                            max_duration: {
+                              description: "Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum.",
+                              type: "string"
+                            },
+                            min_duration: {
+                              description: "Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum.",
+                              type: "string"
+                            },
+                            start_date_recurrence_rule: {
+                              description: "iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules.",
+                              type: "string"
+                            },
+                            time_pairs: {
+                              description: "Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.",
+                              items: {
+                                description: "Fixed check-in/check-out time pairing. The caller picks one whole pairing; the two times cannot be mixed across pairs.",
+                                properties: {
+                                  check_in_time: {
+                                    description: "Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.",
+                                    type: "string"
+                                  },
+                                  check_out_time: {
+                                    description: "Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date.",
+                                    type: "string"
+                                  },
+                                  display_name: {
+                                    description: "Label for the check-in/check-out time pairing.",
+                                    type: "string"
+                                  }
+                                },
+                                required: [
+                                  "display_name",
+                                  "check_in_time",
+                                  "check_out_time"
+                                ],
+                                type: "object"
+                              },
+                              type: "array"
+                            },
+                            time_zone: {
+                              description: "IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates.",
+                              type: "string"
+                            }
+                          },
+                          required: ["display_name"],
+                          type: "object"
+                        },
+                        type: "array",
+                        "x-property-group-key": "access_codes"
+                      },
+                      online_time_frame_options: {
+                        description: "Time frames that may be requested when creating an online access code, expressed as a list of options. The caller picks one option (by matching the requested duration when the options' duration ranges do not overlap, or by `display_name` when they do) and satisfies that one option's rules. When `undefined`, any time frame works.",
+                        items: {
+                          description: "One way to make a code: a duration band plus the time-of-day and date rules that apply within it. Absence of a rule means unrestricted on that axis.",
+                          properties: {
+                            display_name: {
+                              description: "Label for this option. For a single-option device, the product name (for example, `algoPIN` or `SmartPIN`); for a multi-option device, a label that distinguishes it (for example, `Hourly` or `Fixed check-in times`).",
+                              type: "string"
+                            },
+                            end_date_recurrence_rule: {
+                              description: "iCalendar recurrence rule (RRULE) that the check-out date must fall on. Constrains which calendar dates are selectable, independent of the time-of-day rules.",
+                              type: "string"
+                            },
+                            matching_start_end_time: {
+                              description: "When `true`, the check-in and check-out must fall at the same time of day (the caller picks which). Mutually exclusive with `time_pairs`.",
+                              enum: [true],
+                              type: "boolean"
+                            },
+                            max_duration: {
+                              description: "Maximum duration this option covers, as an ISO 8601 duration (for example, `PT672H` or `P367D`). Omitted when there is no maximum.",
+                              type: "string"
+                            },
+                            min_duration: {
+                              description: "Minimum duration this option covers, as an ISO 8601 duration (for example, `PT1H` or `P29D`). Omitted when there is no minimum.",
+                              type: "string"
+                            },
+                            start_date_recurrence_rule: {
+                              description: "iCalendar recurrence rule (RRULE) that the check-in date must fall on (for example, `FREQ=MONTHLY;BYDAY=1MO,3MO`). Constrains which calendar dates are selectable, independent of the time-of-day rules.",
+                              type: "string"
+                            },
+                            time_pairs: {
+                              description: "Fixed check-in/check-out time pairings the caller chooses from. Mutually exclusive with `matching_start_end_time`.",
+                              items: {
+                                description: "Fixed check-in/check-out time pairing. The caller picks one whole pairing; the two times cannot be mixed across pairs.",
+                                properties: {
+                                  check_in_time: {
+                                    description: "Check-in time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`.",
+                                    type: "string"
+                                  },
+                                  check_out_time: {
+                                    description: "Check-out time of day as a 24-hour `HH:MM` value, interpreted in the option's `time_zone`. A `check_out_time` earlier on the clock than `check_in_time` means check-out falls on a later date.",
+                                    type: "string"
+                                  },
+                                  display_name: {
+                                    description: "Label for the check-in/check-out time pairing.",
+                                    type: "string"
+                                  }
+                                },
+                                required: [
+                                  "display_name",
+                                  "check_in_time",
+                                  "check_out_time"
+                                ],
+                                type: "object"
+                              },
+                              type: "array"
+                            },
+                            time_zone: {
+                              description: "IANA time zone for interpreting `time_pairs` and the date recurrence rules. Present only when the option fixes times or dates.",
+                              type: "string"
+                            }
+                          },
+                          required: ["display_name"],
+                          type: "object"
+                        },
+                        type: "array",
+                        "x-property-group-key": "access_codes"
+                      },
                       supported_code_lengths: {
                         description: "Supported code lengths for access codes.",
                         items: { format: "float", type: "number" },
@@ -34284,7 +34469,7 @@ var openapi = {
               discriminator: { propertyName: "warning_code" },
               oneOf: [
                 {
-                  description: "Indicates a provider-specific issue that may affect the access code. Check the warning message for details.",
+                  description: "The access code's PIN rotates periodically when the code is renewed. Retrieve the latest code before each use.",
                   properties: {
                     created_at: {
                       description: "Date and time at which Seam created the warning.",
@@ -34297,7 +34482,7 @@ var openapi = {
                     },
                     warning_code: {
                       description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
-                      enum: ["provider_issue"],
+                      enum: ["code_rotates_periodically"],
                       type: "string"
                     }
                   },