@thunkier/thunkmetrc-wrapper 0.2.2 → 0.3.1

package/dist/wrapper/src/services/ProcessingJobService.d.ts

@@ -0,0 +1,120 @@
+import { MetrcClient as InternalMetrcClient } from '@thunkier/thunkmetrc-client';
+import { MetrcRateLimiter } from '../RateLimiter';
+import { PaginatedResponse, ActiveJobType, CreateAdjustProcessingJobRequestItem, CreateJobTypesRequestItem, CreateProcessingJobPackagesRequestItem, FinishProcessingJobRequestItem, InactiveJobType, JobTypesAttribute, JobTypesCategory, ProcessingJob, StartProcessingJobRequestItem, UnfinishProcessingJobRequestItem, UpdateJobTypesRequestItem, WriteResponse } from '../models';
+export declare class ProcessingJobService {
+    private client;
+    private rateLimiter;
+    constructor(client: InternalMetrcClient, rateLimiter: MetrcRateLimiter);
+    /**
+     * Adjusts the details of existing processing jobs at a Facility, including units of measure and associated packages.
+     * Permissions Required:
+     * - Manage Processing Job
+     * POST CreateAdjustProcessingJob
+     */
+    createAdjustProcessingJob(body: CreateAdjustProcessingJobRequestItem[], licenseNumber?: string): Promise<WriteResponse>;
+    /**
+     * Creates new processing job types for a Facility, including name, category, description, steps, and attributes.
+     * Permissions Required:
+     * - Manage Processing Job
+     * POST CreateJobTypes
+     */
+    createProcessingJobJobTypes(body: CreateJobTypesRequestItem[], licenseNumber?: string): Promise<WriteResponse>;
+    /**
+     * Creates packages from processing jobs at a Facility, including optional location and note assignments.
+     * Permissions Required:
+     * - Manage Processing Job
+     * POST CreateProcessingJobPackages
+     */
+    createProcessingJobPackages(body: CreateProcessingJobPackagesRequestItem[], licenseNumber?: string): Promise<WriteResponse>;
+    /**
+     * Archives a Processing Job Type at a Facility, making it inactive for future use.
+     * Permissions Required:
+     * - Manage Processing Job
+     * DELETE DeleteJobTypeById
+     */
+    deleteProcessingJobJobTypeById(id: string, body?: any, licenseNumber?: string): Promise<any>;
+    /**
+     * Archives a Processing Job at a Facility by marking it as inactive and removing it from active use.
+     * Permissions Required:
+     * - Manage Processing Job
+     * DELETE DeleteProcessingJobById
+     */
+    deleteProcessingJobById(id: string, body?: any, licenseNumber?: string): Promise<any>;
+    /**
+     * Completes processing jobs at a Facility by recording final notes and waste measurements.
+     * Permissions Required:
+     * - Manage Processing Job
+     * PUT FinishProcessingJob
+     */
+    finishProcessingJobProcessingJob(body: FinishProcessingJobRequestItem[], licenseNumber?: string): Promise<any>;
+    /**
+     * Retrieves a list of all active processing job types defined within a Facility.
+     * Permissions Required:
+     * - Manage Processing Job
+     * GET GetActiveJobTypes
+     */
+    getProcessingJobActiveJobTypes(body?: any, lastModifiedEnd?: string, lastModifiedStart?: string, licenseNumber?: string, pageNumber?: number, pageSize?: string): Promise<PaginatedResponse<ActiveJobType>>;
+    /**
+     * Retrieves active processing jobs at a specified Facility.
+     * Permissions Required:
+     * - Manage Processing Job
+     * GET GetActiveProcessingJob
+     */
+    getActiveProcessingJob(body?: any, lastModifiedEnd?: string, lastModifiedStart?: string, licenseNumber?: string, pageNumber?: number, pageSize?: string): Promise<PaginatedResponse<ProcessingJob>>;
+    /**
+     * Retrieves a list of all inactive processing job types defined within a Facility.
+     * Permissions Required:
+     * - Manage Processing Job
+     * GET GetInactiveJobTypes
+     */
+    getProcessingJobInactiveJobTypes(body?: any, lastModifiedEnd?: string, lastModifiedStart?: string, licenseNumber?: string, pageNumber?: number, pageSize?: string): Promise<PaginatedResponse<InactiveJobType>>;
+    /**
+     * Retrieves inactive processing jobs at a specified Facility.
+     * Permissions Required:
+     * - Manage Processing Job
+     * GET GetInactiveProcessingJob
+     */
+    getInactiveProcessingJob(body?: any, lastModifiedEnd?: string, lastModifiedStart?: string, licenseNumber?: string, pageNumber?: number, pageSize?: string): Promise<PaginatedResponse<ProcessingJob>>;
+    /**
+     * Retrieves all processing job attributes available for a Facility.
+     * Permissions Required:
+     * - Manage Processing Job
+     * GET GetJobTypesAttributes
+     */
+    getProcessingJobJobTypesAttributes(body?: any, licenseNumber?: string): Promise<PaginatedResponse<JobTypesAttribute>>;
+    /**
+     * Retrieves all processing job categories available for a specified Facility.
+     * Permissions Required:
+     * - Manage Processing Job
+     * GET GetJobTypesCategories
+     */
+    getProcessingJobJobTypesCategories(body?: any, licenseNumber?: string): Promise<PaginatedResponse<JobTypesCategory>>;
+    /**
+     * Retrieves a ProcessingJob by Id.
+     * Permissions Required:
+     * - Manage Processing Job
+     * GET GetProcessingJobById
+     */
+    getProcessingJobById(id: string, body?: any, licenseNumber?: string): Promise<ProcessingJob>;
+    /**
+     * Initiates new processing jobs at a Facility, including job details and associated packages.
+     * Permissions Required:
+     * - Manage Processing Job
+     * POST StartProcessingJob
+     */
+    startProcessingJobProcessingJob(body: StartProcessingJobRequestItem[], licenseNumber?: string): Promise<WriteResponse>;
+    /**
+     * Reopens previously completed processing jobs at a Facility to allow further updates or corrections.
+     * Permissions Required:
+     * - Manage Processing Job
+     * PUT UnfinishProcessingJob
+     */
+    unfinishProcessingJobProcessingJob(body: UnfinishProcessingJobRequestItem[], licenseNumber?: string): Promise<any>;
+    /**
+     * Updates existing processing job types at a Facility, including their name, category, description, steps, and attributes.
+     * Permissions Required:
+     * - Manage Processing Job
+     * PUT UpdateJobTypes
+     */
+    updateProcessingJobJobTypes(body: UpdateJobTypesRequestItem[], licenseNumber?: string): Promise<WriteResponse>;
+}

package/dist/wrapper/src/services/ProcessingJobService.js

@@ -0,0 +1,154 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProcessingJobService = void 0;
+class ProcessingJobService {
+    constructor(client, rateLimiter) {
+        this.client = client;
+        this.rateLimiter = rateLimiter;
+    }
+    /**
+     * Adjusts the details of existing processing jobs at a Facility, including units of measure and associated packages.
+     * Permissions Required:
+     * - Manage Processing Job
+     * POST CreateAdjustProcessingJob
+     */
+    async createAdjustProcessingJob(body, licenseNumber) {
+        return this.rateLimiter.execute(null, false, () => this.client.createAdjustProcessingJob(body, licenseNumber));
+    }
+    /**
+     * Creates new processing job types for a Facility, including name, category, description, steps, and attributes.
+     * Permissions Required:
+     * - Manage Processing Job
+     * POST CreateJobTypes
+     */
+    async createProcessingJobJobTypes(body, licenseNumber) {
+        return this.rateLimiter.execute(null, false, () => this.client.createProcessingJobJobTypes(body, licenseNumber));
+    }
+    /**
+     * Creates packages from processing jobs at a Facility, including optional location and note assignments.
+     * Permissions Required:
+     * - Manage Processing Job
+     * POST CreateProcessingJobPackages
+     */
+    async createProcessingJobPackages(body, licenseNumber) {
+        return this.rateLimiter.execute(null, false, () => this.client.createProcessingJobPackages(body, licenseNumber));
+    }
+    /**
+     * Archives a Processing Job Type at a Facility, making it inactive for future use.
+     * Permissions Required:
+     * - Manage Processing Job
+     * DELETE DeleteJobTypeById
+     */
+    async deleteProcessingJobJobTypeById(id, body, licenseNumber) {
+        return this.rateLimiter.execute(null, false, () => this.client.deleteProcessingJobJobTypeById(id, body, licenseNumber));
+    }
+    /**
+     * Archives a Processing Job at a Facility by marking it as inactive and removing it from active use.
+     * Permissions Required:
+     * - Manage Processing Job
+     * DELETE DeleteProcessingJobById
+     */
+    async deleteProcessingJobById(id, body, licenseNumber) {
+        return this.rateLimiter.execute(null, false, () => this.client.deleteProcessingJobById(id, body, licenseNumber));
+    }
+    /**
+     * Completes processing jobs at a Facility by recording final notes and waste measurements.
+     * Permissions Required:
+     * - Manage Processing Job
+     * PUT FinishProcessingJob
+     */
+    async finishProcessingJobProcessingJob(body, licenseNumber) {
+        return this.rateLimiter.execute(null, false, () => this.client.finishProcessingJobProcessingJob(body, licenseNumber));
+    }
+    /**
+     * Retrieves a list of all active processing job types defined within a Facility.
+     * Permissions Required:
+     * - Manage Processing Job
+     * GET GetActiveJobTypes
+     */
+    async getProcessingJobActiveJobTypes(body, lastModifiedEnd, lastModifiedStart, licenseNumber, pageNumber, pageSize) {
+        return this.rateLimiter.execute(null, true, () => this.client.getProcessingJobActiveJobTypes(body, lastModifiedEnd, lastModifiedStart, licenseNumber, pageNumber, pageSize));
+    }
+    /**
+     * Retrieves active processing jobs at a specified Facility.
+     * Permissions Required:
+     * - Manage Processing Job
+     * GET GetActiveProcessingJob
+     */
+    async getActiveProcessingJob(body, lastModifiedEnd, lastModifiedStart, licenseNumber, pageNumber, pageSize) {
+        return this.rateLimiter.execute(null, true, () => this.client.getActiveProcessingJob(body, lastModifiedEnd, lastModifiedStart, licenseNumber, pageNumber, pageSize));
+    }
+    /**
+     * Retrieves a list of all inactive processing job types defined within a Facility.
+     * Permissions Required:
+     * - Manage Processing Job
+     * GET GetInactiveJobTypes
+     */
+    async getProcessingJobInactiveJobTypes(body, lastModifiedEnd, lastModifiedStart, licenseNumber, pageNumber, pageSize) {
+        return this.rateLimiter.execute(null, true, () => this.client.getProcessingJobInactiveJobTypes(body, lastModifiedEnd, lastModifiedStart, licenseNumber, pageNumber, pageSize));
+    }
+    /**
+     * Retrieves inactive processing jobs at a specified Facility.
+     * Permissions Required:
+     * - Manage Processing Job
+     * GET GetInactiveProcessingJob
+     */
+    async getInactiveProcessingJob(body, lastModifiedEnd, lastModifiedStart, licenseNumber, pageNumber, pageSize) {
+        return this.rateLimiter.execute(null, true, () => this.client.getInactiveProcessingJob(body, lastModifiedEnd, lastModifiedStart, licenseNumber, pageNumber, pageSize));
+    }
+    /**
+     * Retrieves all processing job attributes available for a Facility.
+     * Permissions Required:
+     * - Manage Processing Job
+     * GET GetJobTypesAttributes
+     */
+    async getProcessingJobJobTypesAttributes(body, licenseNumber) {
+        return this.rateLimiter.execute(null, true, () => this.client.getProcessingJobJobTypesAttributes(body, licenseNumber));
+    }
+    /**
+     * Retrieves all processing job categories available for a specified Facility.
+     * Permissions Required:
+     * - Manage Processing Job
+     * GET GetJobTypesCategories
+     */
+    async getProcessingJobJobTypesCategories(body, licenseNumber) {
+        return this.rateLimiter.execute(null, true, () => this.client.getProcessingJobJobTypesCategories(body, licenseNumber));
+    }
+    /**
+     * Retrieves a ProcessingJob by Id.
+     * Permissions Required:
+     * - Manage Processing Job
+     * GET GetProcessingJobById
+     */
+    async getProcessingJobById(id, body, licenseNumber) {
+        return this.rateLimiter.execute(null, true, () => this.client.getProcessingJobById(id, body, licenseNumber));
+    }
+    /**
+     * Initiates new processing jobs at a Facility, including job details and associated packages.
+     * Permissions Required:
+     * - Manage Processing Job
+     * POST StartProcessingJob
+     */
+    async startProcessingJobProcessingJob(body, licenseNumber) {
+        return this.rateLimiter.execute(null, false, () => this.client.startProcessingJobProcessingJob(body, licenseNumber));
+    }
+    /**
+     * Reopens previously completed processing jobs at a Facility to allow further updates or corrections.
+     * Permissions Required:
+     * - Manage Processing Job
+     * PUT UnfinishProcessingJob
+     */
+    async unfinishProcessingJobProcessingJob(body, licenseNumber) {
+        return this.rateLimiter.execute(null, false, () => this.client.unfinishProcessingJobProcessingJob(body, licenseNumber));
+    }
+    /**
+     * Updates existing processing job types at a Facility, including their name, category, description, steps, and attributes.
+     * Permissions Required:
+     * - Manage Processing Job
+     * PUT UpdateJobTypes
+     */
+    async updateProcessingJobJobTypes(body, licenseNumber) {
+        return this.rateLimiter.execute(null, false, () => this.client.updateProcessingJobJobTypes(body, licenseNumber));
+    }
+}
+exports.ProcessingJobService = ProcessingJobService;

package/dist/wrapper/src/services/RetailIdService.d.ts

@@ -0,0 +1,76 @@
+import { MetrcClient as InternalMetrcClient } from '@thunkier/thunkmetrc-client';
+import { MetrcRateLimiter } from '../RateLimiter';
+import { Allotment, CreateAssociateRequestItem, CreateGenerateRequest, CreateMergeRequest, CreatePackagesInfoRequest, Receive, ReceiveQrByShortCode, WriteResponse } from '../models';
+export declare class RetailIdService {
+    private client;
+    private rateLimiter;
+    constructor(client: InternalMetrcClient, rateLimiter: MetrcRateLimiter);
+    /**
+     * Facilitate association of QR codes and Package labels. This will return the count of packages and QR codes associated that were added or replaced.
+     * Permissions Required:
+     * - External Sources(ThirdPartyVendorV2)/Retail ID(Write)
+     * - WebApi Retail ID Read Write State (All or WriteOnly)
+     * - Industry/View Packages
+     * - One of the following: Industry/Facility Type/Can Receive Associate Product Label, Licensee/Receive Associate Product Label or Admin/Employees/Packages Page/Product Labels(Manage)
+     * POST CreateAssociate
+     */
+    createRetailIdAssociate(body: CreateAssociateRequestItem[], licenseNumber?: string): Promise<WriteResponse>;
+    /**
+     * Allows you to generate a specific quantity of QR codes. Id value returned (issuance ID) could be used for printing.
+     * Permissions Required:
+     * - External Sources(ThirdPartyVendorV2)/Retail ID(Write)
+     * - WebApi Retail ID Read Write State (All or WriteOnly)
+     * - Industry/View Packages
+     * - One of the following: Industry/Facility Type/Can Download Product Label, Licensee/Download Product Label or Admin/Employees/Packages Page/Product Labels(Manage)
+     * POST CreateGenerate
+     */
+    createRetailIdGenerate(body: CreateGenerateRequest, licenseNumber?: string): Promise<WriteResponse[]>;
+    /**
+     * Merge and adjust one source to one target Package. First Package detected will be processed as target Package. This requires an action reason with name containing the 'Merge' word and setup with 'Package adjustment' area.
+     * Permissions Required:
+     * - External Sources(ThirdPartyVendorV2)/Retail ID(Write)
+     * - WebApi Retail ID Read Write State (All or WriteOnly)
+     * - Key Value Settings/Retail ID Merge Packages Enabled
+     * POST CreateMerge
+     */
+    createRetailIdMerge(body: CreateMergeRequest, licenseNumber?: string): Promise<WriteResponse>;
+    /**
+     * Retrieves Package information for given list of Package labels.
+     * Permissions Required:
+     * - External Sources(ThirdPartyVendorV2)/Retail ID(Write)
+     * - WebApi Retail ID Read Write State (All or WriteOnly)
+     * - Industry/View Packages
+     * - Admin/Employees/Packages Page/Product Labels(Manage)
+     * POST CreatePackagesInfo
+     */
+    createRetailIdPackagesInfo(body: CreatePackagesInfoRequest, licenseNumber?: string): Promise<WriteResponse[]>;
+    /**
+     * Retrieves the available Retail Item ID quota for a facility.
+     * Permissions Required:
+     * - Download Product Labels
+     * - Manage Product Labels
+     * - Manage Tag Orders
+     * GET GetAllotment
+     */
+    getRetailIdAllotment(body?: any, licenseNumber?: string): Promise<Allotment[]>;
+    /**
+     * Get a list of eaches (Retail ID QR code URL) and sibling tags based on given Package label.
+     * Permissions Required:
+     * - External Sources(ThirdPartyVendorV2)/Manage RetailId
+     * - WebApi Retail ID Read Write State (All or ReadOnly)
+     * - Industry/View Packages
+     * - One of the following: Industry/Facility Type/Can Receive Associate Product Label, Licensee/Receive Associate Product Label or Admin/Employees/Packages Page/Product Labels(View or Manage)
+     * GET GetReceiveByLabel
+     */
+    getRetailIdReceiveByLabel(label: string, body?: any, licenseNumber?: string): Promise<Receive[]>;
+    /**
+     * Get a list of eaches (Retail ID QR code URL) and sibling tags based on given short code value (first segment in Retail ID QR code URL).
+     * Permissions Required:
+     * - External Sources(ThirdPartyVendorV2)/Manage RetailId
+     * - WebApi Retail ID Read Write State (All or ReadOnly)
+     * - Industry/View Packages
+     * - One of the following: Industry/Facility Type/Can Receive Associate Product Label, Licensee/Receive Associate Product Label or Admin/Employees/Packages Page/Product Labels(View or Manage)
+     * GET GetReceiveQrByShortCode
+     */
+    getRetailIdReceiveQrByShortCode(shortCode: string, body?: any, licenseNumber?: string): Promise<ReceiveQrByShortCode[]>;
+}

package/dist/wrapper/src/services/RetailIdService.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RetailIdService = void 0;
+class RetailIdService {
+    constructor(client, rateLimiter) {
+        this.client = client;
+        this.rateLimiter = rateLimiter;
+    }
+    /**
+     * Facilitate association of QR codes and Package labels. This will return the count of packages and QR codes associated that were added or replaced.
+     * Permissions Required:
+     * - External Sources(ThirdPartyVendorV2)/Retail ID(Write)
+     * - WebApi Retail ID Read Write State (All or WriteOnly)
+     * - Industry/View Packages
+     * - One of the following: Industry/Facility Type/Can Receive Associate Product Label, Licensee/Receive Associate Product Label or Admin/Employees/Packages Page/Product Labels(Manage)
+     * POST CreateAssociate
+     */
+    async createRetailIdAssociate(body, licenseNumber) {
+        return this.rateLimiter.execute(null, false, () => this.client.createRetailIdAssociate(body, licenseNumber));
+    }
+    /**
+     * Allows you to generate a specific quantity of QR codes. Id value returned (issuance ID) could be used for printing.
+     * Permissions Required:
+     * - External Sources(ThirdPartyVendorV2)/Retail ID(Write)
+     * - WebApi Retail ID Read Write State (All or WriteOnly)
+     * - Industry/View Packages
+     * - One of the following: Industry/Facility Type/Can Download Product Label, Licensee/Download Product Label or Admin/Employees/Packages Page/Product Labels(Manage)
+     * POST CreateGenerate
+     */
+    async createRetailIdGenerate(body, licenseNumber) {
+        return this.rateLimiter.execute(null, false, () => this.client.createRetailIdGenerate(body, licenseNumber));
+    }
+    /**
+     * Merge and adjust one source to one target Package. First Package detected will be processed as target Package. This requires an action reason with name containing the 'Merge' word and setup with 'Package adjustment' area.
+     * Permissions Required:
+     * - External Sources(ThirdPartyVendorV2)/Retail ID(Write)
+     * - WebApi Retail ID Read Write State (All or WriteOnly)
+     * - Key Value Settings/Retail ID Merge Packages Enabled
+     * POST CreateMerge
+     */
+    async createRetailIdMerge(body, licenseNumber) {
+        return this.rateLimiter.execute(null, false, () => this.client.createRetailIdMerge(body, licenseNumber));
+    }
+    /**
+     * Retrieves Package information for given list of Package labels.
+     * Permissions Required:
+     * - External Sources(ThirdPartyVendorV2)/Retail ID(Write)
+     * - WebApi Retail ID Read Write State (All or WriteOnly)
+     * - Industry/View Packages
+     * - Admin/Employees/Packages Page/Product Labels(Manage)
+     * POST CreatePackagesInfo
+     */
+    async createRetailIdPackagesInfo(body, licenseNumber) {
+        return this.rateLimiter.execute(null, false, () => this.client.createRetailIdPackagesInfo(body, licenseNumber));
+    }
+    /**
+     * Retrieves the available Retail Item ID quota for a facility.
+     * Permissions Required:
+     * - Download Product Labels
+     * - Manage Product Labels
+     * - Manage Tag Orders
+     * GET GetAllotment
+     */
+    async getRetailIdAllotment(body, licenseNumber) {
+        return this.rateLimiter.execute(null, true, () => this.client.getRetailIdAllotment(body, licenseNumber));
+    }
+    /**
+     * Get a list of eaches (Retail ID QR code URL) and sibling tags based on given Package label.
+     * Permissions Required:
+     * - External Sources(ThirdPartyVendorV2)/Manage RetailId
+     * - WebApi Retail ID Read Write State (All or ReadOnly)
+     * - Industry/View Packages
+     * - One of the following: Industry/Facility Type/Can Receive Associate Product Label, Licensee/Receive Associate Product Label or Admin/Employees/Packages Page/Product Labels(View or Manage)
+     * GET GetReceiveByLabel
+     */
+    async getRetailIdReceiveByLabel(label, body, licenseNumber) {
+        return this.rateLimiter.execute(null, true, () => this.client.getRetailIdReceiveByLabel(label, body, licenseNumber));
+    }
+    /**
+     * Get a list of eaches (Retail ID QR code URL) and sibling tags based on given short code value (first segment in Retail ID QR code URL).
+     * Permissions Required:
+     * - External Sources(ThirdPartyVendorV2)/Manage RetailId
+     * - WebApi Retail ID Read Write State (All or ReadOnly)
+     * - Industry/View Packages
+     * - One of the following: Industry/Facility Type/Can Receive Associate Product Label, Licensee/Receive Associate Product Label or Admin/Employees/Packages Page/Product Labels(View or Manage)
+     * GET GetReceiveQrByShortCode
+     */
+    async getRetailIdReceiveQrByShortCode(shortCode, body, licenseNumber) {
+        return this.rateLimiter.execute(null, true, () => this.client.getRetailIdReceiveQrByShortCode(shortCode, body, licenseNumber));
+    }
+}
+exports.RetailIdService = RetailIdService;