deere-sdk 2.3.0 → 2.4.0

package/dist/types/generated/flags.d.ts

@@ -3,7 +3,7 @@
  * Do not make direct changes to the file.
  */
 export interface paths {
-    '/organizations/{orgId}/flags/{flagId}': {
+    '/organizations/{orgId}/fields/{fieldId}/flags': {
         parameters: {
             query?: never;
             header?: never;
@@ -11,21 +11,109 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * List a flag by org id and Flag id
-         * @description This endpoint will return a flag for a given org and Flag id.
+         * List flags for the field
+         * @description This resource will return a list of flag objects associated with the field.
          */
-        get: operations['getFlagForOrganizationByFlagId'];
+        get: operations['getOrgFieldFlags'];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    '/organizations/{orgId}/flagCategories': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
         /**
-         * Update flag by id
-         * @description This resource will update flag by Organization and Flag Id.
+         * List Flags Category Collection
+         * @description This resource will return a Flags Category Collection for Organization.
          */
-        put: operations['updateFlagByIdOrgId'];
+        get: operations['getFlagCategoriesForOrganization'];
+        put?: never;
+        /**
+         * Create a custom category
+         * @description This resource will create a custom category in the given organization.
+         */
+        post: operations['createFlagCategory'];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    '/organizations/{orgId}/flagCategories/{categoryId}': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get flag category by id
+         * @description This resource will return a flag category with the name translated into the specified language. The category can be a reference flagCategory, a master flagCategory created from a referenced flagCategory or a user-defined category.
+         */
+        get: operations['getFlagCategoryByIdOrgId'];
+        /**
+         * Update flag category by organization and flag category Id
+         * @description This resource will update flag category by Id.
+         */
+        put: operations['updateFlagCategoryByIdOrgId'];
         post?: never;
         /**
-         * Delete a flag for a given org
-         * @description This resource will delete a single flag based on its Id and org id
+         * Delete a flag category
+         * @description This resource will delete a single empty category based on the categoryId and orgId.
          */
-        delete: operations['deleteFlagByIdOrgId'];
+        delete: operations['deleteFlagCategoryByIdOrgId'];
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    '/organizations/{orgId}/flagCategories/{categoryId}/flagCategoryPreferences': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List collection of FlagCategoryPreference
+         * @description This endpoint will return a collection of FlagCategoryPreference objects associated with the given flag category. The object with the key "default" is created automatically on the 1st access to the flagCategory object by a client. The default preference object shall be initialized with default values: prefKey: "default" hexColor: "#FFFFFF"
+         */
+        get: operations['getFlagCategoryPreferencesByIdOrgId'];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    '/organizations/{orgId}/flagCategoryPreferences/{flagCategoryPreferencesId}': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * View preferences object for a category
+         * @description This resource will return the preferences object for the given flag category and org
+         */
+        get: operations['getFlagCategoryPreferenceByIdOrgId'];
+        /**
+         * Update flag category preferences
+         * @description This resource will update flag category preferences by Id and Org
+         */
+        put: operations['updateFlagCategoryPreferenceByIdOrgId'];
+        post?: never;
+        delete?: never;
         options?: never;
         head?: never;
         patch?: never;
@@ -55,7 +143,7 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
-    '/organizations/{orgId}/fields/{fieldId}/flags': {
+    '/organizations/{orgId}/flags/{flagId}': {
         parameters: {
             query?: never;
             header?: never;
@@ -63,13 +151,21 @@ export interface paths {
             cookie?: never;
         };
         /**
-         * List flags for the field
-         * @description This resource will return a list of flag objects associated with the field.
+         * List a flag by org id and Flag id
+         * @description This endpoint will return a flag for a given org and Flag id.
          */
-        get: operations['getOrgFieldFlags'];
-        put?: never;
+        get: operations['getFlagForOrganizationByFlagId'];
+        /**
+         * Update flag by id
+         * @description This resource will update flag by Organization and Flag Id.
+         */
+        put: operations['updateFlagByIdOrgId'];
         post?: never;
-        delete?: never;
+        /**
+         * Delete a flag for a given org
+         * @description This resource will delete a single flag based on its Id and org id
+         */
+        delete: operations['deleteFlagByIdOrgId'];
         options?: never;
         head?: never;
         patch?: never;
@@ -79,6 +175,140 @@ export interface paths {
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
+        ContentType: unknown;
+        FlagCategory: {
+            /**
+             * @description Name of the category.
+             * @example Rocks
+             */
+            categoryTitle?: string;
+            /**
+             * @description Whether or not the category is archived
+             * @default false
+             * @example false
+             */
+            archived: boolean;
+            /**
+             * @description Shows/sets whether the category is a preferred one in the current org. This can be applied to both user-defined and reference flag categories in this org.
+             * @example true
+             */
+            preferred?: boolean;
+            /**
+             * Format: uuid
+             * @description GUID of a flag category.
+             * @example 7c602ae8-4351-4640-9de8-88792bda83d7
+             */
+            readonly id?: string;
+            /**
+             * Format: date-time
+             * @example 2018-12-28T09:17:10.694Z
+             */
+            createdDate?: string;
+            /**
+             * Format: date-time
+             * @example 2018-12-28T09:17:10.694Z
+             */
+            lastModifiedDate?: string;
+        };
+        FlagCategory2: {
+            /**
+             * @description Name of the category.
+             * @example Rocks
+             */
+            categoryTitle?: string;
+            /**
+             * @description Whether or not the category is archived
+             * @default false
+             * @example false
+             */
+            archived: boolean;
+            /**
+             * @description Shows/sets whether the category is a preferred one in the current org. This can be applied to both user-defined and reference flag categories in this org.
+             * @example true
+             */
+            preferred?: boolean;
+            /**
+             * Format: uuid
+             * @description GUID of a flag category.
+             * @example 688c20bb-9609-4590-95c9-649ba65c06df
+             */
+            readonly id?: string;
+            /** @example 2018-12-18T13:29:14.167Z */
+            createdDate?: string;
+            /** @example 2018-12-18T13:29:30.924Z */
+            lastModifiedDate?: string;
+        };
+        /** @description The object for keeping visual and non-visual preferences for the given FlagCategory. */
+        FlagCategoryPreference: {
+            /**
+             * Format: GUID
+             * @description Id of the FlagCategoryPreferences resource.
+             * @example ac6a5bb5fae84b1da29459a8101295b0
+             */
+            id?: string;
+            /**
+             * @description Key name for the preference object to be identified by clients to support client-specific preferences
+             * @default default
+             * @example default
+             */
+            prefKey: string;
+            /**
+             * @description Color code for the flag category in hexadecimal format.
+             * @example #0BA74A
+             */
+            hexColor?: string;
+            /**
+             * Format: date-time
+             * @example 2018-07-01T21:00:11Z
+             */
+            createdTime?: string;
+            /**
+             * Format: date-time
+             * @example 2018-07-01T21:10:10Z
+             */
+            modifiedTime?: string;
+        };
+        GetPreferences: {
+            /**
+             * @description Users Link.
+             * @example https://sandboxapi.deere.com/platform/users/rostaninoleg
+             */
+            modifiedBy?: unknown;
+        };
+        LinkCategoryId: {
+            /**
+             * @description Organization Link.
+             * @example https://sandboxapi.deere.com/platform/organizations/123456
+             */
+            organization?: unknown;
+            /**
+             * @description Update Category Link.
+             * @example https://sandboxapi.deere.com/platform/flagCategories/7c602ae8-4351-4640-9de8-88792bda83d7
+             */
+            updateCategory?: unknown;
+            /**
+             * @description Delete Category Link.
+             * @example https://sandboxapi.deere.com/platform/organizations/{orgId}/flagCategories/7c602ae8-4351-4640-9de8-88792bda83d7
+             */
+            deleteCategory?: unknown;
+        };
+        LinkCategoryId2: {
+            /**
+             * @description Organization Link.
+             * @example https://sandboxapi.deere.com/platform/organizations/123456
+             */
+            organization?: unknown;
+            /**
+             * @description Update Category Link.
+             * @example https://sandboxapi.deere.com/platform/flagCategories/835b863c-1997-451d-8850-1123ff4ec0e3
+             */
+            updateCategory?: unknown;
+            /**
+             * @description Delete Category Link.
+             * @example https://sandboxapi.deere.com/platform/flagCategories/835b863c-1997-451d-8850-1123ff4ec0e3
+             */
+            deleteCategory?: unknown;
+        };
         LinkFlagId: {
             /**
              * @description Flag Category Preferences Link.
@@ -130,7 +360,31 @@ export interface components {
              */
             field?: unknown;
         };
-        ContentType: unknown;
+        PutPreferences: {
+            /**
+             * @description Users Link.
+             * @example https://sandboxapi.deere.com/platform/users/USERNAME
+             */
+            modifiedBy?: unknown;
+        };
+        PutResponse: {
+            /**
+             * @description Name of the category.
+             * @example Rocks
+             */
+            categoryTitle?: string;
+            /**
+             * @description Whether or not the category is archived
+             * @default false
+             * @example false
+             */
+            archived: boolean;
+            /**
+             * @description Shows/sets whether the category is a preferred one in the current org. This can be applied to both user-defined and reference flag categories in this org.
+             * @example true
+             */
+            preferred?: boolean;
+        };
         ValuesFlagId: {
             /**
              * @description Currently only three geometries types (Point, LineString and Polygon) are supported.
@@ -244,38 +498,66 @@ export interface components {
         };
     };
     parameters: {
+        /** @description If embedding flag category, language that category name shall be returned within a flag, e.g., "de-DE" */
+        'Accept-Language': string;
+        /** @description Language category names are being returned by the endpoint. */
+        'Accept-Language_FlagCategories': string;
+        /** @description CategoryId to query for Category. */
+        CategoryId: string;
+        /** @description CategoryId to query for Category. */
+        CategoryId2: string;
+        /** @description CategoryId to query for preferences. */
+        CategoryId_FlagCategoriesPreferences: string;
+        /** @description Specify a comma-separated list of category GUIDs to retrieve */
+        CategoryIds: string;
+        /** @description Specify a comma-separated list of category names to retrieve. Instead/together with names, aliases for well known categories can be used */
+        CategoryNames: string;
+        /** @description Embed additional attributes if required to reduce the number of requests */
+        Embed: string;
+        /** @description Embed additional attributes if required. */
+        Embed_FlagCategories: string;
+        /** @description Flags created before end time (in UTC) will be returned */
+        EndTime: string;
         /** @description Fields guid of the field. */
         FieldId: string;
+        /** @description flagCategoryPreferencesId to query for preferences. */
+        FlagCategoryPreferencesId: string;
+        /** @description flagCategoryPreferencesId to query for preferences. */
+        FlagCategoryPreferencesId2: string;
+        /** @description flagId to query for flag */
+        FlagId: string;
+        /** @description Specify whether to request global flags, field-related flags or both */
+        FlagScopes: string;
+        /** @description Does not populate geometry, overrides simple if both are true */
+        MetadataOnly: boolean;
         /** @description Org Id to query for Flag */
         OrgId: string;
         /** @description Organization Id */
         OrgId2: string;
+        /** @description Organization Id. */
+        OrgId2_FlagCategories: string;
         /** @description Organization Id where the Flag belongs to */
         OrgId3: string;
-        /** @description flagId to query for flag */
-        FlagId: string;
-        /** @description If embedding flag category, language that category name shall be returned within a flag, e.g., "de-DE" */
-        'Accept-Language': string;
-        /** @description Embed additional attributes if required to reduce the number of requests */
-        Embed: string;
-        /** @description Flags created after start time (in UTC) will be returned */
-        StartTime: string;
-        /** @description Flags created before end time (in UTC) will be returned */
-        EndTime: string;
-        /** @description Specify a comma-separated list of category GUIDs to retrieve */
-        CategoryIds: string;
-        /** @description Specify a comma-separated list of category names to retrieve. Instead/together with names, aliases for well known categories can be used */
-        CategoryNames: string;
+        /** @description OrgId to query for Category */
+        OrgId3_FlagCategories: string;
+        /** @description Organization Id where the Flag category belongs to */
+        OrgId4: string;
+        /** @description OrgId to query for Org. */
+        OrgId_FlagCategories: string;
+        /** @description orgId to query for preferences. */
+        OrgId_FlagCategoriesPreferences: string;
+        /** @description orgId to query for preferences. */
+        OrganizationId: string;
+        /** @description CategoryId to query for preferences */
+        PrefKey: string;
         /** @description Request flags by archived status */
         RecordFilter: string;
-        /** @description Specify whether to request global flags, field-related flags or both */
-        FlagScopes: string;
         /** @description Clients which cannot handle specific geometry types can select only supported ones. Request flags with geometry only of type */
         ShapeTypes: string;
         /** @description Populates simplified geometry */
         Simple: boolean;
-        /** @description Does not populate geometry, overrides simple if both are true */
-        MetadataOnly: boolean;
+        /** @description Flags created after start time (in UTC) will be returned */
+        StartTime: string;
     };
     requestBodies: never;
     headers: never;
@@ -283,7 +565,7 @@ export interface components {
 }
 export type $defs = Record<string, never>;
 export interface operations {
-    getFlagForOrganizationByFlagId: {
+    getOrgFieldFlags: {
         parameters: {
             query?: {
                 /** @description Embed additional attributes if required to reduce the number of requests */
@@ -298,8 +580,6 @@ export interface operations {
                 categoryNames?: components['parameters']['CategoryNames'];
                 /** @description Request flags by archived status */
                 recordFilter?: components['parameters']['RecordFilter'];
-                /** @description Specify whether to request global flags, field-related flags or both */
-                flagScopes?: components['parameters']['FlagScopes'];
                 /** @description Clients which cannot handle specific geometry types can select only supported ones. Request flags with geometry only of type */
                 shapeTypes?: components['parameters']['ShapeTypes'];
                 /** @description Populates simplified geometry */
@@ -312,24 +592,24 @@ export interface operations {
                 'Accept-Language'?: components['parameters']['Accept-Language'];
             };
             path: {
-                /** @description Org Id to query for Flag */
-                orgId: components['parameters']['OrgId'];
-                /** @description flagId to query for flag */
-                flagId: components['parameters']['FlagId'];
+                /** @description Organization Id where the Flag belongs to */
+                orgId: components['parameters']['OrgId3'];
+                /** @description Fields guid of the field. */
+                fieldId: components['parameters']['FieldId'];
             };
             cookie?: never;
         };
         requestBody?: never;
         responses: {
-            200: components['responses']['FlagIdGet'];
-            /** @description Access forbidden. The user does not have permission to access the given organization. */
+            200: components['responses']['GetOrgId'];
+            /** @description Forbidden. The user has no access to the given flag */
             403: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content?: never;
             };
-            /** @description Entity Not found. No organization present for given orgId or no flag id present in the given org id */
+            /** @description Entity Not found. No organization and/or field with these ids. */
             404: {
                 headers: {
                     [name: string]: unknown;
@@ -338,34 +618,202 @@ export interface operations {
             };
         };
     };
-    updateFlagByIdOrgId: {
+    getFlagCategoriesForOrganization: {
         parameters: {
-            query?: never;
-            header?: never;
+            query?: {
+                /** @description Embed additional attributes if required. */
+                embed?: components['parameters']['Embed_FlagCategories'];
+            };
+            header?: {
+                /** @description Language category names are being returned by the endpoint. */
+                'Accept-Language'?: components['parameters']['Accept-Language_FlagCategories'];
+            };
             path: {
-                /** @description Organization Id */
-                orgId: components['parameters']['OrgId2'];
-                /** @description flagId to query for flag */
-                flagId: components['parameters']['FlagId'];
+                /** @description Organization Id where the Flag category belongs to */
+                orgId: components['parameters']['OrgId4'];
             };
             cookie?: never;
         };
-        requestBody?: {
-            content: {
-                'application/vnd.deere.axiom.v3+json': components['schemas']['ValuesFlagIdPut'];
-            };
-        };
+        requestBody?: never;
         responses: {
-            /** @description Update response by Flag Id */
+            /** @description Returns collection of flag categories which includes reference and user-defined categories. */
             200: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
-                    'application/vnd.deere.axiom.v3+json': unknown;
+                    'application/vnd.deere.axiom.v3+json': {
+                        links?: components['schemas']['LinkCategoryId2'][];
+                        /**
+                         * Format: int64
+                         * @description Number of results in the list
+                         * @example 70
+                         */
+                        total?: number;
+                        values?: components['schemas']['FlagCategory2'][];
+                    };
                 };
             };
-            /** @description - No contributionDefinition link specified - No category link specified */
+            /** @description Forbidden - Given Invalid orgId or the user dosen't have access for the given flagCategory or orgId. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Entity Not found. No organization present for given orgId. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    createFlagCategory: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Organization Id where the Flag category belongs to */
+                orgId: components['parameters']['OrgId4'];
+            };
+            cookie?: never;
+        };
+        /** @description This resource will create a custom category in the given organization. */
+        requestBody?: {
+            content: {
+                'application/vnd.deere.axiom.v3+json': components['schemas']['PutResponse'];
+            };
+        };
+        responses: {
+            /** @description Created */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/vnd.deere.axiom.v3+json': {
+                        /**
+                         * Format: int32
+                         * @example 1
+                         */
+                        total?: number;
+                    };
+                };
+            };
+            /** @description Invalid body - Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Forbidden - Given Invalid orgId or the user doesn't have access for the given flagCategory or orgId. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Entity Not found. No organization present for given orgId or no contribution definition ID is found. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Conflict. User creates flag category with such title which is already being used in one of the existing category. */
+            409: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    getFlagCategoryByIdOrgId: {
+        parameters: {
+            query?: {
+                /** @description Embed additional attributes if required. */
+                embed?: components['parameters']['Embed_FlagCategories'];
+            };
+            header?: {
+                /** @description Language category names are being returned by the endpoint. */
+                'Accept-Language'?: components['parameters']['Accept-Language_FlagCategories'];
+            };
+            path: {
+                /** @description OrgId to query for Org. */
+                orgId: components['parameters']['OrgId_FlagCategories'];
+                /** @description CategoryId to query for Category. */
+                categoryId: components['parameters']['CategoryId'];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Returns flag category. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/vnd.deere.axiom.v3+json': {
+                        links?: unknown;
+                        values?: unknown;
+                    };
+                };
+            };
+            /** @description Forbidden - Given Invalid orgId or the user dosen't have access for the given flagCategory or orgId. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Entity Not found. No organization present for given orgId or given flag category does not exist */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    updateFlagCategoryByIdOrgId: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Organization Id. */
+                orgId: components['parameters']['OrgId2_FlagCategories'];
+                /** @description CategoryId to query for Category. */
+                categoryId: components['parameters']['CategoryId2'];
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                'application/vnd.deere.axiom.v3+json': components['schemas']['PutResponse'];
+            };
+        };
+        responses: {
+            /** @description No Content. Successfully updated. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/vnd.deere.axiom.v3+json': {
+                        /**
+                         * Format: int32
+                         * @example 1
+                         */
+                        total?: number;
+                    };
+                };
+            };
+            /** @description Invalid body - Bad Request */
             400: {
                 headers: {
                     [name: string]: unknown;
@@ -379,7 +827,7 @@ export interface operations {
                 };
                 content?: never;
             };
-            /** @description Entity Not found. Missing or incorrect flag id, or contributionDefinition is invalid Or incorrect org */
+            /** @description Entity Not found. Missing or incorrect categoryId in the org Or incorrect org */
             404: {
                 headers: {
                     [name: string]: unknown;
@@ -388,21 +836,21 @@ export interface operations {
             };
         };
     };
-    deleteFlagByIdOrgId: {
+    deleteFlagCategoryByIdOrgId: {
         parameters: {
             query?: never;
             header?: never;
             path: {
-                /** @description flagId to query for flag */
-                flagId: components['parameters']['FlagId'];
-                /** @description Org Id to query for Flag */
-                orgId: components['parameters']['OrgId'];
+                /** @description OrgId to query for Category */
+                orgId: components['parameters']['OrgId3_FlagCategories'];
+                /** @description CategoryId to query for Category. */
+                categoryId: components['parameters']['CategoryId2'];
             };
             cookie?: never;
         };
         requestBody?: never;
         responses: {
-            /** @description No Content. Flag deleted successfully. */
+            /** @description No Content. Flag Category deleted successfully. */
             200: {
                 headers: {
                     [name: string]: unknown;
@@ -417,14 +865,171 @@ export interface operations {
                     };
                 };
             };
-            /** @description Forbidden. - The user has no permission to delete the flag. */
+            /** @description Forbidden. - Given Invalid orgId or the user dosen't have access for the given flagCategory or orgId. - The user has no permission to delete the flag category. */
             403: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content?: never;
             };
-            /** @description Entity Not found. Given flag id does not exist or given orgId does not present. */
+            /** @description Entity Not found. Given category id does not exist or given orgId does not exist. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    getFlagCategoryPreferencesByIdOrgId: {
+        parameters: {
+            query?: {
+                /** @description CategoryId to query for preferences */
+                prefKey?: components['parameters']['PrefKey'];
+            };
+            header?: never;
+            path: {
+                /** @description orgId to query for preferences. */
+                organizationId: components['parameters']['OrganizationId'];
+                /** @description CategoryId to query for preferences. */
+                categoryId: components['parameters']['CategoryId_FlagCategoriesPreferences'];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Returns the preferences object for the given flag category. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/vnd.deere.axiom.v3+json': {
+                        links?: components['schemas']['GetPreferences'][];
+                        /**
+                         * Format: int64
+                         * @description Number of results in the list
+                         * @example 70
+                         */
+                        total?: number;
+                        values?: unknown;
+                    };
+                };
+            };
+            /** @description Forbidden - Given Invalid orgId or the user dosen't have access for the given flagCategory or orgId. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Entity Not found. No category with this id. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    getFlagCategoryPreferenceByIdOrgId: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description orgId to query for preferences. */
+                orgId: components['parameters']['OrgId_FlagCategoriesPreferences'];
+                /** @description flagCategoryPreferencesId to query for preferences. */
+                flagCategoryPreferencesId: components['parameters']['FlagCategoryPreferencesId'];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Returns the preferences object identified by its global ID. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/vnd.deere.axiom.v3+json': {
+                        links?: components['schemas']['GetPreferences'][];
+                        /**
+                         * Format: int64
+                         * @description Number of results in the list
+                         * @example 70
+                         */
+                        total?: number;
+                        values?: unknown;
+                    };
+                };
+            };
+            /** @description Forbidden - Given Invalid orgId or the user dosen't have access for the given flagCategory or orgId. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Entity Not found. No reference category with this id. */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    updateFlagCategoryPreferenceByIdOrgId: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description orgId to query for preferences. */
+                organizationId: components['parameters']['OrganizationId'];
+                /** @description flagCategoryPreferencesId to query for preferences. */
+                flagCategoryPreferencesId: components['parameters']['FlagCategoryPreferencesId2'];
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                'application/vnd.deere.axiom.v3+json': components['schemas']['FlagCategoryPreference'];
+            };
+        };
+        responses: {
+            /** @description No Content. Successfully updated. */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/vnd.deere.axiom.v3+json': {
+                        links?: components['schemas']['PutPreferences'][];
+                        /**
+                         * Format: int64
+                         * @description Number of results in the list
+                         * @example 70
+                         */
+                        total?: number;
+                    };
+                };
+            };
+            /** @description Invalid body - Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Forbidden - Given Invalid orgId or the user dosen't have access for the given flagCategory or orgId. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Entity Not found. Incorrect flagCategoryPreferencesId. */
             404: {
                 headers: {
                     [name: string]: unknown;
@@ -520,7 +1125,7 @@ export interface operations {
             };
         };
     };
-    getOrgFieldFlags: {
+    getFlagForOrganizationByFlagId: {
         parameters: {
             query?: {
                 /** @description Embed additional attributes if required to reduce the number of requests */
@@ -535,6 +1140,8 @@ export interface operations {
                 categoryNames?: components['parameters']['CategoryNames'];
                 /** @description Request flags by archived status */
                 recordFilter?: components['parameters']['RecordFilter'];
+                /** @description Specify whether to request global flags, field-related flags or both */
+                flagScopes?: components['parameters']['FlagScopes'];
                 /** @description Clients which cannot handle specific geometry types can select only supported ones. Request flags with geometry only of type */
                 shapeTypes?: components['parameters']['ShapeTypes'];
                 /** @description Populates simplified geometry */
@@ -547,24 +1154,119 @@ export interface operations {
                 'Accept-Language'?: components['parameters']['Accept-Language'];
             };
             path: {
-                /** @description Organization Id where the Flag belongs to */
-                orgId: components['parameters']['OrgId3'];
-                /** @description Fields guid of the field. */
-                fieldId: components['parameters']['FieldId'];
+                /** @description Org Id to query for Flag */
+                orgId: components['parameters']['OrgId'];
+                /** @description flagId to query for flag */
+                flagId: components['parameters']['FlagId'];
             };
             cookie?: never;
         };
         requestBody?: never;
         responses: {
-            200: components['responses']['GetOrgId'];
-            /** @description Forbidden. The user has no access to the given flag */
+            200: components['responses']['FlagIdGet'];
+            /** @description Access forbidden. The user does not have permission to access the given organization. */
             403: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content?: never;
             };
-            /** @description Entity Not found. No organization and/or field with these ids. */
+            /** @description Entity Not found. No organization present for given orgId or no flag id present in the given org id */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    updateFlagByIdOrgId: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description Organization Id */
+                orgId: components['parameters']['OrgId2'];
+                /** @description flagId to query for flag */
+                flagId: components['parameters']['FlagId'];
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                'application/vnd.deere.axiom.v3+json': components['schemas']['ValuesFlagIdPut'];
+            };
+        };
+        responses: {
+            /** @description Update response by Flag Id */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/vnd.deere.axiom.v3+json': unknown;
+                };
+            };
+            /** @description - No contributionDefinition link specified - No category link specified */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Forbidden Access */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Entity Not found. Missing or incorrect flag id, or contributionDefinition is invalid Or incorrect org */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    deleteFlagByIdOrgId: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description flagId to query for flag */
+                flagId: components['parameters']['FlagId'];
+                /** @description Org Id to query for Flag */
+                orgId: components['parameters']['OrgId'];
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description No Content. Flag deleted successfully. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    'application/vnd.deere.axiom.v3+json': {
+                        /**
+                         * Format: int32
+                         * @example 1
+                         */
+                        total?: number;
+                    };
+                };
+            };
+            /** @description Forbidden. - The user has no permission to delete the flag. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Entity Not found. Given flag id does not exist or given orgId does not present. */
             404: {
                 headers: {
                     [name: string]: unknown;