deere-sdk 0.1.0

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

@@ -0,0 +1,308 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export interface paths {
+    "/organizations": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List Orgs
+         * @description This request will return a list of organizations.
+         */
+        get: {
+            parameters: {
+                query?: {
+                    /** @description Returns a list of organizations of which a particular user is a member. */
+                    userName?: components["parameters"]["UserName"];
+                    /** @description Returns the name of the organization that corresponds with the given organization ID. */
+                    orgId?: components["parameters"]["OrgId"];
+                    /** @description Returns a list of organizations that contain the given string in their name. */
+                    orgName?: components["parameters"]["OrgName"];
+                };
+                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-signature"];
+                };
+                path?: never;
+                cookie?: never;
+            };
+            requestBody?: never;
+            responses: {
+                /** @description Organization List */
+                200: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/vnd.deere.axiom.v3+json": {
+                            links?: unknown;
+                            values?: unknown;
+                        };
+                    };
+                };
+                /** @description Not authorized */
+                403: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+                /** @description Not found */
+                404: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content?: never;
+                };
+            };
+        };
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/organizations/{orgId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * View an Organization
+         * @description This request will return information about an organization, such as its name, type, and whether or not you are a member of the organization. It contains links to the following resources:
+         */
+        get: {
+            parameters: {
+                query?: never;
+                header?: never;
+                path: {
+                    /** @description Organization */
+                    orgId: components["parameters"]["OrgIdGet"];
+                };
+                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}/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;
+    };
+}
+export type webhooks = Record<string, never>;
+export interface components {
+    schemas: {
+        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;
+        };
+        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;
+        };
+        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;
+        };
+    };
+    responses: never;
+    parameters: {
+        /** @description Returns a list of organizations of which a particular user is a member. */
+        UserName: string;
+        /** @description User Name. */
+        UserName2: string;
+        /** @description Returns the name of the organization that corresponds with the given organization ID. */
+        OrgId: string;
+        /** @description Returns a list of organizations that contain the given string in their name. */
+        OrgName: 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;
+        /** @description Organization */
+        OrgIdGet: string;
+    };
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+export type $defs = Record<string, never>;
+export type operations = Record<string, never>;
+//# sourceMappingURL=organizations.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"organizations.d.ts","sourceRoot":"","sources":["../../../src/types/generated/organizations.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,KAAK;IAClB,gBAAgB,EAAE;QACd,UAAU,EAAE;YACR,KAAK,CAAC,EAAE,KAAK,CAAC;YACd,MAAM,CAAC,EAAE,KAAK,CAAC;YACf,IAAI,CAAC,EAAE,KAAK,CAAC;YACb,MAAM,CAAC,EAAE,KAAK,CAAC;SAClB,CAAC;QACF;;;WAGG;QACH,GAAG,EAAE;YACD,UAAU,EAAE;gBACR,KAAK,CAAC,EAAE;oBACJ,2FAA2F;oBAC3F,QAAQ,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC,UAAU,CAAC,CAAC;oBAChD,yGAAyG;oBACzG,KAAK,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC;oBAC1C,gGAAgG;oBAChG,OAAO,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC,SAAS,CAAC,CAAC;iBACjD,CAAC;gBACF,MAAM,CAAC,EAAE;oBACL,8ZAA8Z;oBAC9Z,mBAAmB,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC,mBAAmB,CAAC,CAAC;iBACvE,CAAC;gBACF,IAAI,CAAC,EAAE,KAAK,CAAC;gBACb,MAAM,CAAC,EAAE,KAAK,CAAC;aAClB,CAAC;YACF,WAAW,CAAC,EAAE,KAAK,CAAC;YACpB,SAAS,EAAE;gBACP,qCAAqC;gBACrC,GAAG,EAAE;oBACD,OAAO,EAAE;wBACL,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;qBAC3B,CAAC;oBACF,OAAO,EAAE;wBACL,qCAAqC,EAAE;4BACnC,KAAK,CAAC,EAAE,OAAO,CAAC;4BAChB,MAAM,CAAC,EAAE,OAAO,CAAC;yBACpB,CAAC;qBACL,CAAC;iBACL,CAAC;gBACF,kCAAkC;gBAClC,GAAG,EAAE;oBACD,OAAO,EAAE;wBACL,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;qBAC3B,CAAC;oBACF,OAAO,CAAC,EAAE,KAAK,CAAC;iBACnB,CAAC;gBACF,6BAA6B;gBAC7B,GAAG,EAAE;oBACD,OAAO,EAAE;wBACL,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;qBAC3B,CAAC;oBACF,OAAO,CAAC,EAAE,KAAK,CAAC;iBACnB,CAAC;aACL,CAAC;SACL,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;KACjB,CAAC;IACF,wBAAwB,EAAE;QACtB,UAAU,EAAE;YACR,KAAK,CAAC,EAAE,KAAK,CAAC;YACd,MAAM,CAAC,EAAE,KAAK,CAAC;YACf,IAAI,CAAC,EAAE,KAAK,CAAC;YACb,MAAM,CAAC,EAAE,KAAK,CAAC;SAClB,CAAC;QACF;;;WAGG;QACH,GAAG,EAAE;YACD,UAAU,EAAE;gBACR,KAAK,CAAC,EAAE,KAAK,CAAC;gBACd,MAAM,CAAC,EAAE,KAAK,CAAC;gBACf,IAAI,EAAE;oBACF,gCAAgC;oBAChC,KAAK,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC,UAAU,CAAC,CAAC;iBAC/C,CAAC;gBACF,MAAM,CAAC,EAAE,KAAK,CAAC;aAClB,CAAC;YACF,WAAW,CAAC,EAAE,KAAK,CAAC;YACpB,SAAS,EAAE;gBACP,0CAA0C;gBAC1C,GAAG,EAAE;oBACD,OAAO,EAAE;wBACL,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;qBAC3B,CAAC;oBACF,OAAO,EAAE;wBACL,qCAAqC,EAAE;4BACnC,KAAK,CAAC,EAAE,OAAO,CAAC;4BAChB,MAAM,CAAC,EAAE,OAAO,CAAC;yBACpB,CAAC;qBACL,CAAC;iBACL,CAAC;aACL,CAAC;SACL,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;KACjB,CAAC;IACF,iCAAiC,EAAE;QAC/B,UAAU,EAAE;YACR,KAAK,CAAC,EAAE,KAAK,CAAC;YACd,MAAM,CAAC,EAAE,KAAK,CAAC;YACf,IAAI,CAAC,EAAE,KAAK,CAAC;YACb,MAAM,CAAC,EAAE,KAAK,CAAC;SAClB,CAAC;QACF;;;WAGG;QACH,GAAG,EAAE;YACD,UAAU,EAAE;gBACR,KAAK,CAAC,EAAE,KAAK,CAAC;gBACd,MAAM,CAAC,EAAE;oBACL,8ZAA8Z;oBAC9Z,mBAAmB,CAAC,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC,oBAAoB,CAAC,CAAC;iBACxE,CAAC;gBACF,IAAI,EAAE;oBACF,8BAA8B;oBAC9B,QAAQ,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC,WAAW,CAAC,CAAC;iBACnD,CAAC;gBACF,MAAM,CAAC,EAAE,KAAK,CAAC;aAClB,CAAC;YACF,WAAW,CAAC,EAAE,KAAK,CAAC;YACpB,SAAS,EAAE;gBACP,0CAA0C;gBAC1C,GAAG,EAAE;oBACD,OAAO,EAAE;wBACL,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;qBAC3B,CAAC;oBACF,OAAO,EAAE;wBACL,qCAAqC,EAAE;4BACnC,KAAK,CAAC,EAAE,OAAO,CAAC;4BAChB,MAAM,CAAC,EAAE,OAAO,CAAC;yBACpB,CAAC;qBACL,CAAC;iBACL,CAAC;aACL,CAAC;SACL,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;KACjB,CAAC;CACL;AACD,MAAM,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAC7C,MAAM,WAAW,UAAU;IACvB,OAAO,EAAE;QACL,gBAAgB,EAAE;YACd;;;eAGG;YACH,IAAI,CAAC,EAAE,OAAO,CAAC;YACf;;;eAGG;YACH,WAAW,CAAC,EAAE,OAAO,CAAC;YACtB;;;eAGG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;SAChC,CAAC;QACF,iBAAiB,EAAE;YACf;;;eAGG;YACH,IAAI,CAAC,EAAE,OAAO,CAAC;YACf;;;eAGG;YACH,WAAW,CAAC,EAAE,OAAO,CAAC;YACtB;;;eAGG;YACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;SAChC,CAAC;QACF,YAAY,EAAE;YACV;;;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;SACpB,CAAC;QACF,gBAAgB,EAAE;YACd;;;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;SACpB,CAAC;QACF,mBAAmB,EAAE;YACjB;;;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;SACpB,CAAC;KACL,CAAC;IACF,SAAS,EAAE,KAAK,CAAC;IACjB,UAAU,EAAE;QACR,2FAA2F;QAC3F,QAAQ,EAAE,MAAM,CAAC;QACjB,8BAA8B;QAC9B,SAAS,EAAE,MAAM,CAAC;QAClB,yGAAyG;QACzG,KAAK,EAAE,MAAM,CAAC;QACd,gGAAgG;QAChG,OAAO,EAAE,MAAM,CAAC;QAChB,8ZAA8Z;QAC9Z,mBAAmB,EAAE,MAAM,CAAC;QAC5B,8ZAA8Z;QAC9Z,oBAAoB,EAAE,MAAM,CAAC;QAC7B,gCAAgC;QAChC,QAAQ,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,aAAa,EAAE,KAAK,CAAC;IACrB,OAAO,EAAE,KAAK,CAAC;IACf,SAAS,EAAE,KAAK,CAAC;CACpB;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/dist/types/generated/organizations.js

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+export {};
+//# sourceMappingURL=organizations.js.map

package/dist/types/generated/organizations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"organizations.js","sourceRoot":"","sources":["../../../src/types/generated/organizations.ts"],"names":[],"mappings":"AAAA;;;GAGG"}