@openfn/language-msupply 1.0.0

package/types/Adaptor.d.ts

@@ -0,0 +1,150 @@
+/**
+ * State object
+ * @typedef {Object} HttpState
+ * @property data - the parsed response body
+ * @property response - the response from the HTTP server, including headers, statusCode, body, etc
+ * @property references - an array of all previous data objects used in the Job
+ **/
+/**
+ * @typedef {Object} RequestBody
+ * @property {string} query - The GraphQL query string
+ * @property {object} variables - The variables for that query string
+ */
+/**
+ * @typedef {Object} GetItemsVariables
+ * @property {string} key - The unique key of each item in the list
+ * @property {string} storeId - The msupply store id  the list is being fetched from
+ */
+/**
+ * @typedef {Object} InsertOutboundShipmentvariables
+ * @property {string} otherPartyId - The recieving party id
+ * @property {string} storeId - The id of the store the shipment is being made from
+ */
+/**
+ * @typedef {Object} UpsertOutboundShipmentvariables
+ * @property {Object} input - The payload for the target shipment
+ * @property {string} storeId - The id of the store the shipment is being made from
+ */
+/**
+ * Get the list of items in the catalogue
+ * @public
+ * @function
+ * @example <caption>Get items in the catalogue</caption>
+ * getItemsWithStats({
+       "key": "name",
+       "storeId": "DFE0F611AD84A0419D36F8FEFAD1894C",
+})
+ * @param {GetItemsVariables} variables - GraphQL query variables
+ * @returns {Operation}
+ * @state {HttpState}
+ */
+export function getItemsWithStats(variables: GetItemsVariables): Operation;
+/**
+ * Create an outbound shipment.
+ * @public
+ * @function
+ * @example <caption>Create an outbound shipment</caption>
+ * insertOutboundShipment({
+       "otherPartyId": "861102F624354F15ABEB48DC207A4C2D",
+       "storeId": "DFE0F611AD84A0419D36F8FEFAD1894C"
+})
+ * @param {InsertOutboundShipmentvariables} variables - GraphQL query variables
+ * @returns {Operation}
+ * @state {HttpState}
+ */
+export function insertOutboundShipment(variables: InsertOutboundShipmentvariables): Operation;
+/**
+ * Update an outbound shipment
+ * @public
+ * @function
+ * @example <caption>Update outbound shipment status to 'PICKED'</caption>
+ * upsertOutboundShipment({
+ *      "storeId": "DFE0F611AD84A0419D36F8FEFAD1894C",
+ *      "input": {
+ *        "updateOutboundShipments": [
+ *          {
+ *            "id": "01961fce-9ef6-7198-93c1-866395094e48",
+ *            "status": "PICKED"
+ *           }
+ *         ]
+ *      }
+ * })
+ * @param {UpsertOutboundShipmentvariables} variables - GraphQL query variables
+ * @returns {Operation}
+ * @state {HttpState}
+ */
+export function upsertOutboundShipment(variables: UpsertOutboundShipmentvariables): Operation;
+/**
+ * Make a generic GraphQL request
+ * @public
+ * @function
+ * @example
+ * query(`
+  query isCentralServer {
+    isCentralServer
+  }`
+)
+ *@param {string} query - GraphQl query string
+ *@param {Object} variables - GraphQl query variables
+ * @returns {Operation}
+ * @state {HttpState}
+ */
+export function query(query: string, variables?: any): Operation;
+/**
+ * State object
+ */
+export type HttpState = {
+    /**
+     * - the parsed response body
+     */
+    data: any;
+    /**
+     * - the response from the HTTP server, including headers, statusCode, body, etc
+     */
+    response: any;
+    /**
+     * - an array of all previous data objects used in the Job
+     */
+    references: any;
+};
+export type RequestBody = {
+    /**
+     * - The GraphQL query string
+     */
+    query: string;
+    /**
+     * - The variables for that query string
+     */
+    variables: object;
+};
+export type GetItemsVariables = {
+    /**
+     * - The unique key of each item in the list
+     */
+    key: string;
+    /**
+     * - The msupply store id  the list is being fetched from
+     */
+    storeId: string;
+};
+export type InsertOutboundShipmentvariables = {
+    /**
+     * - The recieving party id
+     */
+    otherPartyId: string;
+    /**
+     * - The id of the store the shipment is being made from
+     */
+    storeId: string;
+};
+export type UpsertOutboundShipmentvariables = {
+    /**
+     * - The payload for the target shipment
+     */
+    input: any;
+    /**
+     * - The id of the store the shipment is being made from
+     */
+    storeId: string;
+};
+export { combine, cursor, dataPath, dataValue, dateFns, each, field, fields, fn, fnIf, group, lastReferenceValue, merge, scrubEmojis, sourceValue, util } from "@openfn/language-common";

package/types/Utils.d.ts

@@ -0,0 +1,3 @@
+export function prepareNextState(state: any, response: any): any;
+export function login(state: any): Promise<any>;
+export function request(state: any, options: any): Promise<any>;

package/types/index.d.ts

@@ -0,0 +1,3 @@
+export default Adaptor;
+export * from "./Adaptor";
+import * as Adaptor from "./Adaptor";

package/types/queries.d.ts

@@ -0,0 +1,3 @@
+export const getItemsQueryString: "\n          query itemsWithStats($storeId: String!, $key: ItemSortFieldInput!, $isDesc: Boolean, $filter: ItemFilterInput, $first: Int, $offset: Int) {\n            items(storeId: $storeId, sort: {key: $key, desc: $isDesc}, filter: $filter, page: {first: $first, offset: $offset}) {\n              ... on ItemConnector {\n                __typename\n                nodes {\n                  code\n                  id\n                  name\n                  unitName\n                  defaultPackSize\n                  availableStockOnHand(storeId: $storeId)\n                  stats(storeId: $storeId) {\n                    averageMonthlyConsumption\n                    availableStockOnHand\n                    availableMonthsOfStockOnHand\n                    monthsOfStockOnHand\n                    totalConsumption\n                    stockOnHand\n                  }\n                }\n                totalCount\n              }\n            }\n          }";
+export const insertOutboundShipmentQuery: "mutation insertOutboundShipment($id: String!, $otherPartyId: String!, $storeId: String!) {\n  insertOutboundShipment(\n    storeId: $storeId\n    input: {id: $id, otherPartyId: $otherPartyId}\n  ) {\n    __typename\n    ... on InvoiceNode {\n      id\n      invoiceNumber\n    }\n    ... on InsertOutboundShipmentError {\n      __typename\n      error {\n        description\n        ... on OtherPartyNotACustomer {\n          __typename\n          description\n        }\n        ... on OtherPartyNotVisible {\n          __typename\n          description\n        }\n        description\n      }\n    }\n    ... on NodeError {\n      __typename\n      error {\n        description\n        ... on DatabaseError {\n          __typename\n          description\n          fullError\n        }\n        ... on RecordNotFound {\n          __typename\n          description\n        }\n      }\n    }\n  }\n}";
+export const upsertOutboundShipmentQuery: "mutation upsertOutboundShipment($storeId: String!, $input: BatchOutboundShipmentInput!) {\n  batchOutboundShipment(storeId: $storeId, input: $input) {\n    __typename\n    insertOutboundShipmentUnallocatedLines {\n      id\n      response {\n        ... on InsertOutboundShipmentUnallocatedLineError {\n          __typename\n          error {\n            description\n          }\n        }\n        ... on InvoiceLineNode {\n          id\n        }\n      }\n    }\n    deleteOutboundShipmentLines {\n      id\n      response {\n        ... on DeleteOutboundShipmentLineError {\n          __typename\n          error {\n            description\n            ... on RecordNotFound {\n              __typename\n              description\n            }\n            ... on CannotEditInvoice {\n              __typename\n              description\n            }\n            ... on ForeignKeyError {\n              __typename\n              description\n              key\n            }\n          }\n        }\n        ... on DeleteResponse {\n          id\n        }\n      }\n    }\n    deleteOutboundShipmentServiceLines {\n      id\n      response {\n        ... on DeleteResponse {\n          id\n        }\n        ... on DeleteOutboundShipmentServiceLineError {\n          __typename\n          error {\n            description\n            ... on RecordNotFound {\n              __typename\n              description\n            }\n            ... on CannotEditInvoice {\n              __typename\n              description\n            }\n            ... on ForeignKeyError {\n              __typename\n              description\n              key\n            }\n          }\n        }\n      }\n    }\n    deleteOutboundShipmentUnallocatedLines {\n      id\n      response {\n        ... on DeleteResponse {\n          id\n        }\n        ... on DeleteOutboundShipmentUnallocatedLineError {\n          __typename\n          error {\n            description\n            ... on RecordNotFound {\n              __typename\n              description\n            }\n          }\n        }\n      }\n    }\n    deleteOutboundShipments {\n      id\n      response {\n        ... on DeleteResponse {\n          id\n        }\n        ... on DeleteOutboundShipmentError {\n          __typename\n          error {\n            description\n            ... on RecordNotFound {\n              __typename\n              description\n            }\n            ... on CannotDeleteInvoiceWithLines {\n              __typename\n              description\n            }\n            ... on CannotEditInvoice {\n              __typename\n              description\n            }\n          }\n        }\n      }\n    }\n    insertOutboundShipmentLines {\n      id\n      response {\n        ... on InsertOutboundShipmentLineError {\n          __typename\n          error {\n            description\n          }\n        }\n      }\n    }\n    insertOutboundShipmentServiceLines {\n      id\n      response {\n        ... on InsertOutboundShipmentServiceLineError {\n          __typename\n          error {\n            description\n          }\n        }\n      }\n    }\n    insertOutboundShipments {\n      id\n      response {\n        ... on InsertOutboundShipmentError {\n          __typename\n          error {\n            description\n          }\n        }\n        ... on NodeError {\n          __typename\n          error {\n            description\n            ... on RecordNotFound {\n              __typename\n              description\n            }\n            ... on DatabaseError {\n              __typename\n              description\n              fullError\n            }\n          }\n        }\n      }\n    }\n    updateOutboundShipmentLines {\n      id\n      response {\n        ... on UpdateOutboundShipmentLineError {\n          __typename\n          error {\n            description\n            ... on RecordNotFound {\n              __typename\n              description\n            }\n            ... on CannotEditInvoice {\n              __typename\n              description\n            }\n            ... on ForeignKeyError {\n              __typename\n              description\n              key\n            }\n            ... on LocationIsOnHold {\n              __typename\n              description\n            }\n            ... on LocationNotFound {\n              __typename\n              description\n            }\n            ... on NotEnoughStockForReduction {\n              __typename\n              batch {\n                ... on NodeError {\n                  __typename\n                  error {\n                    description\n                    ... on RecordNotFound {\n                      __typename\n                      description\n                    }\n                    ... on DatabaseError {\n                      __typename\n                      description\n                      fullError\n                    }\n                  }\n                }\n              }\n            }\n            ... on StockLineAlreadyExistsInInvoice {\n              __typename\n              description\n            }\n            ... on StockLineIsOnHold {\n              __typename\n              description\n            }\n          }\n        }\n      }\n    }\n    updateOutboundShipmentServiceLines {\n      id\n      response {\n        ... on UpdateOutboundShipmentServiceLineError {\n          __typename\n          error {\n            description\n            ... on RecordNotFound {\n              __typename\n              description\n            }\n            ... on CannotEditInvoice {\n              __typename\n              description\n            }\n            ... on ForeignKeyError {\n              __typename\n              description\n              key\n            }\n          }\n        }\n      }\n    }\n    updateOutboundShipmentUnallocatedLines {\n      id\n      response {\n        ... on UpdateOutboundShipmentUnallocatedLineError {\n          __typename\n          error {\n            description\n            ... on RecordNotFound {\n              __typename\n              description\n            }\n          }\n        }\n      }\n    }\n    updateOutboundShipments {\n      id\n      response {\n        ... on UpdateOutboundShipmentError {\n          __typename\n          error {\n            description\n          }\n        }\n        ... on NodeError {\n          __typename\n          error {\n            description\n          }\n        }\n      }\n    }\n    allocateOutboundShipmentUnallocatedLines {\n      id\n      response {\n        ... on AllocateOutboundShipmentUnallocatedLineError {\n          __typename\n          error {\n            description\n            ... on RecordNotFound {\n              __typename\n              description\n            }\n          }\n        }\n        ... on AllocateOutboundShipmentUnallocatedLineNode {\n          __typename\n          deletes {\n            id\n          }\n          inserts {\n            totalCount\n          }\n          updates {\n            totalCount\n          }\n        }\n      }\n    }\n  }\n}";