@izak0s/spacebring-api 13.0.0 → 14.0.0

package/dist/index.d.cts

@@ -2052,7 +2052,11 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        get?: never;
+        /**
+         * Retrieve a package
+         * @description Retrieve a package. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
+         */
+        get: operations["getPackage"];
         put?: never;
         post?: never;
         /**
@@ -9712,8 +9716,6 @@ interface components {
             lastSeenDate?: string;
             /** @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;
                 /** @description Whether permissions apply to all locations. */
                 allLocations: boolean;
                 /** @description Whether the admin can access analytics. */
@@ -9722,8 +9724,11 @@ interface components {
                 benefits: boolean;
                 /** @description Whether the admin can manage billing. */
                 billing: boolean;
-                /** @description Whether the admin can manage bookings. */
-                bookings: boolean;
+                /**
+                 * @deprecated
+                 * @description Deprecated. Use resources instead.
+                 */
+                bookings?: boolean;
                 /** @description Whether the admin can manage customers. */
                 customers: boolean;
                 /** @description Whether the admin can manage events. */
@@ -24532,11 +24537,6 @@ interface components {
                             /** @description Whether two-way sync is enabled. */
                             twoWaySyncEnabled: boolean;
                         } | null;
-                        /**
-                         * Format: uuid
-                         * @description Optional client-provided resource id.
-                         */
-                        id?: string;
                         /** @description Kisi access group reference. */
                         kisiGroupRef?: number | null;
                         /**
@@ -31962,6 +31962,41 @@ interface operations {
             };
         };
     };
+    getPackage: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description The id of the network. Required when using bearer token authentication */
+                "spacebring-network-id"?: string;
+            };
+            path: {
+                /** @description The id of the package. */
+                packageId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["getPackage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["responseError"];
+                };
+            };
+        };
+    };
     deletePackage: {
         parameters: {
             query?: never;
@@ -35642,7 +35677,7 @@ type CreatePlanBody = NonNullable<NonNullable<operations["createPlan"]["requestB
 type UpdatePlanBody = NonNullable<NonNullable<operations["updatePlan"]["requestBody"]>["content"]["application/json"]["plan"]>;
 
 /** A Package entity as returned by the Spacebring API. */
-type Package = NonNullable<operations["getPackages"]["responses"][200]["content"]["application/json"]["packages"]>[number];
+type Package = NonNullable<operations["getPackage"]["responses"][200]["content"]["application/json"]["package"]>;
 /** Query parameters for `sb.packages.list()`. */
 interface GetPackagesQuery {
     /** Maximum number of packages per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
@@ -36434,6 +36469,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
             searchQueryNext?: string;
         }>;
         iterate(query?: Omit<GetPackagesQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Package, void, undefined>;
+        get(packageId: string, options?: SpacebringRequestOptions): Promise<Package>;
         create(packageBody: CreatePackageBody, options?: SpacebringRequestOptions): Promise<Package>;
         update(packageId: string, packageBody: PatchPackageBody, options?: SpacebringRequestOptions): Promise<undefined>;
         delete(packageId: string, options?: SpacebringRequestOptions): Promise<undefined>;

package/dist/index.d.ts

@@ -2052,7 +2052,11 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        get?: never;
+        /**
+         * Retrieve a package
+         * @description Retrieve a package. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
+         */
+        get: operations["getPackage"];
         put?: never;
         post?: never;
         /**
@@ -9712,8 +9716,6 @@ interface components {
             lastSeenDate?: string;
             /** @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;
                 /** @description Whether permissions apply to all locations. */
                 allLocations: boolean;
                 /** @description Whether the admin can access analytics. */
@@ -9722,8 +9724,11 @@ interface components {
                 benefits: boolean;
                 /** @description Whether the admin can manage billing. */
                 billing: boolean;
-                /** @description Whether the admin can manage bookings. */
-                bookings: boolean;
+                /**
+                 * @deprecated
+                 * @description Deprecated. Use resources instead.
+                 */
+                bookings?: boolean;
                 /** @description Whether the admin can manage customers. */
                 customers: boolean;
                 /** @description Whether the admin can manage events. */
@@ -24532,11 +24537,6 @@ interface components {
                             /** @description Whether two-way sync is enabled. */
                             twoWaySyncEnabled: boolean;
                         } | null;
-                        /**
-                         * Format: uuid
-                         * @description Optional client-provided resource id.
-                         */
-                        id?: string;
                         /** @description Kisi access group reference. */
                         kisiGroupRef?: number | null;
                         /**
@@ -31962,6 +31962,41 @@ interface operations {
             };
         };
     };
+    getPackage: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description The id of the network. Required when using bearer token authentication */
+                "spacebring-network-id"?: string;
+            };
+            path: {
+                /** @description The id of the package. */
+                packageId: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["getPackage"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["responseError"];
+                };
+            };
+        };
+    };
     deletePackage: {
         parameters: {
             query?: never;
@@ -35642,7 +35677,7 @@ type CreatePlanBody = NonNullable<NonNullable<operations["createPlan"]["requestB
 type UpdatePlanBody = NonNullable<NonNullable<operations["updatePlan"]["requestBody"]>["content"]["application/json"]["plan"]>;
 
 /** A Package entity as returned by the Spacebring API. */
-type Package = NonNullable<operations["getPackages"]["responses"][200]["content"]["application/json"]["packages"]>[number];
+type Package = NonNullable<operations["getPackage"]["responses"][200]["content"]["application/json"]["package"]>;
 /** Query parameters for `sb.packages.list()`. */
 interface GetPackagesQuery {
     /** Maximum number of packages per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
@@ -36434,6 +36469,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
             searchQueryNext?: string;
         }>;
         iterate(query?: Omit<GetPackagesQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Package, void, undefined>;
+        get(packageId: string, options?: SpacebringRequestOptions): Promise<Package>;
         create(packageBody: CreatePackageBody, options?: SpacebringRequestOptions): Promise<Package>;
         update(packageId: string, packageBody: PatchPackageBody, options?: SpacebringRequestOptions): Promise<undefined>;
         delete(packageId: string, options?: SpacebringRequestOptions): Promise<undefined>;

package/dist/index.js

@@ -1962,6 +1962,15 @@ function createPackages(client, defaults) {
         "packages"
       );
     },
+    /**
+     * Retrieve a package
+     *
+     * @param packageId The id of the package.
+     * @param options Request options (abort signal).
+     */
+    async get(packageId, options) {
+      return unwrapProp(await client.GET("/packages/v1/{packageId}", { params: { path: { packageId } }, signal: options?.signal }), "package", "GET /packages/v1/{packageId}");
+    },
     /** Create a package */
     async create(packageBody, options) {
       return unwrapProp(await client.POST("/packages/v1", { body: { package: packageBody }, signal: options?.signal }), "package", "POST /packages/v1");