@izak0s/spacebring-api 11.3.0 → 12.0.0

package/dist/index.d.ts

@@ -2928,7 +2928,7 @@ interface paths {
         head?: never;
         /**
          * Update a money transaction
-         * @description Approve or cancel a pending money transaction paid externally. <h3>OAuth</h3>Required scopes: <code>transactions</code>
+         * @description Change the internal note of a money transaction, or approve or cancel a pending money transaction paid externally. A user needs the Billing permission in the transaction's location. <h3>OAuth</h3>Required scopes: <code>transactions</code>
          */
         patch: operations["patchMoneyTransaction"];
         trace?: never;
@@ -3343,6 +3343,7 @@ interface components {
                      * @enum {string}
                      */
                     buttonLabel: "apply" | "buy" | "contact" | "get" | "learnMore";
+                    /** @description Confirmation email settings for applications. */
                     confirmationEmail: {
                         /** @description Whether a confirmation email is sent after applying. */
                         enabled: boolean;
@@ -3371,7 +3372,7 @@ interface components {
                  * @description Unique identifier of the benefit.
                  */
                 id: string;
-                /** @description Auto-detected language of the description. */
+                /** @description Auto-detected language of the description. Empty when there is no description. */
                 locale: string;
                 /**
                  * Format: uuid
@@ -3423,6 +3424,7 @@ interface components {
                  * @enum {string}
                  */
                 buttonLabel: "apply" | "buy" | "contact" | "get" | "learnMore";
+                /** @description Confirmation email settings for applications. */
                 confirmationEmail: {
                     /** @description Whether a confirmation email is sent after applying. */
                     enabled: boolean;
@@ -3451,7 +3453,7 @@ interface components {
              * @description Unique identifier of the benefit.
              */
             id: string;
-            /** @description Auto-detected language of the description. */
+            /** @description Auto-detected language of the description. Empty when there is no description. */
             locale: string;
             /**
              * Format: uuid
@@ -3500,6 +3502,7 @@ interface components {
                      * @enum {string}
                      */
                     buttonLabel: "apply" | "buy" | "contact" | "get" | "learnMore";
+                    /** @description Confirmation email settings for applications. */
                     confirmationEmail: {
                         /** @description Whether a confirmation email is sent after applying. */
                         enabled: boolean;
@@ -3528,7 +3531,7 @@ interface components {
                  * @description Unique identifier of the benefit.
                  */
                 id: string;
-                /** @description Auto-detected language of the description. */
+                /** @description Auto-detected language of the description. Empty when there is no description. */
                 locale: string;
                 /**
                  * Format: uuid
@@ -7859,6 +7862,11 @@ interface components {
              * @description ID of the ticket's check-in in the check-ins service. Present when check-in is enabled for the event.
              */
             checkInRef?: string;
+            /**
+             * Format: date-time
+             * @description ISO timestamp of when the attendee last checked out. Cleared when they check in again.
+             */
+            checkOutDate?: string;
             /** @description Six-digit code the attendee enters on the Reception app to check in. Visible to the ticket owner and admins when check-in is enabled for the event. */
             code?: string;
             /** @description Note the attendee left when purchasing the ticket. Visible to the ticket owner and location admins only. */
@@ -8321,7 +8329,7 @@ interface components {
         };
         post: {
             /** @description Number of comments on the post. */
-            comments: number;
+            comments?: number | null;
             /**
              * Format: date-time
              * @description ISO timestamp of when the post was created.
@@ -8340,7 +8348,7 @@ interface components {
             /** @description Whether the current user has liked the post. */
             liked?: boolean;
             /** @description Number of likes on the post. */
-            likes: number;
+            likes?: number | null;
             /** @description Detected language locale of the post text. */
             locale?: string;
             /**
@@ -8351,20 +8359,20 @@ interface components {
             /** @description Media files attached to the post. */
             media: {
                 /** @description Image height in pixels. */
-                height: number;
+                height?: number | null;
                 /**
                  * Format: uuid
                  * @description Unique identifier of the media item.
                  */
-                id: string;
+                id?: string | null;
                 /** @description Storage key of the media file. */
                 key: string;
                 /** @description MIME type of the media file. */
-                mime: string;
+                mime?: string | null;
                 /** @description Public URL of the media file. */
-                url: string;
+                url?: string | null;
                 /** @description Image width in pixels. */
-                width: number;
+                width?: number | null;
             }[];
             /** @description Membership of the post author. */
             membership: {
@@ -8372,7 +8380,7 @@ interface components {
                  * Format: uuid
                  * @description Unique identifier of the membership.
                  */
-                id: string;
+                id?: string | null;
                 /** @description User associated with the membership. */
                 user?: {
                     /** @description User bio. */
@@ -8403,7 +8411,7 @@ interface components {
              * Format: uuid
              * @description ID of the membership that created the post.
              */
-            membershipRef: string;
+            membershipRef?: string | null;
             /** @description Open Graph metadata for link previews. */
             og?: {
                 /** @description Open Graph description. */
@@ -8415,12 +8423,12 @@ interface components {
                 /** @description Open Graph type. */
                 type?: string | null;
                 /** @description Open Graph URL. */
-                url: string;
+                url?: string | null;
                 /** @description Open Graph video URL. */
                 videoUrl?: string | null;
             };
             /** @description Whether the post is pinned. */
-            pinned: boolean;
+            pinned?: boolean | null;
             /** @description Post text content. */
             text?: string;
             /** @description User who created the post. */
@@ -8463,14 +8471,14 @@ interface components {
             /** @description Whether the current user has liked the comment. */
             liked?: boolean;
             /** @description Number of likes on the comment. */
-            likes: number;
+            likes?: number | null;
             /** @description Membership of the comment author. */
             membership: {
                 /**
                  * Format: uuid
                  * @description Unique identifier of the membership.
                  */
-                id: string;
+                id?: string | null;
                 /** @description User associated with the membership. */
                 user?: {
                     /**
@@ -8498,8 +8506,8 @@ interface components {
                  * @description Unique identifier of the mention.
                  */
                 id: string;
-                /** @description Mention value. */
-                value: string;
+                /** @description Full name of the mentioned user. Absent when the users service no longer knows the user. */
+                value?: string;
             }[];
             /**
              * Format: uuid
@@ -8529,14 +8537,14 @@ interface components {
              * Format: uuid
              * @description Unique identifier of the like.
              */
-            id: string;
+            id?: string | null;
             /** @description Membership of the user who liked. */
             membership: {
                 /**
                  * Format: uuid
                  * @description Unique identifier of the membership.
                  */
-                id: string;
+                id?: string | null;
                 /** @description User associated with the membership. */
                 user?: {
                     /**
@@ -9010,9 +9018,9 @@ interface components {
                     duration?: number;
                     /**
                      * Format: uuid
-                     * @description Unique identifier of the grant.
+                     * @description Unique identifier of the grant. Absent on grants of packages created before grants had IDs.
                      */
-                    id: string;
+                    id?: string;
                     /**
                      * @description Type of balance this grant provides.
                      * @enum {string}
@@ -9072,9 +9080,9 @@ interface components {
                     duration?: number;
                     /**
                      * Format: uuid
-                     * @description Unique identifier of the grant.
+                     * @description Unique identifier of the grant. Absent on grants of packages created before grants had IDs.
                      */
-                    id: string;
+                    id?: string;
                     /**
                      * @description Type of balance this grant provides.
                      * @enum {string}
@@ -9667,7 +9675,7 @@ interface components {
              * @description ISO timestamp of when the user was last seen in the network.
              */
             lastSeenDate?: string;
-            /** @description Location-scoped admin permissions. Included only for owners or when viewing the current user's registration. */
+            /** @description Location-scoped admin permissions. Included only for owners and super admins or when viewing the current user's registration. */
             locationPermissions?: {
                 /** @description Whether the admin can manage other admins. */
                 admins: boolean;
@@ -9702,7 +9710,7 @@ interface components {
              * @description Role of the user in the network.
              * @enum {string}
              */
-            role?: "owner" | "admin" | "member";
+            role?: "owner" | "superAdmin" | "admin" | "member";
             /** @description ISO timestamp or date when terms consent was given. */
             termsConsentDate?: string;
             /**
@@ -9763,6 +9771,11 @@ interface components {
                          * @description Customer id.
                          */
                         id: string;
+                        /** @description Company logo when the customer is a company. */
+                        logo?: {
+                            key: string;
+                            url: string;
+                        };
                         /** @description Company name when the customer is a company. */
                         title?: string;
                         /**
@@ -9781,6 +9794,8 @@ interface components {
                             id: string;
                             /** @description User first name. */
                             name?: string | null;
+                            /** @description Profile photo URL. */
+                            photoUrl?: string | null;
                             /** @description User last name. */
                             surname?: string | null;
                         };
@@ -10460,6 +10475,11 @@ interface components {
                          * @description Customer id.
                          */
                         id: string;
+                        /** @description Company logo when the customer is a company. */
+                        logo?: {
+                            key: string;
+                            url: string;
+                        };
                         /** @description Company name when the customer is a company. */
                         title?: string;
                         /**
@@ -10478,6 +10498,8 @@ interface components {
                             id: string;
                             /** @description User first name. */
                             name?: string | null;
+                            /** @description Profile photo URL. */
+                            photoUrl?: string | null;
                             /** @description User last name. */
                             surname?: string | null;
                         };
@@ -11153,6 +11175,11 @@ interface components {
                      * @description Customer id.
                      */
                     id: string;
+                    /** @description Company logo when the customer is a company. */
+                    logo?: {
+                        key: string;
+                        url: string;
+                    };
                     /** @description Company name when the customer is a company. */
                     title?: string;
                     /**
@@ -11171,6 +11198,8 @@ interface components {
                         id: string;
                         /** @description User first name. */
                         name?: string | null;
+                        /** @description Profile photo URL. */
+                        photoUrl?: string | null;
                         /** @description User last name. */
                         surname?: string | null;
                     };
@@ -11281,6 +11310,11 @@ interface components {
                      * @description Customer id.
                      */
                     id: string;
+                    /** @description Company logo when the customer is a company. */
+                    logo?: {
+                        key: string;
+                        url: string;
+                    };
                     /** @description Company name when the customer is a company. */
                     title?: string;
                     /**
@@ -11299,6 +11333,8 @@ interface components {
                         id: string;
                         /** @description User first name. */
                         name?: string | null;
+                        /** @description Profile photo URL. */
+                        photoUrl?: string | null;
                         /** @description User last name. */
                         surname?: string | null;
                     };
@@ -20194,6 +20230,8 @@ interface components {
                  * @description Unique identifier of the transaction.
                  */
                 id: string;
+                /** @description Note about the payment that only administrators see, such as how an external payment was collected. Absent when there is no note or the viewer is not an administrator. */
+                internalNote?: string;
                 /**
                  * @deprecated
                  * @description Deprecated. Use product instead.
@@ -20906,6 +20944,8 @@ interface components {
                  * @description Unique identifier of the transaction.
                  */
                 id: string;
+                /** @description Note about the payment that only administrators see, such as how an external payment was collected. Absent when there is no note or the viewer is not an administrator. */
+                internalNote?: string;
                 /**
                  * @deprecated
                  * @description Deprecated. Use product instead.
@@ -21618,6 +21658,8 @@ interface components {
                  * @description Unique identifier of the transaction.
                  */
                 id: string;
+                /** @description Note about the payment that only administrators see, such as how an external payment was collected. Absent when there is no note or the viewer is not an administrator. */
+                internalNote?: string;
                 /**
                  * @deprecated
                  * @description Deprecated. Use product instead.
@@ -26804,11 +26846,13 @@ interface components {
                 "application/json": {
                     /** @description Transaction fields to update. */
                     transaction: {
+                        /** @description Note about the payment that only administrators see, such as how an external payment was collected. Can be changed on any money transaction. An empty string clears it. */
+                        internalNote?: string;
                         /**
-                         * @description New status of the pending external payment: `succeeded` approves it, `canceled` rejects it.
+                         * @description New status of the pending external payment: `succeeded` approves it, `canceled` rejects it. Only a pending external payment can change its status.
                          * @enum {string}
                          */
-                        status: "canceled" | "succeeded";
+                        status?: "canceled" | "succeeded";
                     };
                 };
             };
@@ -27488,7 +27532,7 @@ interface operations {
             query?: {
                 /** @description UUID of the benefit. */
                 benefitRef?: string;
-                /** @description Comma-separated benefit category UUIDs, e.g. `uuid1,uuid2`. */
+                /** @description Filter by the category of the benefit applied for: the IDs of benefit categories. Comma-separated, one or more UUIDs. */
                 categoryRef?: string;
                 /** @description Filter applications submitted on or after this date (ISO 8601). Use with createDate[lte] for a range. */
                 "createDate[gte]"?: string;
@@ -29292,16 +29336,7 @@ interface operations {
                 nextPageToken?: string;
                 /** @description Case-insensitive search by contract title. Requires customerRef or locationRef to scope the search. */
                 q?: string;
-                /**
-                 * @description Filter by contract status. Comma-separated values, e.g. `draft,issued`.
-                 *
-                 *     Supported values:
-                 *     - **draft** — created but not sent
-                 *     - **issued** — sent, awaiting signature
-                 *     - **signed** — active
-                 *     - **declined** — rejected
-                 *     - **terminated** — cancelled after signing
-                 */
+                /** @description Filter by status: 'draft' created and not sent yet, 'issued' sent and waiting for signatures, 'signed' signed by everyone and active, 'declined' a signer declined it or it expired unsigned, 'terminated' ended by an admin after it was signed. Defaults to every status. Comma-separated, one or more of: draft, issued, signed, declined, terminated. */
                 status?: string;
             };
             header?: {
@@ -33388,20 +33423,11 @@ interface operations {
                 locationRef?: string;
                 /** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
                 nextPageToken?: string;
-                /** @description Sort order for results. */
+                /** @description Sort order as field:direction, where field is startDate, endDate, createDate or renewDate and direction is asc or desc, such as startDate:asc. Applies to a location's subscriptions; defaults to createDate:desc. */
                 order?: string;
-                /** @description UUID of the plan to filter subscriptions by. */
+                /** @description UUID of the plan to filter subscriptions by. Applies to a location's subscriptions. */
                 planRef?: string;
-                /**
-                 * @description Filter by subscription status. Comma-separated values, e.g. `active,scheduled`. Defaults to `active`, `scheduled`, and `incomplete` when omitted.
-                 *
-                 *     Supported values:
-                 *     - **active** — currently active
-                 *     - **scheduled** — scheduled to start
-                 *     - **incomplete** — pending setup or payment
-                 *     - **incompleteExpired** — incomplete and expired
-                 *     - **canceled** — canceled
-                 */
+                /** @description Filter by status: 'active' started and not ended or canceled, 'scheduled' starts in the future, 'incomplete' setup not finished (such as an unsigned contract or an unpaid purchase), 'incompleteExpired' setup was never finished (the contract was declined or the payment canceled), 'canceled' canceled or ended. Defaults to active, scheduled and incomplete. Comma-separated, one or more of: active, scheduled, incomplete, incompleteExpired, canceled. */
                 status?: string;
             };
             header?: {
@@ -35461,18 +35487,11 @@ interface GetSubscriptionsQuery {
     locationRef?: string;
     /** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
     nextPageToken?: string;
-    /** Sort order for results. */
+    /** Sort order as field:direction, where field is startDate, endDate, createDate or renewDate and direction is asc or desc, such as startDate:asc. Applies to a location's subscriptions; defaults to createDate:desc. */
     order?: string;
-    /** UUID of the plan to filter subscriptions by. */
+    /** UUID of the plan to filter subscriptions by. Applies to a location's subscriptions. */
     planRef?: string;
-    /** Filter by subscription status. Comma-separated values, e.g. `active,scheduled`. Defaults to `active`, `scheduled`, and `incomplete` when omitted.
-  
-    Supported values:
-    - **active** — currently active
-    - **scheduled** — scheduled to start
-    - **incomplete** — pending setup or payment
-    - **incompleteExpired** — incomplete and expired
-    - **canceled** — canceled */
+    /** Filter by status: 'active' started and not ended or canceled, 'scheduled' starts in the future, 'incomplete' setup not finished (such as an unsigned contract or an unpaid purchase), 'incompleteExpired' setup was never finished (the contract was declined or the payment canceled), 'canceled' canceled or ended. Defaults to active, scheduled and incomplete. Comma-separated, one or more of: active, scheduled, incomplete, incompleteExpired, canceled. */
     status?: string;
 }
 /** Request body for `sb.subscriptions.create()`. */
@@ -35883,14 +35902,7 @@ interface GetContractsQuery {
     nextPageToken?: string;
     /** Case-insensitive search by contract title. Requires customerRef or locationRef to scope the search. */
     q?: string;
-    /** Filter by contract status. Comma-separated values, e.g. `draft,issued`.
-  
-    Supported values:
-    - **draft** — created but not sent
-    - **issued** — sent, awaiting signature
-    - **signed** — active
-    - **declined** — rejected
-    - **terminated** — cancelled after signing */
+    /** Filter by status: 'draft' created and not sent yet, 'issued' sent and waiting for signatures, 'signed' signed by everyone and active, 'declined' a signer declined it or it expired unsigned, 'terminated' ended by an admin after it was signed. Defaults to every status. Comma-separated, one or more of: draft, issued, signed, declined, terminated. */
     status?: string;
 }
 /** Query parameters for `sb.contracts.templates.list()`. */
@@ -36145,7 +36157,7 @@ type BenefitMedia = NonNullable<operations["createBenefitMedia"]["responses"][20
 interface GetBenefitApplicationsQuery {
     /** UUID of the benefit. */
     benefitRef?: string;
-    /** Comma-separated benefit category UUIDs, e.g. `uuid1,uuid2`. */
+    /** Filter by the category of the benefit applied for: the IDs of benefit categories. Comma-separated, one or more UUIDs. */
     categoryRef?: string;
     /** Filter applications submitted on or after this date (ISO 8601). Use with createDate[lte] for a range. */
     "createDate[gte]"?: string;

package/dist/index.js

@@ -2808,7 +2808,7 @@ function createTransactions(client, defaults) {
       /**
        * Update a money transaction
        *
-       * Approve or cancel a pending money transaction paid externally.
+       * Change the internal note of a money transaction, or approve or cancel a pending money transaction paid externally. A user needs the Billing permission in the transaction's location.
        *
        * @param transactionId The id of the transaction.
        * @param transaction The `transaction` payload.