@usethrottle/api-client 4.3.0 → 4.4.0

package/dist/generated/services/ImportsService.js

@@ -0,0 +1,174 @@
+import { OpenAPI } from '../core/OpenAPI.js';
+import { request as __request } from '../core/request.js';
+export class ImportsService {
+    /**
+     * Start a bulk import: creates the import record and returns a presigned PUT the browser uploads the file to directly.
+     * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
+     * @returns any Default Response
+     * @throws ApiError
+     */
+    static postApiV1Imports(xThrottleEnvironmentId) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/v1/imports',
+            headers: {
+                'X-Throttle-Environment-Id': xThrottleEnvironmentId,
+            },
+        });
+    }
+    /**
+     * Imports for this application and environment, newest first.
+     * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
+     * @param limit
+     * @param cursor
+     * @returns any Default Response
+     * @throws ApiError
+     */
+    static getApiV1Imports(xThrottleEnvironmentId, limit = 25, cursor) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/v1/imports',
+            headers: {
+                'X-Throttle-Environment-Id': xThrottleEnvironmentId,
+            },
+            query: {
+                'limit': limit,
+                'cursor': cursor,
+            },
+        });
+    }
+    /**
+     * Sniff the uploaded file: dialect, headers, a 20-row sample, the matched template and a suggested target field per header.
+     * @param id
+     * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
+     * @returns any Default Response
+     * @throws ApiError
+     */
+    static postApiV1ImportsInspect(id, xThrottleEnvironmentId) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/v1/imports/{id}/inspect',
+            path: {
+                'id': id,
+            },
+            headers: {
+                'X-Throttle-Environment-Id': xThrottleEnvironmentId,
+            },
+        });
+    }
+    /**
+     * Save the column-to-field mapping the merchant confirmed on the mapping screen.
+     * @param id
+     * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
+     * @returns any Default Response
+     * @throws ApiError
+     */
+    static patchApiV1ImportsMapping(id, xThrottleEnvironmentId) {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/api/v1/imports/{id}/mapping',
+            path: {
+                'id': id,
+            },
+            headers: {
+                'X-Throttle-Environment-Id': xThrottleEnvironmentId,
+            },
+        });
+    }
+    /**
+     * Queue a dry run: reads the whole file under the saved mapping, reports what it would create, update, skip and reject, and writes nothing.
+     * @param id
+     * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
+     * @returns any Default Response
+     * @throws ApiError
+     */
+    static postApiV1ImportsValidate(id, xThrottleEnvironmentId) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/v1/imports/{id}/validate',
+            path: {
+                'id': id,
+            },
+            headers: {
+                'X-Throttle-Environment-Id': xThrottleEnvironmentId,
+            },
+        });
+    }
+    /**
+     * Queue the real import. Requires a completed dry run: an import that has not been validated is refused.
+     * @param id
+     * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
+     * @returns any Default Response
+     * @throws ApiError
+     */
+    static postApiV1ImportsCommit(id, xThrottleEnvironmentId) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/v1/imports/{id}/commit',
+            path: {
+                'id': id,
+            },
+            headers: {
+                'X-Throttle-Environment-Id': xThrottleEnvironmentId,
+            },
+        });
+    }
+    /**
+     * Queue the deletion of the rows this import created. Rows it only matched, and rows another record now depends on, are kept and reported on the import row.
+     * @param id
+     * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
+     * @returns any Default Response
+     * @throws ApiError
+     */
+    static postApiV1ImportsUndo(id, xThrottleEnvironmentId) {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/v1/imports/{id}/undo',
+            path: {
+                'id': id,
+            },
+            headers: {
+                'X-Throttle-Environment-Id': xThrottleEnvironmentId,
+            },
+        });
+    }
+    /**
+     * One import, with its counters and derived progress.
+     * @param id
+     * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
+     * @returns any Default Response
+     * @throws ApiError
+     */
+    static getApiV1Imports1(id, xThrottleEnvironmentId) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/v1/imports/{id}',
+            path: {
+                'id': id,
+            },
+            headers: {
+                'X-Throttle-Environment-Id': xThrottleEnvironmentId,
+            },
+        });
+    }
+    /**
+     * The row-level error report for an import, as a re-importable CSV plus the rows behind it. 404 when the import recorded no failures.
+     * @param id
+     * @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
+     * @returns any Default Response
+     * @throws ApiError
+     */
+    static getApiV1ImportsErrors(id, xThrottleEnvironmentId) {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/v1/imports/{id}/errors',
+            path: {
+                'id': id,
+            },
+            headers: {
+                'X-Throttle-Environment-Id': xThrottleEnvironmentId,
+            },
+        });
+    }
+}
+//# sourceMappingURL=ImportsService.js.map

package/dist/generated/services/ImportsService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ImportsService.js","sourceRoot":"","sources":["../../../src/generated/services/ImportsService.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC1D,MAAM,OAAO,cAAc;IACvB;;;;;OAKG;IACI,MAAM,CAAC,gBAAgB,CAC1B,sBAA+B;QAE/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,iBAAiB;YACtB,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,eAAe,CACzB,sBAA+B,EAC/B,QAAgB,EAAE,EAClB,MAAe;QAEf,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,iBAAiB;YACtB,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;YACD,KAAK,EAAE;gBACH,OAAO,EAAE,KAAK;gBACd,QAAQ,EAAE,MAAM;aACnB;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,uBAAuB,CACjC,EAAU,EACV,sBAA+B;QAE/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,8BAA8B;YACnC,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,wBAAwB,CAClC,EAAU,EACV,sBAA+B;QAE/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,OAAO;YACf,GAAG,EAAE,8BAA8B;YACnC,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,wBAAwB,CAClC,EAAU,EACV,sBAA+B;QAE/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,+BAA+B;YACpC,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,sBAAsB,CAChC,EAAU,EACV,sBAA+B;QAE/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,6BAA6B;YAClC,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,oBAAoB,CAC9B,EAAU,EACV,sBAA+B;QAE/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,2BAA2B;YAChC,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,gBAAgB,CAC1B,EAAU,EACV,sBAA+B;QAE/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,sBAAsB;YAC3B,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;SACJ,CAAC,CAAC;IACP,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,qBAAqB,CAC/B,EAAU,EACV,sBAA+B;QAE/B,OAAO,SAAS,CAAC,OAAO,EAAE;YACtB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,6BAA6B;YAClC,IAAI,EAAE;gBACF,IAAI,EAAE,EAAE;aACX;YACD,OAAO,EAAE;gBACL,2BAA2B,EAAE,sBAAsB;aACtD;SACJ,CAAC,CAAC;IACP,CAAC;CACJ"}