servicem8 0.3.15 → 0.3.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (90) hide show
  1. package/FUNCTIONS.md +1 -1
  2. package/README.md +11 -11
  3. package/api.json +728 -728
  4. package/bin/mcp-server.js +22 -22
  5. package/bin/mcp-server.js.map +10 -10
  6. package/dist/commonjs/lib/config.d.ts +2 -2
  7. package/dist/commonjs/lib/config.js +2 -2
  8. package/dist/commonjs/lib/env.d.ts +1 -1
  9. package/dist/commonjs/lib/env.d.ts.map +1 -1
  10. package/dist/commonjs/lib/env.js +1 -1
  11. package/dist/commonjs/lib/env.js.map +1 -1
  12. package/dist/commonjs/lib/security.js +6 -6
  13. package/dist/commonjs/lib/security.js.map +1 -1
  14. package/dist/commonjs/mcp-server/cli/start/command.js +4 -4
  15. package/dist/commonjs/mcp-server/cli/start/command.js.map +1 -1
  16. package/dist/commonjs/mcp-server/cli/start/impl.d.ts +1 -1
  17. package/dist/commonjs/mcp-server/cli/start/impl.d.ts.map +1 -1
  18. package/dist/commonjs/mcp-server/cli/start/impl.js +2 -2
  19. package/dist/commonjs/mcp-server/cli/start/impl.js.map +1 -1
  20. package/dist/commonjs/mcp-server/mcp-server.js +1 -1
  21. package/dist/commonjs/mcp-server/server.js +1 -1
  22. package/dist/commonjs/models/components/security.d.ts +2 -2
  23. package/dist/commonjs/models/components/security.d.ts.map +1 -1
  24. package/dist/commonjs/models/components/security.js +2 -2
  25. package/dist/commonjs/models/components/security.js.map +1 -1
  26. package/dist/esm/lib/config.d.ts +2 -2
  27. package/dist/esm/lib/config.js +2 -2
  28. package/dist/esm/lib/env.d.ts +1 -1
  29. package/dist/esm/lib/env.d.ts.map +1 -1
  30. package/dist/esm/lib/env.js +1 -1
  31. package/dist/esm/lib/env.js.map +1 -1
  32. package/dist/esm/lib/security.js +6 -6
  33. package/dist/esm/lib/security.js.map +1 -1
  34. package/dist/esm/mcp-server/cli/start/command.js +4 -4
  35. package/dist/esm/mcp-server/cli/start/command.js.map +1 -1
  36. package/dist/esm/mcp-server/cli/start/impl.d.ts +1 -1
  37. package/dist/esm/mcp-server/cli/start/impl.d.ts.map +1 -1
  38. package/dist/esm/mcp-server/cli/start/impl.js +2 -2
  39. package/dist/esm/mcp-server/cli/start/impl.js.map +1 -1
  40. package/dist/esm/mcp-server/mcp-server.js +1 -1
  41. package/dist/esm/mcp-server/server.js +1 -1
  42. package/dist/esm/models/components/security.d.ts +2 -2
  43. package/dist/esm/models/components/security.d.ts.map +1 -1
  44. package/dist/esm/models/components/security.js +2 -2
  45. package/dist/esm/models/components/security.js.map +1 -1
  46. package/docs/sdks/allocationwindows/README.md +10 -10
  47. package/docs/sdks/assets/README.md +8 -8
  48. package/docs/sdks/assettypefields/README.md +10 -10
  49. package/docs/sdks/assettypes/README.md +10 -10
  50. package/docs/sdks/attachments/README.md +10 -10
  51. package/docs/sdks/badges/README.md +10 -10
  52. package/docs/sdks/bundles/README.md +10 -10
  53. package/docs/sdks/categories/README.md +10 -10
  54. package/docs/sdks/clients/README.md +10 -10
  55. package/docs/sdks/companycontacts/README.md +10 -10
  56. package/docs/sdks/emailtemplates/README.md +10 -10
  57. package/docs/sdks/feedback/README.md +10 -10
  58. package/docs/sdks/formfields/README.md +10 -10
  59. package/docs/sdks/formresponses/README.md +10 -10
  60. package/docs/sdks/forms/README.md +10 -10
  61. package/docs/sdks/jobactivities/README.md +10 -10
  62. package/docs/sdks/joballocations/README.md +10 -10
  63. package/docs/sdks/jobchecklists/README.md +10 -10
  64. package/docs/sdks/jobcontacts/README.md +10 -10
  65. package/docs/sdks/jobmaterialbundles/README.md +10 -10
  66. package/docs/sdks/jobmaterials/README.md +10 -10
  67. package/docs/sdks/jobpayments/README.md +10 -10
  68. package/docs/sdks/jobqueues/README.md +10 -10
  69. package/docs/sdks/jobs/README.md +10 -10
  70. package/docs/sdks/knowledgearticles/README.md +10 -10
  71. package/docs/sdks/locations/README.md +10 -10
  72. package/docs/sdks/materials/README.md +10 -10
  73. package/docs/sdks/notes/README.md +10 -10
  74. package/docs/sdks/securityroles/README.md +10 -10
  75. package/docs/sdks/smstemplates/README.md +10 -10
  76. package/docs/sdks/staffmembers/README.md +10 -10
  77. package/docs/sdks/staffmessages/README.md +10 -10
  78. package/docs/sdks/tasks/README.md +10 -10
  79. package/docs/sdks/taxrates/README.md +10 -10
  80. package/docs/sdks/vendors/README.md +6 -6
  81. package/jsr.json +1 -1
  82. package/package.json +1 -1
  83. package/src/lib/config.ts +2 -2
  84. package/src/lib/env.ts +2 -2
  85. package/src/lib/security.ts +6 -6
  86. package/src/mcp-server/cli/start/command.ts +4 -4
  87. package/src/mcp-server/cli/start/impl.ts +3 -3
  88. package/src/mcp-server/mcp-server.ts +1 -1
  89. package/src/mcp-server/server.ts +1 -1
  90. package/src/models/components/security.ts +4 -4
package/FUNCTIONS.md CHANGED
@@ -27,7 +27,7 @@ import { SDKValidationError } from "servicem8/models/errors/sdkvalidationerror.j
27
27
  // You can create one instance of it to use across an application.
28
28
  const serviceM8 = new ServiceM8Core({
29
29
  security: {
30
- oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
30
+ apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
31
31
  },
32
32
  });
33
33
 
package/README.md CHANGED
@@ -109,8 +109,8 @@ Add the following server definition to your `claude_desktop_config.json` file:
109
109
  "-y", "--package", "servicem8",
110
110
  "--",
111
111
  "mcp", "start",
112
- "--oauth2", "...",
113
- "--api-key-auth", "..."
112
+ "--api-key-auth", "...",
113
+ "--oauth2", "..."
114
114
  ]
115
115
  }
116
116
  }
@@ -133,8 +133,8 @@ Create a `.cursor/mcp.json` file in your project root with the following content
133
133
  "-y", "--package", "servicem8",
134
134
  "--",
135
135
  "mcp", "start",
136
- "--oauth2", "...",
137
- "--api-key-auth", "..."
136
+ "--api-key-auth", "...",
137
+ "--oauth2", "..."
138
138
  ]
139
139
  }
140
140
  }
@@ -190,7 +190,7 @@ import { ServiceM8 } from "servicem8";
190
190
 
191
191
  const serviceM8 = new ServiceM8({
192
192
  security: {
193
- oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
193
+ apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
194
194
  },
195
195
  });
196
196
 
@@ -215,8 +215,8 @@ This SDK supports the following security schemes globally:
215
215
 
216
216
  | Name | Type | Scheme | Environment Variable |
217
217
  | ------------ | ------ | ------------ | ------------------------ |
218
- | `oauth2` | oauth2 | OAuth2 token | `SERVICEM8_OAUTH2` |
219
218
  | `apiKeyAuth` | apiKey | API key | `SERVICEM8_API_KEY_AUTH` |
219
+ | `oauth2` | oauth2 | OAuth2 token | `SERVICEM8_OAUTH2` |
220
220
 
221
221
  You can set the security parameters through the `security` optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:
222
222
  ```typescript
@@ -224,7 +224,7 @@ import { ServiceM8 } from "servicem8";
224
224
 
225
225
  const serviceM8 = new ServiceM8({
226
226
  security: {
227
- oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
227
+ apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
228
228
  },
229
229
  });
230
230
 
@@ -729,7 +729,7 @@ import { ServiceM8 } from "servicem8";
729
729
 
730
730
  const serviceM8 = new ServiceM8({
731
731
  security: {
732
- oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
732
+ apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
733
733
  },
734
734
  });
735
735
 
@@ -771,7 +771,7 @@ const serviceM8 = new ServiceM8({
771
771
  retryConnectionErrors: false,
772
772
  },
773
773
  security: {
774
- oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
774
+ apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
775
775
  },
776
776
  });
777
777
 
@@ -805,7 +805,7 @@ import { ErrorT, SDKValidationError } from "servicem8/models/errors";
805
805
 
806
806
  const serviceM8 = new ServiceM8({
807
807
  security: {
808
- oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
808
+ apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
809
809
  },
810
810
  });
811
811
 
@@ -868,7 +868,7 @@ import { ServiceM8 } from "servicem8";
868
868
  const serviceM8 = new ServiceM8({
869
869
  serverURL: "https://api.servicem8.com/api_1.0",
870
870
  security: {
871
- oauth2: process.env["SERVICEM8_OAUTH2"] ?? "",
871
+ apiKeyAuth: process.env["SERVICEM8_API_KEY_AUTH"] ?? "",
872
872
  },
873
873
  });
874
874