cityworks 2.1.5 → 2.2.0

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.
@@ -45,12 +45,14 @@ export declare class Attachments {
45
45
  */
46
46
  delete(attachmentIds: Array<number> | number): Promise<unknown>;
47
47
  /**
48
- * Get attachment URLs in array
49
- *
50
- * @category Attachments
51
- * @return {Object} Returns array of attachment URLs
48
+ * @hidden
52
49
  */
53
- static downloadUrls(): string[];
50
+ static downloadUrls(): {
51
+ case: string;
52
+ inspection: string;
53
+ request: string;
54
+ workorder: string;
55
+ };
54
56
  /**
55
57
  * Download an attachment
56
58
  *
@@ -29,8 +29,7 @@ export declare class CaseFlags {
29
29
  * Delete specific flag from case
30
30
  *
31
31
  * @category Case Flags
32
- * @param {number} caObjectId - The Case Object to attach the data group to.
33
- * @param {boolean} updateXY - Whether or not to update the Case's X/Y values when detaching the flags. Defaults to true.
32
+ * @param {number} caFlagId - The CaFlagId (case flag instance ID) that should be deleted
34
33
  * @return {Object} Returns Promise that represents the CaFlag that has been deleted.
35
34
  */
36
35
  delete(caFlagId: number): Promise<unknown>;
@@ -38,7 +37,7 @@ export declare class CaseFlags {
38
37
  * Delete all flags from case
39
38
  *
40
39
  * @category Case Flags
41
- * @param {number} caObjectId - The Case Object to detach the flags from.
40
+ * @param {number} caObjectId - The Case Object to delete the flags from.
42
41
  * @return {Object} Returns Promise that represents the number of flags deleted from the case provided.
43
42
  */
44
43
  deleteAll(caObjectId: number): Promise<unknown>;
package/dist/error.d.ts CHANGED
@@ -14,11 +14,11 @@ export interface CWErrorMsgs {
14
14
  *
15
15
  */
16
16
  export interface CWErrorInt {
17
- name: string;
18
- code: number;
19
- message: string;
20
- error_messages?: Array<CWErrorMsgs>;
21
- info?: string;
17
+ Name: string;
18
+ Code: number;
19
+ Message: string;
20
+ Error_messages?: Array<CWErrorMsgs>;
21
+ Info?: string;
22
22
  }
23
23
  /**
24
24
  * CWError implements a custom error class for this codebase with additional information
@@ -28,23 +28,23 @@ export declare class CWError implements CWErrorInt {
28
28
  /**
29
29
  * Just statically set to "Cityworks Exception" for now
30
30
  */
31
- name: string;
31
+ Name: string;
32
32
  /**
33
33
  * Number for the thrown error (Efforts were made to make these unique when thrown throughout the codebase)
34
34
  */
35
- code: number;
35
+ Code: number;
36
36
  /**
37
37
  * The error message
38
38
  */
39
- message: string;
39
+ Message: string;
40
40
  /**
41
41
  * The error message
42
42
  */
43
- error_messages: Array<CWErrorMsgs>;
43
+ Error_messages: Array<CWErrorMsgs>;
44
44
  /**
45
45
  * Object stuffed with any other information one wishes to include in the thrown error
46
46
  */
47
- info?: string;
47
+ Info?: string;
48
48
  /**
49
49
  * CWError implements a custom error class for this codebase with additional information
50
50
  *
package/dist/index.d.ts CHANGED
@@ -222,10 +222,10 @@ declare const activity_link: ActivityLinks;
222
222
  declare const message_queue: MessageQueue;
223
223
  declare const search: Search;
224
224
  declare const query: Query;
225
- declare const report: Report;
226
225
  declare const gis: Gis;
227
226
  declare const request: Request;
228
227
  declare const inspection: Inspection;
229
228
  declare const workorder: WorkOrder;
230
229
  declare const briefcase: Briefcase;
230
+ declare const report: Report;
231
231
  export { cw as Cityworks, general, activity_link, message_queue, search, query, gis, request, inspection, workorder, briefcase, report };