chore: sync changes from updated openapi doc

ewanharris · ewanharris · commit af95529d60b6 · 2024-06-11T12:34:34.000+01:00
diff --git a/README.md b/README.md
@@ -463,7 +463,7 @@ const { responses } = await fgaClient.batchCheck([{
   user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
   relation: "viewer",
   object: "document:roadmap",
-  contextual_tuples: [{
+  contextualTuples: [{
     user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
     relation: "writer",
     object: "document:roadmap"
@@ -492,7 +492,7 @@ responses = [{
     user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
     relation: "viewer",
     object: "document:roadmap",
-    contextual_tuples: [{
+    contextualTuples: [{
       user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
       relation: "writer",
       object: "document:roadmap"
@@ -538,7 +538,7 @@ const response = await fgaClient.listObjects({
   user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
   relation: "viewer",
   type: "document",
-  contextual_tuples: [{
+  contextualTuples: [{
     user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
     relation: "writer",
     object: "document:budget"
@@ -564,7 +564,7 @@ const response = await fgaClient.listRelations({
   user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
   object: "document:roadmap",
   relations: ["can_view", "can_edit", "can_delete"],
-  contextual_tuples: [{
+  contextualTuples: [{
     user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
     relation: "writer",
     object: "document:roadmap"
diff --git a/api.ts b/api.ts
diff --git a/apiModel.ts b/apiModel.ts
@@ -3,7 +3,7 @@
 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
  * Documentation: https://openfga.dev/docs
  * Support: https://openfga.dev/community
@@ -693,7 +693,7 @@ export interface ListUsersRequest {
      */
     relation: string;
     /**
-     * 
+     * The type of results returned. Only accepts exactly one value.
      * @type {Array<UserTypeFilter>}
      * @memberof ListUsersRequest
      */
@@ -1355,7 +1355,7 @@ export enum TypeName {
 }
 
 /**
- * 
+ * Type bound public access.  Normally represented using the `<type>:*` syntax  `employee:*` represents every object of type `employee`, including those not currently present in the system  See https://openfga.dev/docs/concepts#what-is-type-bound-public-access
  * @export
  * @interface TypedWildcard
  */
@@ -1367,6 +1367,27 @@ export interface TypedWildcard {
      */
     type: string;
 }
+/**
+ * 
+ * @export
+ * @interface UnauthenticatedResponse
+ */
+export interface UnauthenticatedResponse {
+    /**
+     * 
+     * @type {ErrorCode}
+     * @memberof UnauthenticatedResponse
+     */
+    code?: ErrorCode;
+    /**
+     * 
+     * @type {string}
+     * @memberof UnauthenticatedResponse
+     */
+    message?: string;
+}
+
+
 /**
  * 
  * @export
@@ -1400,7 +1421,7 @@ export interface UnprocessableContentMessageResponse {
 
 
 /**
- * 
+ * User.  Represents any possible value for a user (subject or principal). Can be a: - Specific user object e.g.: \'user:will\', \'folder:marketing\', \'org:contoso\', ...) - Specific userset (e.g. \'group:engineering#member\') - Public-typed wildcard (e.g. \'user:*\')  See https://openfga.dev/docs/concepts#what-is-a-user
  * @export
  * @interface User
  */
@@ -1551,7 +1572,7 @@ export interface UsersetTreeTupleToUserset {
     computed: Array<Computed>;
 }
 /**
- * 
+ * Userset.  A set or group of users, represented in the `<type>:<id>#<relation>` format  `group:fga#member` represents all members of group FGA, not to be confused by `group:fga` which represents the group itself as a specific object.  See: https://openfga.dev/docs/modeling/building-blocks/usersets#what-is-a-userset
  * @export
  * @interface UsersetUser
  */
diff --git a/base.ts b/base.ts
@@ -1,7 +1,7 @@
 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
  * Documentation: https://openfga.dev/docs
  * Support: https://openfga.dev/community
diff --git a/client.ts b/client.ts
@@ -1,7 +1,7 @@
 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
  * Documentation: https://openfga.dev/docs
  * Support: https://openfga.dev/community
diff --git a/common.ts b/common.ts
@@ -1,7 +1,7 @@
 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
  * Documentation: https://openfga.dev/docs
  * Support: https://openfga.dev/community
diff --git a/configuration.ts b/configuration.ts
@@ -1,7 +1,7 @@
 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
  * Documentation: https://openfga.dev/docs
  * Support: https://openfga.dev/community
diff --git a/credentials/credentials.ts b/credentials/credentials.ts
@@ -1,7 +1,7 @@
 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
  * Documentation: https://openfga.dev/docs
  * Support: https://openfga.dev/community
diff --git a/credentials/index.ts b/credentials/index.ts
@@ -1,7 +1,7 @@
 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
  * Documentation: https://openfga.dev/docs
  * Support: https://openfga.dev/community
diff --git a/credentials/types.ts b/credentials/types.ts
@@ -1,7 +1,7 @@
 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
  * Documentation: https://openfga.dev/docs
  * Support: https://openfga.dev/community
diff --git a/errors.ts b/errors.ts
@@ -1,7 +1,7 @@
 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
  * Documentation: https://openfga.dev/docs
  * Support: https://openfga.dev/community
diff --git a/index.ts b/index.ts
@@ -3,7 +3,7 @@
 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
  * Documentation: https://openfga.dev/docs
  * Support: https://openfga.dev/community
diff --git a/tests/client.test.ts b/tests/client.test.ts
@@ -1,7 +1,7 @@
 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
  * Documentation: https://openfga.dev/docs
  * Support: https://openfga.dev/community
diff --git a/tests/helpers/default-config.ts b/tests/helpers/default-config.ts
@@ -1,7 +1,7 @@
 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
  * Documentation: https://openfga.dev/docs
  * Support: https://openfga.dev/community
diff --git a/tests/helpers/index.ts b/tests/helpers/index.ts
@@ -1,7 +1,7 @@
 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
  * Documentation: https://openfga.dev/docs
  * Support: https://openfga.dev/community
diff --git a/tests/helpers/nocks.ts b/tests/helpers/nocks.ts
@@ -1,7 +1,7 @@
 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
  * Documentation: https://openfga.dev/docs
  * Support: https://openfga.dev/community
diff --git a/tests/index.test.ts b/tests/index.test.ts
@@ -1,7 +1,7 @@
 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
  * Documentation: https://openfga.dev/docs
  * Support: https://openfga.dev/community
diff --git a/tests/validation.test.ts b/tests/validation.test.ts
@@ -1,7 +1,7 @@
 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
  * Documentation: https://openfga.dev/docs
  * Support: https://openfga.dev/community
diff --git a/utils/assert-never.ts b/utils/assert-never.ts
@@ -1,7 +1,7 @@
 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
  * Documentation: https://openfga.dev/docs
  * Support: https://openfga.dev/community
diff --git a/utils/chunk-array.ts b/utils/chunk-array.ts
@@ -1,7 +1,7 @@
 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
  * Documentation: https://openfga.dev/docs
  * Support: https://openfga.dev/community
diff --git a/utils/generate-random-id.ts b/utils/generate-random-id.ts
@@ -1,7 +1,7 @@
 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
  * Documentation: https://openfga.dev/docs
  * Support: https://openfga.dev/community
diff --git a/utils/index.ts b/utils/index.ts
@@ -1,7 +1,7 @@
 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
  * Documentation: https://openfga.dev/docs
  * Support: https://openfga.dev/community
diff --git a/utils/set-header-if-not-set.ts b/utils/set-header-if-not-set.ts
@@ -1,7 +1,7 @@
 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
  * Documentation: https://openfga.dev/docs
  * Support: https://openfga.dev/community
diff --git a/utils/set-not-enumerable-property.ts b/utils/set-not-enumerable-property.ts
@@ -1,7 +1,7 @@
 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
  * Documentation: https://openfga.dev/docs
  * Support: https://openfga.dev/community
diff --git a/validation.ts b/validation.ts
@@ -1,7 +1,7 @@
 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
  * Documentation: https://openfga.dev/docs
  * Support: https://openfga.dev/community

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`/**`
`2`	`2`	`* JavaScript and Node.js SDK for OpenFGA`
`3`	`3`	`*`
`4`		`- * API version: 0.1`
	`4`	`+ * API version: 1.x`
`5`	`5`	`* Website: https://openfga.dev`
`6`	`6`	`* Documentation: https://openfga.dev/docs`
`7`	`7`	`* Support: https://openfga.dev/community`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`/**`
`4`	`4`	`* JavaScript and Node.js SDK for OpenFGA`
`5`	`5`	`*`
`6`		`- * API version: 0.1`
	`6`	`+ * API version: 1.x`
`7`	`7`	`* Website: https://openfga.dev`
`8`	`8`	`* Documentation: https://openfga.dev/docs`
`9`	`9`	`* Support: https://openfga.dev/community`