deere-sdk 3.0.5 → 3.1.1

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

@@ -3,6 +3,102 @@
  * Do not make direct changes to the file.
  */
 export interface paths {
+    '/users/@currentUser': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * View User Info Using Literal Value
+         * @description This endpoint returns information about the user, such as first and last name, the account name, etc. This call can be used by a logged-in user to view their own information. The response also contains links to the following resources: organizations: View a list of organizations to which the user belongs. files: View a list of files belonging to the user.
+         */
+        get: {
+            parameters: {
+                query?: {
+                    /** @description Add user's staff organizations and available links to response. */
+                    embed?: string;
+                };
+                header?: never;
+                path: {
+                    /** @description Use literal value "@currentUser" to retrieve the currently authenticated user information. */
+                    '@currentUser': string;
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description The users. */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        'application/vnd.deere.axiom.v3+json': {
+                            links?: unknown;
+                            values?: unknown;
+                        };
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    '/users/{userName}/organizations': {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * View User Orgs
+         * @description This request will return a list of organizations. The response will ONLY contain organizations in which the user is a staff member (member=true). This response will NOT contain partner organizations in which the user is not a staff member (member=false).
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: {
+                    /** @description x-deere-signature should be managed by the client per user per API. For a new user/new API, the first request will have a blank value for x-deere-signature. Changes can be tracked with the x-deere-signature returned in the response. If the response has not changed since the last API call, the value of x-deere-signature is not changed and the client should use the same String Token next time. */
+                    'x-deere-signature'?: components['parameters']['X-deere-signature2'];
+                };
+                path: {
+                    /** @description User Name. */
+                    userName: components['parameters']['UserName2'];
+                };
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description View Organization List */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        'application/vnd.deere.axiom.v3+json': {
+                            links?: unknown;
+                            values?: unknown;
+                        };
+                    };
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     '/users/{username}': {
         parameters: {
             query?: never;
@@ -55,6 +151,121 @@ export interface paths {
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
+        Organization: {
+            /**
+             * @description A new x-deere-signature response header will be included if the response has changed since last api call.
+             * @example 3b5392015e4b4e1c92013026f47109bb
+             */
+            'x-deere-signature'?: string;
+            /**
+             * @description The organization ID.
+             * @example 1234
+             */
+            id?: string;
+            /**
+             * @description The organization name.
+             * @example Smith Farms
+             */
+            name?: string;
+            /**
+             * @description The organization type: customer or dealer.
+             * @example customer
+             */
+            type?: string;
+            /**
+             * @description TRUE means that the user is a member of the org.
+             * @example true
+             */
+            member?: boolean;
+        };
+        OrganizationLink: {
+            /**
+             * @description Link to organization
+             * @example https://sandboxapi.deere.com/platform/organizations/1234
+             */
+            self?: unknown;
+            /**
+             * @description Redirect link to enable organization access
+             * @example https://connections.deere.com/connections/28efb3cb-cbd5-4888-8570-99465ea8860e/select-organizations
+             */
+            connections?: unknown;
+            /**
+             * @description Redirect link to manage organization access and permissions
+             * @example https://connections.deere.com/connections/28efb3cb-cbd5-4888-8570-99465ea8860e/connections-dialog?orgId=1234
+             */
+            manage_connections?: unknown;
+        };
+        OrganizationLink2: {
+            /**
+             * @description Link to organization
+             * @example https://sandboxapi.deere.com/platform/organizations/1234
+             */
+            self?: unknown;
+            /**
+             * @description Redirect link to enable organization access
+             * @example https://connections.deere.com/connections/28efb3cb-cbd5-4888-8570-99465ea8860e/organizations
+             */
+            connections?: unknown;
+            /**
+             * @description Redirect link to manage organization access and permissions
+             * @example https://connections.deere.com/connections/28efb3cb-cbd5-4888-8570-99465ea8860e/connections-dialog?orgId=1234
+             */
+            manage_connections?: unknown;
+        };
+        OrganizationView: {
+            /**
+             * @description The organization ID.
+             * @example 1234
+             */
+            id?: string;
+            /**
+             * @description The organization name.
+             * @example Smith Farms
+             */
+            name?: string;
+            /**
+             * @description The organization type: customer or dealer.
+             * @example customer
+             */
+            type?: string;
+            /**
+             * @description TRUE means that the user is a member of the org.
+             * @example true
+             */
+            member?: boolean;
+        };
+        OrganizationViewGet: {
+            /**
+             * @description A new x-deere-signature response header will be included if the response has changed since last api call.
+             * @example 3b5392015e4b4e1c92013026f47109bb
+             */
+            'x-deere-signature'?: string;
+            /**
+             * @description Organization ID.
+             * @example 1234
+             */
+            id?: string;
+            /**
+             * @description Organization name.
+             * @example Smith Farms
+             */
+            name?: string;
+            /**
+             * @description Organization type.
+             * @example customer
+             */
+            type?: string;
+            /**
+             * @description Partners of this organization.
+             * @example Apple Farms
+             */
+            partnerships?: string;
+            /**
+             * @description Indicates whether the user is a member of the organization.
+             * @example true
+             */
+            member?: boolean;
+        };
         UsersLink: {
             /**
              * @description Organizations Link.
@@ -86,7 +297,22 @@ export interface components {
         };
     };
     responses: never;
-    parameters: never;
+    parameters: {
+        /** @description Returns the name of the organization that corresponds with the given organization ID. */
+        OrgId: string;
+        /** @description Organization */
+        OrgIdGet: string;
+        /** @description Returns a list of organizations that contain the given string in their name. */
+        OrgName: string;
+        /** @description Returns a list of organizations of which a particular user is a member. */
+        UserName: string;
+        /** @description User Name. */
+        UserName2: string;
+        /** @description x-deere-signature should be managed by the client per user per API. For a new user/new API, the first request will have a blank value for x-deere-signature. Changes can be tracked with the x-deere-signature returned in the response. If the response has not changed since the last API call, the value of x-deere-signature is not changed and the client should use the same String Token next time. */
+        'X-deere-signature': string;
+        /** @description x-deere-signature should be managed by the client per user per API. For a new user/new API, the first request will have a blank value for x-deere-signature. Changes can be tracked with the x-deere-signature returned in the response. If the response has not changed since the last API call, the value of x-deere-signature is not changed and the client should use the same String Token next time. */
+        'X-deere-signature2': string;
+    };
     requestBodies: never;
     headers: never;
     pathItems: never;

package/dist/types/generated/users.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../../src/types/generated/users.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,KAAK;IACpB,mBAAmB,EAAE;QACnB,UAAU,EAAE;YACV,KAAK,CAAC,EAAE,KAAK,CAAC;YACd,MAAM,CAAC,EAAE,KAAK,CAAC;YACf,IAAI,CAAC,EAAE,KAAK,CAAC;YACb,MAAM,CAAC,EAAE,KAAK,CAAC;SAChB,CAAC;QACF;;;WAGG;QACH,GAAG,EAAE;YACH,UAAU,EAAE;gBACV,KAAK,CAAC,EAAE;oBACN,mFAAmF;oBACnF,KAAK,CAAC,EAAE,MAAM,CAAC;iBAChB,CAAC;gBACF,MAAM,CAAC,EAAE,KAAK,CAAC;gBACf,IAAI,EAAE;oBACJ,uCAAuC;oBACvC,QAAQ,EAAE,MAAM,CAAC;iBAClB,CAAC;gBACF,MAAM,CAAC,EAAE,KAAK,CAAC;aAChB,CAAC;YACF,WAAW,CAAC,EAAE,KAAK,CAAC;YACpB,SAAS,EAAE;gBACT,8BAA8B;gBAC9B,GAAG,EAAE;oBACH,OAAO,EAAE;wBACP,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;qBACzB,CAAC;oBACF,OAAO,EAAE;wBACP,qCAAqC,EAAE;4BACrC,KAAK,CAAC,EAAE,OAAO,CAAC;4BAChB,MAAM,CAAC,EAAE,OAAO,CAAC;yBAClB,CAAC;qBACH,CAAC;iBACH,CAAC;aACH,CAAC;SACH,CAAC;QACF,GAAG,CAAC,EAAE,KAAK,CAAC;QACZ,IAAI,CAAC,EAAE,KAAK,CAAC;QACb,MAAM,CAAC,EAAE,KAAK,CAAC;QACf,OAAO,CAAC,EAAE,KAAK,CAAC;QAChB,IAAI,CAAC,EAAE,KAAK,CAAC;QACb,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,KAAK,CAAC,EAAE,KAAK,CAAC;KACf,CAAC;CACH;AACD,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAC7C,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE;QACP,SAAS,EAAE;YACT;;;eAGG;YACH,aAAa,CAAC,EAAE,OAAO,CAAC;SACzB,CAAC;QACF,UAAU,EAAE;YACV;;;eAGG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB;;;eAGG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB;;;eAGG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YACpB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB,CAAC;KACH,CAAC;IACF,SAAS,EAAE,KAAK,CAAC;IACjB,UAAU,EAAE,KAAK,CAAC;IAClB,aAAa,EAAE,KAAK,CAAC;IACrB,OAAO,EAAE,KAAK,CAAC;IACf,SAAS,EAAE,KAAK,CAAC;CAClB;AACD,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAC1C,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC"}
+{"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../../src/types/generated/users.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,KAAK;IACpB,qBAAqB,EAAE;QACrB,UAAU,EAAE;YACV,KAAK,CAAC,EAAE,KAAK,CAAC;YACd,MAAM,CAAC,EAAE,KAAK,CAAC;YACf,IAAI,CAAC,EAAE,KAAK,CAAC;YACb,MAAM,CAAC,EAAE,KAAK,CAAC;SAChB,CAAC;QACF;;;WAGG;QACH,GAAG,EAAE;YACH,UAAU,EAAE;gBACV,KAAK,CAAC,EAAE;oBACN,mFAAmF;oBACnF,KAAK,CAAC,EAAE,MAAM,CAAC;iBAChB,CAAC;gBACF,MAAM,CAAC,EAAE,KAAK,CAAC;gBACf,IAAI,EAAE;oBACJ,8GAA8G;oBAC9G,cAAc,EAAE,MAAM,CAAC;iBACxB,CAAC;gBACF,MAAM,CAAC,EAAE,KAAK,CAAC;aAChB,CAAC;YACF,WAAW,CAAC,EAAE,KAAK,CAAC;YACpB,SAAS,EAAE;gBACT,8BAA8B;gBAC9B,GAAG,EAAE;oBACH,OAAO,EAAE;wBACP,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;qBACzB,CAAC;oBACF,OAAO,EAAE;wBACP,qCAAqC,EAAE;4BACrC,KAAK,CAAC,EAAE,OAAO,CAAC;4BAChB,MAAM,CAAC,EAAE,OAAO,CAAC;yBAClB,CAAC;qBACH,CAAC;iBACH,CAAC;aACH,CAAC;SACH,CAAC;QACF,GAAG,CAAC,EAAE,KAAK,CAAC;QACZ,IAAI,CAAC,EAAE,KAAK,CAAC;QACb,MAAM,CAAC,EAAE,KAAK,CAAC;QACf,OAAO,CAAC,EAAE,KAAK,CAAC;QAChB,IAAI,CAAC,EAAE,KAAK,CAAC;QACb,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,KAAK,CAAC,EAAE,KAAK,CAAC;KACf,CAAC;IACF,iCAAiC,EAAE;QACjC,UAAU,EAAE;YACV,KAAK,CAAC,EAAE,KAAK,CAAC;YACd,MAAM,CAAC,EAAE,KAAK,CAAC;YACf,IAAI,CAAC,EAAE,KAAK,CAAC;YACb,MAAM,CAAC,EAAE,KAAK,CAAC;SAChB,CAAC;QACF;;;WAGG;QACH,GAAG,EAAE;YACH,UAAU,EAAE;gBACV,KAAK,CAAC,EAAE,KAAK,CAAC;gBACd,MAAM,CAAC,EAAE;oBACP,8ZAA8Z;oBAC9Z,mBAAmB,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC,oBAAoB,CAAC,CAAC;iBACtE,CAAC;gBACF,IAAI,EAAE;oBACJ,8BAA8B;oBAC9B,QAAQ,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC,WAAW,CAAC,CAAC;iBACjD,CAAC;gBACF,MAAM,CAAC,EAAE,KAAK,CAAC;aAChB,CAAC;YACF,WAAW,CAAC,EAAE,KAAK,CAAC;YACpB,SAAS,EAAE;gBACT,0CAA0C;gBAC1C,GAAG,EAAE;oBACH,OAAO,EAAE;wBACP,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;qBACzB,CAAC;oBACF,OAAO,EAAE;wBACP,qCAAqC,EAAE;4BACrC,KAAK,CAAC,EAAE,OAAO,CAAC;4BAChB,MAAM,CAAC,EAAE,OAAO,CAAC;yBAClB,CAAC;qBACH,CAAC;iBACH,CAAC;aACH,CAAC;SACH,CAAC;QACF,GAAG,CAAC,EAAE,KAAK,CAAC;QACZ,IAAI,CAAC,EAAE,KAAK,CAAC;QACb,MAAM,CAAC,EAAE,KAAK,CAAC;QACf,OAAO,CAAC,EAAE,KAAK,CAAC;QAChB,IAAI,CAAC,EAAE,KAAK,CAAC;QACb,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,KAAK,CAAC,EAAE,KAAK,CAAC;KACf,CAAC;IACF,mBAAmB,EAAE;QACnB,UAAU,EAAE;YACV,KAAK,CAAC,EAAE,KAAK,CAAC;YACd,MAAM,CAAC,EAAE,KAAK,CAAC;YACf,IAAI,CAAC,EAAE,KAAK,CAAC;YACb,MAAM,CAAC,EAAE,KAAK,CAAC;SAChB,CAAC;QACF;;;WAGG;QACH,GAAG,EAAE;YACH,UAAU,EAAE;gBACV,KAAK,CAAC,EAAE;oBACN,mFAAmF;oBACnF,KAAK,CAAC,EAAE,MAAM,CAAC;iBAChB,CAAC;gBACF,MAAM,CAAC,EAAE,KAAK,CAAC;gBACf,IAAI,EAAE;oBACJ,uCAAuC;oBACvC,QAAQ,EAAE,MAAM,CAAC;iBAClB,CAAC;gBACF,MAAM,CAAC,EAAE,KAAK,CAAC;aAChB,CAAC;YACF,WAAW,CAAC,EAAE,KAAK,CAAC;YACpB,SAAS,EAAE;gBACT,8BAA8B;gBAC9B,GAAG,EAAE;oBACH,OAAO,EAAE;wBACP,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;qBACzB,CAAC;oBACF,OAAO,EAAE;wBACP,qCAAqC,EAAE;4BACrC,KAAK,CAAC,EAAE,OAAO,CAAC;4BAChB,MAAM,CAAC,EAAE,OAAO,CAAC;yBAClB,CAAC;qBACH,CAAC;iBACH,CAAC;aACH,CAAC;SACH,CAAC;QACF,GAAG,CAAC,EAAE,KAAK,CAAC;QACZ,IAAI,CAAC,EAAE,KAAK,CAAC;QACb,MAAM,CAAC,EAAE,KAAK,CAAC;QACf,OAAO,CAAC,EAAE,KAAK,CAAC;QAChB,IAAI,CAAC,EAAE,KAAK,CAAC;QACb,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,KAAK,CAAC,EAAE,KAAK,CAAC;KACf,CAAC;CACH;AACD,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAC7C,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE;QACP,YAAY,EAAE;YACZ;;;eAGG;YACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAC7B;;;eAGG;YACH,EAAE,CAAC,EAAE,MAAM,CAAC;YACZ;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YACd;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YACd;;;eAGG;YACH,MAAM,CAAC,EAAE,OAAO,CAAC;SAClB,CAAC;QACF,gBAAgB,EAAE;YAChB;;;eAGG;YACH,IAAI,CAAC,EAAE,OAAO,CAAC;YACf;;;eAGG;YACH,WAAW,CAAC,EAAE,OAAO,CAAC;YACtB;;;eAGG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;SAC9B,CAAC;QACF,iBAAiB,EAAE;YACjB;;;eAGG;YACH,IAAI,CAAC,EAAE,OAAO,CAAC;YACf;;;eAGG;YACH,WAAW,CAAC,EAAE,OAAO,CAAC;YACtB;;;eAGG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;SAC9B,CAAC;QACF,gBAAgB,EAAE;YAChB;;;eAGG;YACH,EAAE,CAAC,EAAE,MAAM,CAAC;YACZ;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YACd;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YACd;;;eAGG;YACH,MAAM,CAAC,EAAE,OAAO,CAAC;SAClB,CAAC;QACF,mBAAmB,EAAE;YACnB;;;eAGG;YACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;YAC7B;;;eAGG;YACH,EAAE,CAAC,EAAE,MAAM,CAAC;YACZ;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YACd;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YACd;;;eAGG;YACH,YAAY,CAAC,EAAE,MAAM,CAAC;YACtB;;;eAGG;YACH,MAAM,CAAC,EAAE,OAAO,CAAC;SAClB,CAAC;QACF,SAAS,EAAE;YACT;;;eAGG;YACH,aAAa,CAAC,EAAE,OAAO,CAAC;SACzB,CAAC;QACF,UAAU,EAAE;YACV;;;eAGG;YACH,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB;;;eAGG;YACH,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB;;;eAGG;YACH,UAAU,CAAC,EAAE,MAAM,CAAC;YACpB;;;eAGG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB,CAAC;KACH,CAAC;IACF,SAAS,EAAE,KAAK,CAAC;IACjB,UAAU,EAAE;QACV,yGAAyG;QACzG,KAAK,EAAE,MAAM,CAAC;QACd,gCAAgC;QAChC,QAAQ,EAAE,MAAM,CAAC;QACjB,gGAAgG;QAChG,OAAO,EAAE,MAAM,CAAC;QAChB,2FAA2F;QAC3F,QAAQ,EAAE,MAAM,CAAC;QACjB,8BAA8B;QAC9B,SAAS,EAAE,MAAM,CAAC;QAClB,8ZAA8Z;QAC9Z,mBAAmB,EAAE,MAAM,CAAC;QAC5B,8ZAA8Z;QAC9Z,oBAAoB,EAAE,MAAM,CAAC;KAC9B,CAAC;IACF,aAAa,EAAE,KAAK,CAAC;IACrB,OAAO,EAAE,KAAK,CAAC;IACf,SAAS,EAAE,KAAK,CAAC;CAClB;AACD,MAAM,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAC1C,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "deere-sdk",
-  "version": "3.0.5",
+  "version": "3.1.1",
   "description": "Unofficial TypeScript SDK for John Deere Operations Center API",
   "author": "ProductOfAmerica",
   "license": "MIT",
@@ -77,15 +77,8 @@
     "openapi-typescript": "^7.0.0",
     "rimraf": "^5.0.0",
     "tsx": "^4.7.0",
-    "typescript": "^6.0.2",
+    "typescript": "^6.0.3",
     "yaml": "^2.3.0"
   },
-  "pnpm": {
-    "overrides": {
-      "brace-expansion": "5.0.6",
-      "js-yaml": "^4.2.0",
-      "minimatch": "^10.2.3"
-    }
-  },
   "sideEffects": false
 }