@thunkier/thunkmetrc-wrapper 0.2.2 → 0.3.3

package/dist/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;

package/dist/services/SalesService.d.ts

@@ -0,0 +1,287 @@
+import { MetrcClient as InternalMetrcClient } from '@thunkier/thunkmetrc-client';
+import { MetrcRateLimiter } from '../RateLimiter';
+import { PaginatedResponse, ActiveDeliveriesRetailer, ActiveDelivery, ActiveReceipt, County, CreateDeliveriesRequestItem, CreateDeliveriesRetailerDepartRequestItem, CreateDeliveriesRetailerEndRequestItem, CreateDeliveriesRetailerRestockRequestItem, CreateReceiptsRequestItem, CreateSalesDeliveriesRetailerRequestItem, DeliveriesReturnReason, DeliveryRetailer, InactiveDeliveriesRetailer, InactiveDelivery, InactiveReceipt, PatientRegistrationLocation, ReceiptsExternalByExternalNumber, SalesDelivery, UpdateDeliveriesCompleteRequestItem, UpdateDeliveriesHubAcceptRequestItem, UpdateDeliveriesHubDepartRequestItem, UpdateDeliveriesHubRequestItem, UpdateDeliveriesHubVerifyIDRequestItem, UpdateDeliveriesRequestItem, UpdateDeliveriesRetailerRequestItem, UpdateReceiptsFinalizeRequestItem, UpdateReceiptsRequestItem, UpdateReceiptsUnfinalizeRequestItem, WriteResponse } from '../models';
+export declare class SalesService {
+    private client;
+    private rateLimiter;
+    constructor(client: InternalMetrcClient, rateLimiter: MetrcRateLimiter);
+    /**
+     * Records new sales delivery entries for a given License Number. Please note: The SalesDateTime field must be the actual date and time of the transaction without the time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be in Pacific Standard (or Daylight Savings) Time and not in UTC.
+     * Permissions Required:
+     * - External Sources(ThirdPartyVendorV2)/Sales Deliveries(Write)
+     * - Industry/Facility Type/Consumer Sales Delivery or Industry/Facility Type/Patient Sales Delivery
+     * - WebApi Sales Deliveries Read Write State (All or WriteOnly)
+     * - WebApi Retail ID Read Write State (All or WriteOnly) - Required for RID only.
+     * - External Sources(ThirdPartyVendorV2)/Retail ID(Write) - Required for RID only.
+     * POST CreateDeliveries
+     */
+    createSalesDeliveries(body: CreateDeliveriesRequestItem[], licenseNumber?: string): Promise<WriteResponse>;
+    /**
+     * Processes the departure of retailer deliveries for a Facility using the provided License Number and delivery data.
+     * Permissions Required:
+     * - External Sources(ThirdPartyVendorV2)/Sales Deliveries(Write)
+     * - Industry/Facility Type/Retailer Delivery
+     * - Industry/Facility Type/Consumer Sales Delivery or Industry/Facility Type/Patient Sales Delivery
+     * - WebApi Sales Deliveries Read Write State (All or WriteOnly)
+     * - Manage Retailer Delivery
+     * POST CreateDeliveriesRetailerDepart
+     */
+    createSalesDeliveriesRetailerDepart(body: CreateDeliveriesRetailerDepartRequestItem[], licenseNumber?: string): Promise<WriteResponse>;
+    /**
+     * Ends retailer delivery records for a given License Number. Please note: The ActualArrivalDateTime field must be the actual date and time of the transaction without the time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be in Pacific Standard (or Daylight Savings) Time and not in UTC.
+     * Permissions Required:
+     * - External Sources(ThirdPartyVendorV2)/Sales Deliveries(Write)
+     * - Industry/Facility Type/Retailer Delivery
+     * - Industry/Facility Type/Consumer Sales Delivery or Industry/Facility Type/Patient Sales Delivery
+     * - WebApi Sales Deliveries Read Write State (All or WriteOnly)
+     * - Manage Retailer Delivery
+     * POST CreateDeliveriesRetailerEnd
+     */
+    createSalesDeliveriesRetailerEnd(body: CreateDeliveriesRetailerEndRequestItem[], licenseNumber?: string): Promise<WriteResponse>;
+    /**
+     * Records restock deliveries for retailer facilities using the provided License Number. Please note: The DateTime field must be the actual date and time of the transaction without the time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be in Pacific Standard (or Daylight Savings) Time and not in UTC.
+     * Permissions Required:
+     * - External Sources(ThirdPartyVendorV2)/Sales Deliveries(Write)
+     * - Industry/Facility Type/Retailer Delivery
+     * - Industry/Facility Type/Consumer Sales Delivery or Industry/Facility Type/Patient Sales Delivery
+     * - WebApi Sales Deliveries Read Write State (All or WriteOnly)
+     * - Manage Retailer Delivery
+     * POST CreateDeliveriesRetailerRestock
+     */
+    createSalesDeliveriesRetailerRestock(body: CreateDeliveriesRetailerRestockRequestItem[], licenseNumber?: string): Promise<WriteResponse>;
+    /**
+     * Records a list of sales deliveries for a given License Number. Please note: The SalesDateTime field must be the actual date and time of the transaction without the time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be in Pacific Standard (or Daylight Savings) Time and not in UTC.
+     * Permissions Required:
+     * - External Sources(ThirdPartyVendorV2)/Sales (Write)
+     * - Industry/Facility Type/Consumer Sales or Industry/Facility Type/Patient Sales or Industry/Facility Type/External Patient Sales or Industry/Facility Type/Caregiver Sales
+     * - Industry/Facility Type/Advanced Sales
+     * - WebApi Sales Read Write State (All or WriteOnly)
+     * - WebApi Retail ID Read Write State (All or WriteOnly) - Required for RID only.
+     * - External Sources(ThirdPartyVendorV2)/Retail ID(Write) - Required for RID only.
+     * POST CreateReceipts
+     */
+    createSalesReceipts(body: CreateReceiptsRequestItem[], licenseNumber?: string): Promise<WriteResponse>;
+    /**
+     * Records sales deliveries originating from a retailer delivery for a given License Number. Please note: The SalesDateTime field must be the actual date and time of the transaction without the time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be in Pacific Standard (or Daylight Savings) Time and not in UTC.
+     * Permissions Required:
+     * - External Sources(ThirdPartyVendorV2)/Sales Deliveries(Write)
+     * - Industry/Facility Type/Retailer Delivery
+     * - Industry/Facility Type/Consumer Sales Delivery or Industry/Facility Type/Patient Sales Delivery
+     * - WebApi Sales Deliveries Read Write State (All or WriteOnly)
+     * - WebApi Retail ID Read Write State (All or WriteOnly) - Required for RID only.
+     * - External Sources(ThirdPartyVendorV2)/Retail ID(Write) - Required for RID only.
+     * POST CreateSalesDeliveriesRetailer
+     */
+    createSalesDeliveriesRetailer(body: CreateSalesDeliveriesRetailerRequestItem[], licenseNumber?: string): Promise<WriteResponse>;
+    /**
+     * Voids a sales delivery for a Facility using the provided License Number and delivery Id.
+     * Permissions Required:
+     * - Manage Sales Delivery
+     * DELETE DeleteDeliveryById
+     */
+    deleteSalesDeliveryById(id: string, body?: any, licenseNumber?: string): Promise<any>;
+    /**
+     * Voids a retailer delivery for a Facility using the provided License Number and delivery Id.
+     * Permissions Required:
+     * - External Sources(ThirdPartyVendorV2)/Sales Deliveries(Write)
+     * - Industry/Facility Type/Retailer Delivery
+     * - Industry/Facility Type/Consumer Sales Delivery or Industry/Facility Type/Patient Sales Delivery
+     * - WebApi Sales Deliveries Read Write State (All or WriteOnly)
+     * - Manage Retailer Delivery
+     * DELETE DeleteDeliveryRetailerById
+     */
+    deleteSalesDeliveryRetailerById(id: string, body?: any, licenseNumber?: string): Promise<any>;
+    /**
+     * Archives a sales receipt for a Facility using the provided License Number and receipt Id.
+     * Permissions Required:
+     * - Manage Sales
+     * DELETE DeleteReceiptById
+     */
+    deleteSalesReceiptById(id: string, body?: any, licenseNumber?: string): Promise<any>;
+    /**
+     * Returns a list of active sales deliveries for a Facility, filtered by optional sales or last modified date ranges.
+     * Permissions Required:
+     * - View Sales Delivery
+     * - Manage Sales Delivery
+     * GET GetActiveDeliveries
+     */
+    getSalesActiveDeliveries(body?: any, lastModifiedEnd?: string, lastModifiedStart?: string, licenseNumber?: string, pageNumber?: number, pageSize?: string): Promise<PaginatedResponse<ActiveDelivery>>;
+    /**
+     * Returns a list of active retailer deliveries for a Facility, optionally filtered by last modified date range
+     * Permissions Required:
+     * - View Retailer Delivery
+     * - Manage Retailer Delivery
+     * GET GetActiveDeliveriesRetailer
+     */
+    getSalesActiveDeliveriesRetailer(body?: any, lastModifiedEnd?: string, lastModifiedStart?: string, licenseNumber?: string, pageNumber?: number, pageSize?: string): Promise<PaginatedResponse<ActiveDeliveriesRetailer>>;
+    /**
+     * Returns a list of active sales receipts for a Facility, filtered by optional sales or last modified date ranges.
+     * Permissions Required:
+     * - View Sales
+     * - Manage Sales
+     * GET GetActiveReceipts
+     */
+    getSalesActiveReceipts(body?: any, lastModifiedEnd?: string, lastModifiedStart?: string, licenseNumber?: string, pageNumber?: number, pageSize?: string): Promise<PaginatedResponse<ActiveReceipt>>;
+    /**
+     * Returns a list of counties available for sales deliveries.
+     * GET GetCounties
+     */
+    getSalesCounties(body?: any): Promise<PaginatedResponse<County>>;
+    /**
+     * Returns a list of customer types.
+     * GET GetCustomerTypes
+     */
+    getSalesCustomerTypes(body?: any): Promise<any>;
+    /**
+     * Returns a list of return reasons for sales deliveries based on the provided License Number.
+     * Permissions Required:
+     * - Sales Delivery
+     * GET GetDeliveriesReturnReasons
+     */
+    getSalesDeliveriesReturnReasons(body?: any, licenseNumber?: string, pageNumber?: number, pageSize?: string): Promise<PaginatedResponse<DeliveriesReturnReason>>;
+    /**
+     * Retrieves a retailer delivery record by its ID, with an optional License Number.
+     * Permissions Required:
+     * - View Retailer Delivery
+     * - Manage Retailer Delivery
+     * GET GetDeliveryRetailerById
+     */
+    getSalesDeliveryRetailerById(id: string, body?: any, licenseNumber?: string): Promise<DeliveryRetailer>;
+    /**
+     * Returns a list of inactive sales deliveries for a Facility, filtered by optional sales or last modified date ranges.
+     * Permissions Required:
+     * - View Sales Delivery
+     * - Manage Sales Delivery
+     * GET GetInactiveDeliveries
+     */
+    getSalesInactiveDeliveries(body?: any, lastModifiedEnd?: string, lastModifiedStart?: string, licenseNumber?: string, pageNumber?: number, pageSize?: string): Promise<PaginatedResponse<InactiveDelivery>>;
+    /**
+     * Returns a list of inactive retailer deliveries for a Facility, optionally filtered by last modified date range
+     * Permissions Required:
+     * - View Retailer Delivery
+     * - Manage Retailer Delivery
+     * GET GetInactiveDeliveriesRetailer
+     */
+    getSalesInactiveDeliveriesRetailer(body?: any, lastModifiedEnd?: string, lastModifiedStart?: string, licenseNumber?: string, pageNumber?: number, pageSize?: string): Promise<PaginatedResponse<InactiveDeliveriesRetailer>>;
+    /**
+     * Returns a list of inactive sales receipts for a Facility, filtered by optional sales or last modified date ranges.
+     * Permissions Required:
+     * - View Sales
+     * - Manage Sales
+     * GET GetInactiveReceipts
+     */
+    getSalesInactiveReceipts(body?: any, lastModifiedEnd?: string, lastModifiedStart?: string, licenseNumber?: string, pageNumber?: number, pageSize?: string): Promise<PaginatedResponse<InactiveReceipt>>;
+    /**
+     * Returns a list of valid Patient registration locations for sales.
+     * GET GetPatientRegistrationLocations
+     */
+    getSalesPatientRegistrationLocations(body?: any): Promise<PatientRegistrationLocation[]>;
+    /**
+     * Returns a list of available payment types for the specified License Number.
+     * Permissions Required:
+     * - View Sales Delivery
+     * - Manage Sales Delivery
+     * GET GetPaymentTypes
+     */
+    getSalesPaymentTypes(body?: any, licenseNumber?: string): Promise<any>;
+    /**
+     * Retrieves a sales receipt by its Id, with an optional License Number.
+     * Permissions Required:
+     * - View Sales
+     * - Manage Sales
+     * GET GetReceiptById
+     */
+    getSalesReceiptById(id: string, body?: any, licenseNumber?: string): Promise<ActiveReceipt>;
+    /**
+     * Retrieves a Sales Receipt by its external number, with an optional License Number.
+     * Permissions Required:
+     * - View Sales
+     * - Manage Sales
+     * GET GetReceiptsExternalByExternalNumber
+     */
+    getSalesReceiptsExternalByExternalNumber(externalNumber: string, body?: any, licenseNumber?: string): Promise<ReceiptsExternalByExternalNumber[]>;
+    /**
+     * Retrieves a sales delivery record by its Id, with an optional License Number.
+     * Permissions Required:
+     * - View Sales Delivery
+     * - Manage Sales Delivery
+     * GET GetSalesDeliveryById
+     */
+    getSalesDeliveryById(id: string, body?: any, licenseNumber?: string): Promise<SalesDelivery>;
+    /**
+     * Updates sales delivery records for a given License Number. Please note: The SalesDateTime field must be the actual date and time of the transaction without the time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be in Pacific Standard (or Daylight Savings) Time and not in UTC.
+     * Permissions Required:
+     * - Manage Sales Delivery
+     * PUT UpdateDeliveries
+     */
+    updateSalesDeliveries(body: UpdateDeliveriesRequestItem[], licenseNumber?: string): Promise<WriteResponse>;
+    /**
+     * Completes a list of sales deliveries for a Facility using the provided License Number and delivery data.
+     * Permissions Required:
+     * - Manage Sales Delivery
+     * PUT UpdateDeliveriesComplete
+     */
+    updateSalesDeliveriesComplete(body: UpdateDeliveriesCompleteRequestItem[], licenseNumber?: string): Promise<WriteResponse>;
+    /**
+     * Updates hub transporter details for a given License Number. Please note: The SalesDateTime field must be the actual date and time of the transaction without the time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be in Pacific Standard (or Daylight Savings) Time and not in UTC.
+     * Permissions Required:
+     * - Manage Sales Delivery, Manage Sales Delivery Hub
+     * PUT UpdateDeliveriesHub
+     */
+    updateSalesDeliveriesHub(body: UpdateDeliveriesHubRequestItem[], licenseNumber?: string): Promise<WriteResponse>;
+    /**
+     * Accepts a list of hub sales deliveries for a Facility based on the provided License Number and delivery data.
+     * Permissions Required:
+     * - Manage Sales Delivery Hub
+     * PUT UpdateDeliveriesHubAccept
+     */
+    updateSalesDeliveriesHubAccept(body: UpdateDeliveriesHubAcceptRequestItem[], licenseNumber?: string): Promise<WriteResponse>;
+    /**
+     * Processes the departure of hub sales deliveries for a Facility using the provided License Number and delivery data.
+     * Permissions Required:
+     * - Manage Sales Delivery Hub
+     * PUT UpdateDeliveriesHubDepart
+     */
+    updateSalesDeliveriesHubDepart(body: UpdateDeliveriesHubDepartRequestItem[], licenseNumber?: string): Promise<WriteResponse>;
+    /**
+     * Verifies identification for a list of hub sales deliveries using the provided License Number and delivery data.
+     * Permissions Required:
+     * - Manage Sales Delivery Hub
+     * PUT UpdateDeliveriesHubVerifyID
+     */
+    updateSalesDeliveriesHubVerifyID(body: UpdateDeliveriesHubVerifyIDRequestItem[], licenseNumber?: string): Promise<WriteResponse>;
+    /**
+     * Updates retailer delivery records for a given License Number. Please note: The DateTime field must be the actual date and time of the transaction without the time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be in Pacific Standard (or Daylight Savings) Time and not in UTC.
+     * Permissions Required:
+     * - External Sources(ThirdPartyVendorV2)/Sales Deliveries(Write)
+     * - Industry/Facility Type/Retailer Delivery
+     * - Industry/Facility Type/Consumer Sales Delivery or Industry/Facility Type/Patient Sales Delivery
+     * - WebApi Sales Deliveries Read Write State (All or WriteOnly)
+     * - WebApi Retail ID Read Write State (All or WriteOnly) - Required for RID only.
+     * - External Sources(ThirdPartyVendorV2)/Retail ID(Write) - Required for RID only.
+     * - Manage Retailer Delivery
+     * PUT UpdateDeliveriesRetailer
+     */
+    updateSalesDeliveriesRetailer(body: UpdateDeliveriesRetailerRequestItem[], licenseNumber?: string): Promise<WriteResponse>;
+    /**
+     * Updates sales receipt records for a given License Number. Please note: The SalesDateTime field must be the actual date and time of the transaction without the time zone. This date/time must already be in the same time zone as the Facility recording the sales. For example, if the Facility is in Pacific Time, then this time must be in Pacific Standard (or Daylight Savings) Time and not in UTC.
+     * Permissions Required:
+     * - Manage Sales
+     * PUT UpdateReceipts
+     */
+    updateSalesReceipts(body: UpdateReceiptsRequestItem[], licenseNumber?: string): Promise<WriteResponse>;
+    /**
+     * Finalizes a list of sales receipts for a Facility using the provided License Number and receipt data.
+     * Permissions Required:
+     * - Manage Sales
+     * PUT UpdateReceiptsFinalize
+     */
+    updateSalesReceiptsFinalize(body: UpdateReceiptsFinalizeRequestItem[], licenseNumber?: string): Promise<WriteResponse>;
+    /**
+     * Unfinalizes a list of sales receipts for a Facility using the provided License Number and receipt data.
+     * Permissions Required:
+     * - Manage Sales
+     * PUT UpdateReceiptsUnfinalize
+     */
+    updateSalesReceiptsUnfinalize(body: UpdateReceiptsUnfinalizeRequestItem[], licenseNumber?: string): Promise<WriteResponse>;
+}