@nizam-os/carrier-sdk 2.5.3 → 2.7.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.
Files changed (86) hide show
  1. package/dist/Client.d.ts +6 -0
  2. package/dist/Client.js +16 -8
  3. package/dist/api/errors/BadRequestError.d.ts +6 -0
  4. package/dist/api/errors/BadRequestError.js +54 -0
  5. package/dist/api/errors/ContentTooLargeError.d.ts +6 -0
  6. package/dist/api/errors/ContentTooLargeError.js +54 -0
  7. package/dist/api/errors/index.d.ts +2 -0
  8. package/dist/api/errors/index.js +2 -0
  9. package/dist/api/resources/files/client/Client.d.ts +188 -0
  10. package/dist/api/resources/files/client/Client.js +608 -0
  11. package/dist/api/resources/files/client/index.d.ts +1 -0
  12. package/dist/api/resources/files/client/index.js +17 -0
  13. package/dist/api/resources/files/client/requests/CancelFileUploadRequest.d.ts +9 -0
  14. package/dist/api/resources/files/client/requests/CancelFileUploadRequest.js +3 -0
  15. package/dist/api/resources/files/client/requests/CompleteFileUploadRequest.d.ts +15 -0
  16. package/dist/api/resources/files/client/requests/CompleteFileUploadRequest.js +3 -0
  17. package/dist/api/resources/files/client/requests/CreateFileDownloadUrlRequest.d.ts +9 -0
  18. package/dist/api/resources/files/client/requests/CreateFileDownloadUrlRequest.js +3 -0
  19. package/dist/api/resources/files/client/requests/DeleteFileRequest.d.ts +9 -0
  20. package/dist/api/resources/files/client/requests/DeleteFileRequest.js +3 -0
  21. package/dist/api/resources/files/client/requests/GetFileRequest.d.ts +9 -0
  22. package/dist/api/resources/files/client/requests/GetFileRequest.js +3 -0
  23. package/dist/api/resources/files/client/requests/InitiateFileUploadRequest.d.ts +41 -0
  24. package/dist/api/resources/files/client/requests/InitiateFileUploadRequest.js +17 -0
  25. package/dist/api/resources/files/client/requests/ListFilesRequest.d.ts +27 -0
  26. package/dist/api/resources/files/client/requests/ListFilesRequest.js +3 -0
  27. package/dist/api/resources/files/client/requests/ResumeFileUploadRequest.d.ts +9 -0
  28. package/dist/api/resources/files/client/requests/ResumeFileUploadRequest.js +3 -0
  29. package/dist/api/resources/files/client/requests/index.d.ts +8 -0
  30. package/dist/api/resources/files/client/requests/index.js +5 -0
  31. package/dist/api/resources/files/exports.d.ts +2 -0
  32. package/dist/api/resources/files/exports.js +21 -0
  33. package/dist/api/resources/files/index.d.ts +1 -0
  34. package/dist/api/resources/files/index.js +17 -0
  35. package/dist/api/resources/index.d.ts +5 -0
  36. package/dist/api/resources/index.js +6 -1
  37. package/dist/api/resources/taskAttempts/client/Client.d.ts +65 -0
  38. package/dist/api/resources/taskAttempts/client/Client.js +208 -0
  39. package/dist/api/resources/taskAttempts/client/index.d.ts +1 -0
  40. package/dist/api/resources/taskAttempts/client/index.js +17 -0
  41. package/dist/api/resources/taskAttempts/client/requests/CaptureTaskAttemptPhotoRequest.d.ts +49 -0
  42. package/dist/api/resources/taskAttempts/client/requests/CaptureTaskAttemptPhotoRequest.js +20 -0
  43. package/dist/api/resources/taskAttempts/client/requests/ListTaskAttemptPhotosRequest.d.ts +17 -0
  44. package/dist/api/resources/taskAttempts/client/requests/ListTaskAttemptPhotosRequest.js +3 -0
  45. package/dist/api/resources/taskAttempts/client/requests/index.d.ts +2 -0
  46. package/dist/api/resources/taskAttempts/client/requests/index.js +5 -0
  47. package/dist/api/resources/taskAttempts/exports.d.ts +2 -0
  48. package/dist/api/resources/taskAttempts/exports.js +21 -0
  49. package/dist/api/resources/taskAttempts/index.d.ts +1 -0
  50. package/dist/api/resources/taskAttempts/index.js +17 -0
  51. package/dist/api/resources/users/client/Client.d.ts +43 -0
  52. package/dist/api/resources/users/client/Client.js +142 -0
  53. package/dist/api/resources/users/client/index.d.ts +1 -1
  54. package/dist/api/resources/users/client/index.js +15 -0
  55. package/dist/api/resources/users/client/requests/GetUserProfilePictureRequest.d.ts +11 -0
  56. package/dist/api/resources/users/client/requests/GetUserProfilePictureRequest.js +3 -0
  57. package/dist/api/resources/users/client/requests/InitiateProfilePictureUploadRequest.d.ts +19 -0
  58. package/dist/api/resources/users/client/requests/InitiateProfilePictureUploadRequest.js +3 -0
  59. package/dist/api/resources/users/client/requests/index.d.ts +2 -0
  60. package/dist/api/resources/users/client/requests/index.js +2 -0
  61. package/dist/api/types/FileDownloadUrl.d.ts +16 -0
  62. package/dist/api/types/FileDownloadUrl.js +10 -0
  63. package/dist/api/types/FileUploadPart.d.ts +13 -0
  64. package/dist/api/types/FileUploadPart.js +3 -0
  65. package/dist/api/types/FileUploadPartReport.d.ts +9 -0
  66. package/dist/api/types/FileUploadPartReport.js +3 -0
  67. package/dist/api/types/FileUploadSession.d.ts +51 -0
  68. package/dist/api/types/FileUploadSession.js +28 -0
  69. package/dist/api/types/File_.d.ts +86 -0
  70. package/dist/api/types/File_.js +40 -0
  71. package/dist/api/types/Job.d.ts +2 -0
  72. package/dist/api/types/Job.js +2 -0
  73. package/dist/api/types/ListResponseFile.d.ts +27 -0
  74. package/dist/api/types/ListResponseFile.js +11 -0
  75. package/dist/api/types/TaskAttemptPhoto.d.ts +30 -0
  76. package/dist/api/types/TaskAttemptPhoto.js +10 -0
  77. package/dist/api/types/TaskAttemptPhotoThumbnail.d.ts +9 -0
  78. package/dist/api/types/TaskAttemptPhotoThumbnail.js +3 -0
  79. package/dist/api/types/UploadInitiation.d.ts +22 -0
  80. package/dist/api/types/UploadInitiation.js +10 -0
  81. package/dist/api/types/UploadInitiationPart.d.ts +13 -0
  82. package/dist/api/types/UploadInitiationPart.js +3 -0
  83. package/dist/api/types/User.d.ts +2 -0
  84. package/dist/api/types/index.d.ts +10 -0
  85. package/dist/api/types/index.js +10 -0
  86. package/package.json +1 -1
@@ -0,0 +1,27 @@
1
+ import type * as NizamCarrier from "../index.js";
2
+ /**
3
+ * Envelope for paginated list responses (Stripe-style cursor pagination).
4
+ */
5
+ export interface ListResponseFile {
6
+ /** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
7
+ object?: ListResponseFile.Object_ | undefined;
8
+ /** Page of resources. Empty array when there are no matches. */
9
+ data?: NizamCarrier.File_[] | undefined;
10
+ /** True when more pages exist; pass `next_cursor` as `?starting_after=` to fetch the next page. */
11
+ has_more?: boolean | undefined;
12
+ /** True when earlier pages exist; pass `prev_cursor` as `?ending_before=` to fetch the previous page. */
13
+ has_previous?: boolean | undefined;
14
+ /** Opaque cursor for the next page. `null` on the last page. */
15
+ next_cursor?: string | undefined;
16
+ /** Opaque cursor for the previous page. `null` on the first page. */
17
+ prev_cursor?: string | undefined;
18
+ /** Page size that produced this response. */
19
+ limit?: number | undefined;
20
+ }
21
+ export declare namespace ListResponseFile {
22
+ /** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
23
+ const Object_: {
24
+ readonly List: "list";
25
+ };
26
+ type Object_ = (typeof Object_)[keyof typeof Object_];
27
+ }
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.ListResponseFile = void 0;
5
+ var ListResponseFile;
6
+ (function (ListResponseFile) {
7
+ /** Object type discriminator (Stripe pattern). Always `list` for this envelope. */
8
+ ListResponseFile.Object_ = {
9
+ List: "list",
10
+ };
11
+ })(ListResponseFile || (exports.ListResponseFile = ListResponseFile = {}));
@@ -0,0 +1,30 @@
1
+ import type * as NizamCarrier from "../index.js";
2
+ /**
3
+ * A proof-of-delivery photo captured during a task attempt.
4
+ */
5
+ export interface TaskAttemptPhoto {
6
+ /** Photo record id. */
7
+ id?: string | undefined;
8
+ /** Central file id — request bytes via the files download-url endpoint. */
9
+ file_id?: string | undefined;
10
+ /** Display order within the attempt. */
11
+ sequence?: number | undefined;
12
+ /** Photo category, when categorised. */
13
+ photo_type?: string | undefined;
14
+ /** Operator-entered caption. */
15
+ caption?: string | undefined;
16
+ /** Device capture time (EXIF), when reported. */
17
+ taken_at?: string | undefined;
18
+ /** May the bytes be served right now (scan verdict + lifecycle)? */
19
+ downloadable?: boolean | undefined;
20
+ thumbnails?: NizamCarrier.TaskAttemptPhotoThumbnail[] | undefined;
21
+ /** When the photo row was recorded. */
22
+ created_at?: string | undefined;
23
+ object?: TaskAttemptPhoto.Object_ | undefined;
24
+ }
25
+ export declare namespace TaskAttemptPhoto {
26
+ const Object_: {
27
+ readonly TaskAttemptPhoto: "task_attempt_photo";
28
+ };
29
+ type Object_ = (typeof Object_)[keyof typeof Object_];
30
+ }
@@ -0,0 +1,10 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.TaskAttemptPhoto = void 0;
5
+ var TaskAttemptPhoto;
6
+ (function (TaskAttemptPhoto) {
7
+ TaskAttemptPhoto.Object_ = {
8
+ TaskAttemptPhoto: "task_attempt_photo",
9
+ };
10
+ })(TaskAttemptPhoto || (exports.TaskAttemptPhoto = TaskAttemptPhoto = {}));
@@ -0,0 +1,9 @@
1
+ /**
2
+ * One rendered thumbnail variant.
3
+ */
4
+ export interface TaskAttemptPhotoThumbnail {
5
+ /** Bounding-box size the variant was rendered into (px). */
6
+ max_dimension?: number | undefined;
7
+ /** The variant's file id — request bytes via the files download-url endpoint. */
8
+ file_id?: string | undefined;
9
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,22 @@
1
+ import type * as NizamCarrier from "../index.js";
2
+ /**
3
+ * A freshly initiated upload: the session handle, the pre-reserved file id and the presigned part URLs. Resume/complete/cancel go through the generic file-uploads endpoints.
4
+ */
5
+ export interface UploadInitiation {
6
+ /** Upload session id — the handle for resume/complete/cancel. */
7
+ upload_session_id?: string | undefined;
8
+ /** Pre-reserved file id — the id the completed file WILL carry. */
9
+ file_id?: string | undefined;
10
+ /** Fixed size of every part except the last. */
11
+ part_size_bytes?: number | undefined;
12
+ /** Session deadline; the sweep aborts the upload after this. */
13
+ expires_at?: string | undefined;
14
+ parts?: NizamCarrier.UploadInitiationPart[] | undefined;
15
+ object?: UploadInitiation.Object_ | undefined;
16
+ }
17
+ export declare namespace UploadInitiation {
18
+ const Object_: {
19
+ readonly FileUploadInitiation: "file_upload_initiation";
20
+ };
21
+ type Object_ = (typeof Object_)[keyof typeof Object_];
22
+ }
@@ -0,0 +1,10 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.UploadInitiation = void 0;
5
+ var UploadInitiation;
6
+ (function (UploadInitiation) {
7
+ UploadInitiation.Object_ = {
8
+ FileUploadInitiation: "file_upload_initiation",
9
+ };
10
+ })(UploadInitiation || (exports.UploadInitiation = UploadInitiation = {}));
@@ -0,0 +1,13 @@
1
+ /**
2
+ * One presigned part PUT.
3
+ */
4
+ export interface UploadInitiationPart {
5
+ /** 1-based part number. */
6
+ part_number?: number | undefined;
7
+ /** Presigned URL to PUT the part's bytes to. */
8
+ url?: string | undefined;
9
+ /** Headers that were signed into the URL; repeat them verbatim. */
10
+ headers?: Record<string, string> | undefined;
11
+ /** URL expiry; re-request via resume if it lapses. */
12
+ url_expires_at?: string | undefined;
13
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -17,6 +17,8 @@ export interface User {
17
17
  last_login_at?: string | undefined;
18
18
  /** Total logins observed by this service. */
19
19
  login_count?: number | undefined;
20
+ /** File id of the current profile picture (epic #151 / #166); null until one is uploaded. Request bytes via the files download-url endpoint, or let `GET /users/{id}/profile-picture` pick the nearest thumbnail. */
21
+ profile_picture_file_id?: string | undefined;
20
22
  /** Object type discriminator (Stripe pattern). */
21
23
  object?: User.Object_ | undefined;
22
24
  }
@@ -16,6 +16,11 @@ export * from "./CreateOperatorRequest.js";
16
16
  export * from "./CreateOrganizationRequest.js";
17
17
  export * from "./CreateTeleoperatedOperatorRequest.js";
18
18
  export * from "./Currency.js";
19
+ export * from "./File_.js";
20
+ export * from "./FileDownloadUrl.js";
21
+ export * from "./FileUploadPart.js";
22
+ export * from "./FileUploadPartReport.js";
23
+ export * from "./FileUploadSession.js";
19
24
  export * from "./HeatmapCell.js";
20
25
  export * from "./InternalUserUpdateRequest.js";
21
26
  export * from "./Invite.js";
@@ -28,6 +33,7 @@ export * from "./ListResponseAssetListItem.js";
28
33
  export * from "./ListResponseBusinessCategory.js";
29
34
  export * from "./ListResponseCountry.js";
30
35
  export * from "./ListResponseCurrency.js";
36
+ export * from "./ListResponseFile.js";
31
37
  export * from "./ListResponseHeatmapCell.js";
32
38
  export * from "./ListResponseJob.js";
33
39
  export * from "./ListResponseLanguage.js";
@@ -50,7 +56,11 @@ export * from "./ProblemDetail.js";
50
56
  export * from "./RealtimeTicket.js";
51
57
  export * from "./ReconcileResponse.js";
52
58
  export * from "./SetActiveOrganizationRequest.js";
59
+ export * from "./TaskAttemptPhoto.js";
60
+ export * from "./TaskAttemptPhotoThumbnail.js";
53
61
  export * from "./Timezone.js";
54
62
  export * from "./UpdateOrganizationRequest.js";
63
+ export * from "./UploadInitiation.js";
64
+ export * from "./UploadInitiationPart.js";
55
65
  export * from "./User.js";
56
66
  export * from "./UserResource.js";
@@ -32,6 +32,11 @@ __exportStar(require("./CreateOperatorRequest.js"), exports);
32
32
  __exportStar(require("./CreateOrganizationRequest.js"), exports);
33
33
  __exportStar(require("./CreateTeleoperatedOperatorRequest.js"), exports);
34
34
  __exportStar(require("./Currency.js"), exports);
35
+ __exportStar(require("./File_.js"), exports);
36
+ __exportStar(require("./FileDownloadUrl.js"), exports);
37
+ __exportStar(require("./FileUploadPart.js"), exports);
38
+ __exportStar(require("./FileUploadPartReport.js"), exports);
39
+ __exportStar(require("./FileUploadSession.js"), exports);
35
40
  __exportStar(require("./HeatmapCell.js"), exports);
36
41
  __exportStar(require("./InternalUserUpdateRequest.js"), exports);
37
42
  __exportStar(require("./Invite.js"), exports);
@@ -44,6 +49,7 @@ __exportStar(require("./ListResponseAssetListItem.js"), exports);
44
49
  __exportStar(require("./ListResponseBusinessCategory.js"), exports);
45
50
  __exportStar(require("./ListResponseCountry.js"), exports);
46
51
  __exportStar(require("./ListResponseCurrency.js"), exports);
52
+ __exportStar(require("./ListResponseFile.js"), exports);
47
53
  __exportStar(require("./ListResponseHeatmapCell.js"), exports);
48
54
  __exportStar(require("./ListResponseJob.js"), exports);
49
55
  __exportStar(require("./ListResponseLanguage.js"), exports);
@@ -66,7 +72,11 @@ __exportStar(require("./ProblemDetail.js"), exports);
66
72
  __exportStar(require("./RealtimeTicket.js"), exports);
67
73
  __exportStar(require("./ReconcileResponse.js"), exports);
68
74
  __exportStar(require("./SetActiveOrganizationRequest.js"), exports);
75
+ __exportStar(require("./TaskAttemptPhoto.js"), exports);
76
+ __exportStar(require("./TaskAttemptPhotoThumbnail.js"), exports);
69
77
  __exportStar(require("./Timezone.js"), exports);
70
78
  __exportStar(require("./UpdateOrganizationRequest.js"), exports);
79
+ __exportStar(require("./UploadInitiation.js"), exports);
80
+ __exportStar(require("./UploadInitiationPart.js"), exports);
71
81
  __exportStar(require("./User.js"), exports);
72
82
  __exportStar(require("./UserResource.js"), exports);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nizam-os/carrier-sdk",
3
- "version": "2.5.3",
3
+ "version": "2.7.0",
4
4
  "description": "Nizam Carrier API SDK for TypeScript / JavaScript.",
5
5
  "license": "MIT",
6
6
  "private": false,