ultracart_rest_api_v2_typescript 3.10.7 → 3.10.8

package/README.md

@@ -1,4 +1,4 @@
-## ultracart_rest_api_v2_typescript@3.10.7
+## ultracart_rest_api_v2_typescript@3.10.8
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install ultracart_rest_api_v2_typescript@3.10.7 --save
+npm install ultracart_rest_api_v2_typescript@3.10.8 --save
 ```
 
 _unPublished (not recommended):_
@@ -54,6 +54,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.8 | 05/27/2022 | customer store credit |
 | 3.10.7 | 05/23/2022 | add internal gift cert to order summary, addl provider info for storefront comm |
 | 3.10.6 | 05/23/2022 | add internal gift cert to order summary, addl provider info for storefront comm |
 | 3.10.5 | 05/20/2022 | dependabot on java gson version |

package/api.ts

@@ -9123,6 +9123,12 @@ export interface CustomerEditorValues {
      * @memberof CustomerEditorValues
      */
     countries?: Array<Country>;
+    /**
+     * loyalty_program_type
+     * @type {string}
+     * @memberof CustomerEditorValues
+     */
+    loyalty_program_type?: string;
     /**
      * qb_classes
      * @type {Array<string>}
@@ -10017,6 +10023,170 @@ export interface CustomerSoftwareEntitlement {
     software_sku?: string;
 }
 
+/**
+ * 
+ * @export
+ * @interface CustomerStoreCredit
+ */
+export interface CustomerStoreCredit {
+    /**
+     * 
+     * @type {number}
+     * @memberof CustomerStoreCredit
+     */
+    available?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CustomerStoreCredit
+     */
+    expiring?: number;
+    /**
+     * 
+     * @type {Array<CustomerStoreCreditLedgerEntry>}
+     * @memberof CustomerStoreCredit
+     */
+    futureLedgers?: Array<CustomerStoreCreditLedgerEntry>;
+    /**
+     * 
+     * @type {Array<CustomerStoreCreditLedgerEntry>}
+     * @memberof CustomerStoreCredit
+     */
+    pastLedgers?: Array<CustomerStoreCreditLedgerEntry>;
+    /**
+     * 
+     * @type {number}
+     * @memberof CustomerStoreCredit
+     */
+    total?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof CustomerStoreCredit
+     */
+    vesting?: number;
+}
+
+/**
+ * 
+ * @export
+ * @interface CustomerStoreCreditAddRequest
+ */
+export interface CustomerStoreCreditAddRequest {
+    /**
+     * Amount of store credit
+     * @type {number}
+     * @memberof CustomerStoreCreditAddRequest
+     */
+    amount?: number;
+    /**
+     * Description or reason for the store credit
+     * @type {string}
+     * @memberof CustomerStoreCreditAddRequest
+     */
+    description?: string;
+    /**
+     * Optional days for store credit to expire or zero for no expiration
+     * @type {number}
+     * @memberof CustomerStoreCreditAddRequest
+     */
+    expiration_days?: number;
+    /**
+     * Optional days for store credit to vesting or zero for immediately available
+     * @type {number}
+     * @memberof CustomerStoreCreditAddRequest
+     */
+    vesting_days?: number;
+}
+
+/**
+ * 
+ * @export
+ * @interface CustomerStoreCreditLedgerEntry
+ */
+export interface CustomerStoreCreditLedgerEntry {
+    /**
+     * Identifies the state of this ledger entry whether the entry is Vesting or Expiring
+     * @type {string}
+     * @memberof CustomerStoreCreditLedgerEntry
+     */
+    action?: string;
+    /**
+     * The amount of the activity.
+     * @type {number}
+     * @memberof CustomerStoreCreditLedgerEntry
+     */
+    amount?: number;
+    /**
+     * Description of what this ledger entry is used.
+     * @type {string}
+     * @memberof CustomerStoreCreditLedgerEntry
+     */
+    description?: string;
+    /**
+     * Date time of this ledger activity.
+     * @type {string}
+     * @memberof CustomerStoreCreditLedgerEntry
+     */
+    entry_dts?: string;
+    /**
+     * Gift certificate ledger oid is a primary key for this object, used internally.
+     * @type {number}
+     * @memberof CustomerStoreCreditLedgerEntry
+     */
+    gift_certificate_ledger_oid?: number;
+    /**
+     * Gift certificate oid.
+     * @type {number}
+     * @memberof CustomerStoreCreditLedgerEntry
+     */
+    gift_certificate_oid?: number;
+    /**
+     * The order id if this gift certificate was used as part of the payment.
+     * @type {string}
+     * @memberof CustomerStoreCreditLedgerEntry
+     */
+    reference_order_id?: string;
+}
+
+/**
+ * 
+ * @export
+ * @interface CustomerStoreCreditResponse
+ */
+export interface CustomerStoreCreditResponse {
+    /**
+     * 
+     * @type {CustomerStoreCredit}
+     * @memberof CustomerStoreCreditResponse
+     */
+    customer_store_credit?: CustomerStoreCredit;
+    /**
+     * 
+     * @type {ModelError}
+     * @memberof CustomerStoreCreditResponse
+     */
+    error?: ModelError;
+    /**
+     * 
+     * @type {ResponseMetadata}
+     * @memberof CustomerStoreCreditResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof CustomerStoreCreditResponse
+     */
+    success?: boolean;
+    /**
+     * 
+     * @type {Warning}
+     * @memberof CustomerStoreCreditResponse
+     */
+    warning?: Warning;
+}
+
 /**
  * 
  * @export
@@ -44443,6 +44613,67 @@ export class CouponApi extends BaseAPI implements CouponApiInterface {
  */
 export const CustomerApiFetchParamCreator = function (configuration?: Configuration) {
     return {
+        /**
+         * Adds store credit to a customer 
+         * @summary Adds store credit to a customer
+         * @param {number} customer_profile_oid The customer oid to credit.
+         * @param {CustomerStoreCreditAddRequest} store_credit_request Store credit to add
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        addCustomerStoreCredit(customer_profile_oid: number, store_credit_request: CustomerStoreCreditAddRequest, options: any = {}): FetchArgs {
+            // verify required parameter 'customer_profile_oid' is not null or undefined
+            if (customer_profile_oid === null || customer_profile_oid === undefined) {
+                throw new RequiredError('customer_profile_oid','Required parameter customer_profile_oid was null or undefined when calling addCustomerStoreCredit.');
+            }
+            // verify required parameter 'store_credit_request' is not null or undefined
+            if (store_credit_request === null || store_credit_request === undefined) {
+                throw new RequiredError('store_credit_request','Required parameter store_credit_request was null or undefined when calling addCustomerStoreCredit.');
+            }
+            const localVarPath = `/customer/customers/{customer_profile_oid}/store_credit`
+                .replace(`{${"customer_profile_oid"}}`, encodeURIComponent(String(customer_profile_oid)));
+            const localVarUrlObj = url.parse(localVarPath, true);
+            const localVarRequestOptions = Object.assign({ method: 'POST' }, options);
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+    if(configuration && configuration.apiVersion) {
+      localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
+    }
+
+
+
+            // authentication ultraCartOauth required
+            // oauth required
+            if (configuration && configuration.accessToken) {
+				const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+					? configuration.accessToken("ultraCartOauth", ["customer_write"])
+					: configuration.accessToken;
+                localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
+            }
+
+            // authentication ultraCartSimpleApiKey required
+            if (configuration && configuration.apiKey) {
+                const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+					? configuration.apiKey("x-ultracart-simple-key")
+					: configuration.apiKey;
+                localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
+            }
+
+            localVarHeaderParameter['Content-Type'] = 'application/json; charset=UTF-8';
+
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+            const needsSerialization = (<any>"CustomerStoreCreditAddRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
+            localVarRequestOptions.body =  needsSerialization ? JSON.stringify(store_credit_request || {}) : (store_credit_request || "");
+
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed. 
          * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
@@ -44735,6 +44966,58 @@ export const CustomerApiFetchParamCreator = function (configuration?: Configurat
 
 
 
+            // authentication ultraCartOauth required
+            // oauth required
+            if (configuration && configuration.accessToken) {
+				const localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+					? configuration.accessToken("ultraCartOauth", ["customer_read"])
+					: configuration.accessToken;
+                localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
+            }
+
+            // authentication ultraCartSimpleApiKey required
+            if (configuration && configuration.apiKey) {
+                const localVarApiKeyValue = typeof configuration.apiKey === 'function'
+					? configuration.apiKey("x-ultracart-simple-key")
+					: configuration.apiKey;
+                localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
+            }
+
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Retrieve the customer store credit accumulated through loyalty programs 
+         * @summary Retrieve the customer store credit accumulated through loyalty programs
+         * @param {number} customer_profile_oid The customer oid to retrieve.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCustomerStoreCredit(customer_profile_oid: number, options: any = {}): FetchArgs {
+            // verify required parameter 'customer_profile_oid' is not null or undefined
+            if (customer_profile_oid === null || customer_profile_oid === undefined) {
+                throw new RequiredError('customer_profile_oid','Required parameter customer_profile_oid was null or undefined when calling getCustomerStoreCredit.');
+            }
+            const localVarPath = `/customer/customers/{customer_profile_oid}/store_credit`
+                .replace(`{${"customer_profile_oid"}}`, encodeURIComponent(String(customer_profile_oid)));
+            const localVarUrlObj = url.parse(localVarPath, true);
+            const localVarRequestOptions = Object.assign({ method: 'GET' }, options);
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+    if(configuration && configuration.apiVersion) {
+      localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
+    }
+
+
+
             // authentication ultraCartOauth required
             // oauth required
             if (configuration && configuration.accessToken) {
@@ -45405,6 +45688,28 @@ export const CustomerApiFetchParamCreator = function (configuration?: Configurat
  */
 export const CustomerApiFp = function(configuration?: Configuration) {
     return {
+        /**
+         * Adds store credit to a customer 
+         * @summary Adds store credit to a customer
+         * @param {number} customer_profile_oid The customer oid to credit.
+         * @param {CustomerStoreCreditAddRequest} store_credit_request Store credit to add
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        addCustomerStoreCredit(customer_profile_oid: number, store_credit_request: CustomerStoreCreditAddRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<BaseResponse> {
+            const localVarFetchArgs = CustomerApiFetchParamCreator(configuration).addCustomerStoreCredit(customer_profile_oid, store_credit_request, options);
+            return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
+
+                    if (response.status >= 200 && response.status < 300) {
+                      return response.json();
+                      
+                    } else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed. 
          * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
@@ -45532,6 +45837,27 @@ export const CustomerApiFp = function(configuration?: Configuration) {
                 });
             };
         },
+        /**
+         * Retrieve the customer store credit accumulated through loyalty programs 
+         * @summary Retrieve the customer store credit accumulated through loyalty programs
+         * @param {number} customer_profile_oid The customer oid to retrieve.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCustomerStoreCredit(customer_profile_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<CustomerStoreCreditResponse> {
+            const localVarFetchArgs = CustomerApiFetchParamCreator(configuration).getCustomerStoreCredit(customer_profile_oid, options);
+            return (fetch: FetchAPI = portableFetch, basePath: string = BASE_PATH) => {
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then((response) => {
+
+                    if (response.status >= 200 && response.status < 300) {
+                      return response.json();
+                      
+                    } else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * Retrieves customers from the account.  If no parameters are specified, all customers will be returned.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
          * @summary Retrieve customers
@@ -45749,6 +46075,17 @@ export const CustomerApiFp = function(configuration?: Configuration) {
  */
 export const CustomerApiFactory = function (configuration?: Configuration, fetch?: FetchAPI, basePath?: string) {
     return {
+        /**
+         * Adds store credit to a customer 
+         * @summary Adds store credit to a customer
+         * @param {number} customer_profile_oid The customer oid to credit.
+         * @param {CustomerStoreCreditAddRequest} store_credit_request Store credit to add
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        addCustomerStoreCredit(customer_profile_oid: number, store_credit_request: CustomerStoreCreditAddRequest, options?: any) {
+            return CustomerApiFp(configuration).addCustomerStoreCredit(customer_profile_oid, store_credit_request, options)(fetch, basePath);
+        },
         /**
          * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed. 
          * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
@@ -45810,6 +46147,16 @@ export const CustomerApiFactory = function (configuration?: Configuration, fetch
         getCustomerEmailLists(options?: any) {
             return CustomerApiFp(configuration).getCustomerEmailLists(options)(fetch, basePath);
         },
+        /**
+         * Retrieve the customer store credit accumulated through loyalty programs 
+         * @summary Retrieve the customer store credit accumulated through loyalty programs
+         * @param {number} customer_profile_oid The customer oid to retrieve.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCustomerStoreCredit(customer_profile_oid: number, options?: any) {
+            return CustomerApiFp(configuration).getCustomerStoreCredit(customer_profile_oid, options)(fetch, basePath);
+        },
         /**
          * Retrieves customers from the account.  If no parameters are specified, all customers will be returned.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
          * @summary Retrieve customers
@@ -45939,6 +46286,17 @@ export const CustomerApiFactory = function (configuration?: Configuration, fetch
  * @interface CustomerApi
  */
 export interface CustomerApiInterface {
+    /**
+     * Adds store credit to a customer 
+     * @summary Adds store credit to a customer
+     * @param {number} customer_profile_oid The customer oid to credit.
+     * @param {CustomerStoreCreditAddRequest} store_credit_request Store credit to add
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApiInterface
+     */
+    addCustomerStoreCredit(customer_profile_oid: number, store_credit_request: CustomerStoreCreditAddRequest, options?: any): Promise<BaseResponse>;
+
     /**
      * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed. 
      * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
@@ -46000,6 +46358,16 @@ export interface CustomerApiInterface {
      */
     getCustomerEmailLists(options?: any): Promise<EmailListsResponse>;
 
+    /**
+     * Retrieve the customer store credit accumulated through loyalty programs 
+     * @summary Retrieve the customer store credit accumulated through loyalty programs
+     * @param {number} customer_profile_oid The customer oid to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApiInterface
+     */
+    getCustomerStoreCredit(customer_profile_oid: number, options?: any): Promise<CustomerStoreCreditResponse>;
+
     /**
      * Retrieves customers from the account.  If no parameters are specified, all customers will be returned.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
      * @summary Retrieve customers
@@ -46129,6 +46497,19 @@ export interface CustomerApiInterface {
  * @extends {BaseAPI}
  */
 export class CustomerApi extends BaseAPI implements CustomerApiInterface {
+    /**
+     * Adds store credit to a customer 
+     * @summary Adds store credit to a customer
+     * @param {number} customer_profile_oid The customer oid to credit.
+     * @param {CustomerStoreCreditAddRequest} store_credit_request Store credit to add
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    public addCustomerStoreCredit(customer_profile_oid: number, store_credit_request: CustomerStoreCreditAddRequest, options?: any) {
+        return CustomerApiFp(this.configuration).addCustomerStoreCredit(customer_profile_oid, store_credit_request, options)(this.fetch, this.basePath);
+    }
+
     /**
      * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed. 
      * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
@@ -46202,6 +46583,18 @@ export class CustomerApi extends BaseAPI implements CustomerApiInterface {
         return CustomerApiFp(this.configuration).getCustomerEmailLists(options)(this.fetch, this.basePath);
     }
 
+    /**
+     * Retrieve the customer store credit accumulated through loyalty programs 
+     * @summary Retrieve the customer store credit accumulated through loyalty programs
+     * @param {number} customer_profile_oid The customer oid to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    public getCustomerStoreCredit(customer_profile_oid: number, options?: any) {
+        return CustomerApiFp(this.configuration).getCustomerStoreCredit(customer_profile_oid, options)(this.fetch, this.basePath);
+    }
+
     /**
      * Retrieves customers from the account.  If no parameters are specified, all customers will be returned.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. 
      * @summary Retrieve customers

package/dist/api.d.ts

@@ -8906,6 +8906,12 @@ export interface CustomerEditorValues {
      * @memberof CustomerEditorValues
      */
     countries?: Array<Country>;
+    /**
+     * loyalty_program_type
+     * @type {string}
+     * @memberof CustomerEditorValues
+     */
+    loyalty_program_type?: string;
     /**
      * qb_classes
      * @type {Array<string>}
@@ -9785,6 +9791,166 @@ export interface CustomerSoftwareEntitlement {
      */
     software_sku?: string;
 }
+/**
+ *
+ * @export
+ * @interface CustomerStoreCredit
+ */
+export interface CustomerStoreCredit {
+    /**
+     *
+     * @type {number}
+     * @memberof CustomerStoreCredit
+     */
+    available?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CustomerStoreCredit
+     */
+    expiring?: number;
+    /**
+     *
+     * @type {Array<CustomerStoreCreditLedgerEntry>}
+     * @memberof CustomerStoreCredit
+     */
+    futureLedgers?: Array<CustomerStoreCreditLedgerEntry>;
+    /**
+     *
+     * @type {Array<CustomerStoreCreditLedgerEntry>}
+     * @memberof CustomerStoreCredit
+     */
+    pastLedgers?: Array<CustomerStoreCreditLedgerEntry>;
+    /**
+     *
+     * @type {number}
+     * @memberof CustomerStoreCredit
+     */
+    total?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CustomerStoreCredit
+     */
+    vesting?: number;
+}
+/**
+ *
+ * @export
+ * @interface CustomerStoreCreditAddRequest
+ */
+export interface CustomerStoreCreditAddRequest {
+    /**
+     * Amount of store credit
+     * @type {number}
+     * @memberof CustomerStoreCreditAddRequest
+     */
+    amount?: number;
+    /**
+     * Description or reason for the store credit
+     * @type {string}
+     * @memberof CustomerStoreCreditAddRequest
+     */
+    description?: string;
+    /**
+     * Optional days for store credit to expire or zero for no expiration
+     * @type {number}
+     * @memberof CustomerStoreCreditAddRequest
+     */
+    expiration_days?: number;
+    /**
+     * Optional days for store credit to vesting or zero for immediately available
+     * @type {number}
+     * @memberof CustomerStoreCreditAddRequest
+     */
+    vesting_days?: number;
+}
+/**
+ *
+ * @export
+ * @interface CustomerStoreCreditLedgerEntry
+ */
+export interface CustomerStoreCreditLedgerEntry {
+    /**
+     * Identifies the state of this ledger entry whether the entry is Vesting or Expiring
+     * @type {string}
+     * @memberof CustomerStoreCreditLedgerEntry
+     */
+    action?: string;
+    /**
+     * The amount of the activity.
+     * @type {number}
+     * @memberof CustomerStoreCreditLedgerEntry
+     */
+    amount?: number;
+    /**
+     * Description of what this ledger entry is used.
+     * @type {string}
+     * @memberof CustomerStoreCreditLedgerEntry
+     */
+    description?: string;
+    /**
+     * Date time of this ledger activity.
+     * @type {string}
+     * @memberof CustomerStoreCreditLedgerEntry
+     */
+    entry_dts?: string;
+    /**
+     * Gift certificate ledger oid is a primary key for this object, used internally.
+     * @type {number}
+     * @memberof CustomerStoreCreditLedgerEntry
+     */
+    gift_certificate_ledger_oid?: number;
+    /**
+     * Gift certificate oid.
+     * @type {number}
+     * @memberof CustomerStoreCreditLedgerEntry
+     */
+    gift_certificate_oid?: number;
+    /**
+     * The order id if this gift certificate was used as part of the payment.
+     * @type {string}
+     * @memberof CustomerStoreCreditLedgerEntry
+     */
+    reference_order_id?: string;
+}
+/**
+ *
+ * @export
+ * @interface CustomerStoreCreditResponse
+ */
+export interface CustomerStoreCreditResponse {
+    /**
+     *
+     * @type {CustomerStoreCredit}
+     * @memberof CustomerStoreCreditResponse
+     */
+    customer_store_credit?: CustomerStoreCredit;
+    /**
+     *
+     * @type {ModelError}
+     * @memberof CustomerStoreCreditResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof CustomerStoreCreditResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Indicates if API call was successful
+     * @type {boolean}
+     * @memberof CustomerStoreCreditResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof CustomerStoreCreditResponse
+     */
+    warning?: Warning;
+}
 /**
  *
  * @export
@@ -38475,6 +38641,15 @@ export declare class CouponApi extends BaseAPI implements CouponApiInterface {
  * @export
  */
 export declare const CustomerApiFetchParamCreator: (configuration?: Configuration) => {
+    /**
+     * Adds store credit to a customer
+     * @summary Adds store credit to a customer
+     * @param {number} customer_profile_oid The customer oid to credit.
+     * @param {CustomerStoreCreditAddRequest} store_credit_request Store credit to add
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addCustomerStoreCredit(customer_profile_oid: number, store_credit_request: CustomerStoreCreditAddRequest, options?: any): FetchArgs;
     /**
      * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
      * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
@@ -38524,6 +38699,14 @@ export declare const CustomerApiFetchParamCreator: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getCustomerEmailLists(options?: any): FetchArgs;
+    /**
+     * Retrieve the customer store credit accumulated through loyalty programs
+     * @summary Retrieve the customer store credit accumulated through loyalty programs
+     * @param {number} customer_profile_oid The customer oid to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCustomerStoreCredit(customer_profile_oid: number, options?: any): FetchArgs;
     /**
      * Retrieves customers from the account.  If no parameters are specified, all customers will be returned.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
      * @summary Retrieve customers
@@ -38634,6 +38817,15 @@ export declare const CustomerApiFetchParamCreator: (configuration?: Configuratio
  * @export
  */
 export declare const CustomerApiFp: (configuration?: Configuration) => {
+    /**
+     * Adds store credit to a customer
+     * @summary Adds store credit to a customer
+     * @param {number} customer_profile_oid The customer oid to credit.
+     * @param {CustomerStoreCreditAddRequest} store_credit_request Store credit to add
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addCustomerStoreCredit(customer_profile_oid: number, store_credit_request: CustomerStoreCreditAddRequest, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<BaseResponse>;
     /**
      * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
      * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
@@ -38683,6 +38875,14 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getCustomerEmailLists(options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<EmailListsResponse>;
+    /**
+     * Retrieve the customer store credit accumulated through loyalty programs
+     * @summary Retrieve the customer store credit accumulated through loyalty programs
+     * @param {number} customer_profile_oid The customer oid to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCustomerStoreCredit(customer_profile_oid: number, options?: any): (fetch?: FetchAPI, basePath?: string) => Promise<CustomerStoreCreditResponse>;
     /**
      * Retrieves customers from the account.  If no parameters are specified, all customers will be returned.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
      * @summary Retrieve customers
@@ -38793,6 +38993,15 @@ export declare const CustomerApiFp: (configuration?: Configuration) => {
  * @export
  */
 export declare const CustomerApiFactory: (configuration?: Configuration, fetch?: FetchAPI, basePath?: string) => {
+    /**
+     * Adds store credit to a customer
+     * @summary Adds store credit to a customer
+     * @param {number} customer_profile_oid The customer oid to credit.
+     * @param {CustomerStoreCreditAddRequest} store_credit_request Store credit to add
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addCustomerStoreCredit(customer_profile_oid: number, store_credit_request: CustomerStoreCreditAddRequest, options?: any): Promise<BaseResponse>;
     /**
      * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
      * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
@@ -38842,6 +39051,14 @@ export declare const CustomerApiFactory: (configuration?: Configuration, fetch?:
      * @throws {RequiredError}
      */
     getCustomerEmailLists(options?: any): Promise<EmailListsResponse>;
+    /**
+     * Retrieve the customer store credit accumulated through loyalty programs
+     * @summary Retrieve the customer store credit accumulated through loyalty programs
+     * @param {number} customer_profile_oid The customer oid to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getCustomerStoreCredit(customer_profile_oid: number, options?: any): Promise<CustomerStoreCreditResponse>;
     /**
      * Retrieves customers from the account.  If no parameters are specified, all customers will be returned.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
      * @summary Retrieve customers
@@ -38953,6 +39170,16 @@ export declare const CustomerApiFactory: (configuration?: Configuration, fetch?:
  * @interface CustomerApi
  */
 export interface CustomerApiInterface {
+    /**
+     * Adds store credit to a customer
+     * @summary Adds store credit to a customer
+     * @param {number} customer_profile_oid The customer oid to credit.
+     * @param {CustomerStoreCreditAddRequest} store_credit_request Store credit to add
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApiInterface
+     */
+    addCustomerStoreCredit(customer_profile_oid: number, store_credit_request: CustomerStoreCreditAddRequest, options?: any): Promise<BaseResponse>;
     /**
      * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
      * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
@@ -39008,6 +39235,15 @@ export interface CustomerApiInterface {
      * @memberof CustomerApiInterface
      */
     getCustomerEmailLists(options?: any): Promise<EmailListsResponse>;
+    /**
+     * Retrieve the customer store credit accumulated through loyalty programs
+     * @summary Retrieve the customer store credit accumulated through loyalty programs
+     * @param {number} customer_profile_oid The customer oid to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApiInterface
+     */
+    getCustomerStoreCredit(customer_profile_oid: number, options?: any): Promise<CustomerStoreCreditResponse>;
     /**
      * Retrieves customers from the account.  If no parameters are specified, all customers will be returned.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
      * @summary Retrieve customers
@@ -39128,6 +39364,16 @@ export interface CustomerApiInterface {
  * @extends {BaseAPI}
  */
 export declare class CustomerApi extends BaseAPI implements CustomerApiInterface {
+    /**
+     * Adds store credit to a customer
+     * @summary Adds store credit to a customer
+     * @param {number} customer_profile_oid The customer oid to credit.
+     * @param {CustomerStoreCreditAddRequest} store_credit_request Store credit to add
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    addCustomerStoreCredit(customer_profile_oid: number, store_credit_request: CustomerStoreCreditAddRequest, options?: any): Promise<BaseResponse>;
     /**
      * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
      * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
@@ -39183,6 +39429,15 @@ export declare class CustomerApi extends BaseAPI implements CustomerApiInterface
      * @memberof CustomerApi
      */
     getCustomerEmailLists(options?: any): Promise<EmailListsResponse>;
+    /**
+     * Retrieve the customer store credit accumulated through loyalty programs
+     * @summary Retrieve the customer store credit accumulated through loyalty programs
+     * @param {number} customer_profile_oid The customer oid to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    getCustomerStoreCredit(customer_profile_oid: number, options?: any): Promise<CustomerStoreCreditResponse>;
     /**
      * Retrieves customers from the account.  If no parameters are specified, all customers will be returned.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
      * @summary Retrieve customers

package/dist/api.js

@@ -8820,6 +8820,60 @@ exports.CouponApi = CouponApi;
  */
 var CustomerApiFetchParamCreator = function (configuration) {
     return {
+        /**
+         * Adds store credit to a customer
+         * @summary Adds store credit to a customer
+         * @param {number} customer_profile_oid The customer oid to credit.
+         * @param {CustomerStoreCreditAddRequest} store_credit_request Store credit to add
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        addCustomerStoreCredit: function (customer_profile_oid, store_credit_request, options) {
+            if (options === void 0) { options = {}; }
+            // verify required parameter 'customer_profile_oid' is not null or undefined
+            if (customer_profile_oid === null || customer_profile_oid === undefined) {
+                throw new RequiredError('customer_profile_oid', 'Required parameter customer_profile_oid was null or undefined when calling addCustomerStoreCredit.');
+            }
+            // verify required parameter 'store_credit_request' is not null or undefined
+            if (store_credit_request === null || store_credit_request === undefined) {
+                throw new RequiredError('store_credit_request', 'Required parameter store_credit_request was null or undefined when calling addCustomerStoreCredit.');
+            }
+            var localVarPath = "/customer/customers/{customer_profile_oid}/store_credit"
+                .replace("{".concat("customer_profile_oid", "}"), encodeURIComponent(String(customer_profile_oid)));
+            var localVarUrlObj = url.parse(localVarPath, true);
+            var localVarRequestOptions = Object.assign({ method: 'POST' }, options);
+            var localVarHeaderParameter = {};
+            var localVarQueryParameter = {};
+            if (configuration && configuration.apiVersion) {
+                localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
+            }
+            // authentication ultraCartOauth required
+            // oauth required
+            if (configuration && configuration.accessToken) {
+                var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+                    ? configuration.accessToken("ultraCartOauth", ["customer_write"])
+                    : configuration.accessToken;
+                localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
+            }
+            // authentication ultraCartSimpleApiKey required
+            if (configuration && configuration.apiKey) {
+                var localVarApiKeyValue = typeof configuration.apiKey === 'function'
+                    ? configuration.apiKey("x-ultracart-simple-key")
+                    : configuration.apiKey;
+                localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
+            }
+            localVarHeaderParameter['Content-Type'] = 'application/json; charset=UTF-8';
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+            var needsSerialization = ("CustomerStoreCreditAddRequest" !== "string") || localVarRequestOptions.headers['Content-Type'] === 'application/json';
+            localVarRequestOptions.body = needsSerialization ? JSON.stringify(store_credit_request || {}) : (store_credit_request || "");
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
          * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
@@ -9100,6 +9154,52 @@ var CustomerApiFetchParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * Retrieve the customer store credit accumulated through loyalty programs
+         * @summary Retrieve the customer store credit accumulated through loyalty programs
+         * @param {number} customer_profile_oid The customer oid to retrieve.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCustomerStoreCredit: function (customer_profile_oid, options) {
+            if (options === void 0) { options = {}; }
+            // verify required parameter 'customer_profile_oid' is not null or undefined
+            if (customer_profile_oid === null || customer_profile_oid === undefined) {
+                throw new RequiredError('customer_profile_oid', 'Required parameter customer_profile_oid was null or undefined when calling getCustomerStoreCredit.');
+            }
+            var localVarPath = "/customer/customers/{customer_profile_oid}/store_credit"
+                .replace("{".concat("customer_profile_oid", "}"), encodeURIComponent(String(customer_profile_oid)));
+            var localVarUrlObj = url.parse(localVarPath, true);
+            var localVarRequestOptions = Object.assign({ method: 'GET' }, options);
+            var localVarHeaderParameter = {};
+            var localVarQueryParameter = {};
+            if (configuration && configuration.apiVersion) {
+                localVarHeaderParameter["X-UltraCart-Api-Version"] = configuration.apiVersion;
+            }
+            // authentication ultraCartOauth required
+            // oauth required
+            if (configuration && configuration.accessToken) {
+                var localVarAccessTokenValue = typeof configuration.accessToken === 'function'
+                    ? configuration.accessToken("ultraCartOauth", ["customer_read"])
+                    : configuration.accessToken;
+                localVarHeaderParameter["Authorization"] = "Bearer " + localVarAccessTokenValue;
+            }
+            // authentication ultraCartSimpleApiKey required
+            if (configuration && configuration.apiKey) {
+                var localVarApiKeyValue = typeof configuration.apiKey === 'function'
+                    ? configuration.apiKey("x-ultracart-simple-key")
+                    : configuration.apiKey;
+                localVarHeaderParameter["x-ultracart-simple-key"] = localVarApiKeyValue;
+            }
+            localVarUrlObj.query = Object.assign({}, localVarUrlObj.query, localVarQueryParameter, options.query);
+            // fix override query string Detail: https://stackoverflow.com/a/7517673/1077943
+            delete localVarUrlObj.search;
+            localVarRequestOptions.headers = Object.assign({}, localVarHeaderParameter, options.headers);
+            return {
+                url: url.format(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * Retrieves customers from the account.  If no parameters are specified, all customers will be returned.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
          * @summary Retrieve customers
@@ -9649,6 +9749,29 @@ exports.CustomerApiFetchParamCreator = CustomerApiFetchParamCreator;
  */
 var CustomerApiFp = function (configuration) {
     return {
+        /**
+         * Adds store credit to a customer
+         * @summary Adds store credit to a customer
+         * @param {number} customer_profile_oid The customer oid to credit.
+         * @param {CustomerStoreCreditAddRequest} store_credit_request Store credit to add
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        addCustomerStoreCredit: function (customer_profile_oid, store_credit_request, options) {
+            var localVarFetchArgs = (0, exports.CustomerApiFetchParamCreator)(configuration).addCustomerStoreCredit(customer_profile_oid, store_credit_request, options);
+            return function (fetch, basePath) {
+                if (fetch === void 0) { fetch = portableFetch; }
+                if (basePath === void 0) { basePath = BASE_PATH; }
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
+                    if (response.status >= 200 && response.status < 300) {
+                        return response.json();
+                    }
+                    else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
          * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
@@ -9782,6 +9905,28 @@ var CustomerApiFp = function (configuration) {
                 });
             };
         },
+        /**
+         * Retrieve the customer store credit accumulated through loyalty programs
+         * @summary Retrieve the customer store credit accumulated through loyalty programs
+         * @param {number} customer_profile_oid The customer oid to retrieve.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCustomerStoreCredit: function (customer_profile_oid, options) {
+            var localVarFetchArgs = (0, exports.CustomerApiFetchParamCreator)(configuration).getCustomerStoreCredit(customer_profile_oid, options);
+            return function (fetch, basePath) {
+                if (fetch === void 0) { fetch = portableFetch; }
+                if (basePath === void 0) { basePath = BASE_PATH; }
+                return fetch(basePath + localVarFetchArgs.url, localVarFetchArgs.options).then(function (response) {
+                    if (response.status >= 200 && response.status < 300) {
+                        return response.json();
+                    }
+                    else {
+                        throw response;
+                    }
+                });
+            };
+        },
         /**
          * Retrieves customers from the account.  If no parameters are specified, all customers will be returned.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
          * @summary Retrieve customers
@@ -10007,6 +10152,17 @@ exports.CustomerApiFp = CustomerApiFp;
  */
 var CustomerApiFactory = function (configuration, fetch, basePath) {
     return {
+        /**
+         * Adds store credit to a customer
+         * @summary Adds store credit to a customer
+         * @param {number} customer_profile_oid The customer oid to credit.
+         * @param {CustomerStoreCreditAddRequest} store_credit_request Store credit to add
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        addCustomerStoreCredit: function (customer_profile_oid, store_credit_request, options) {
+            return (0, exports.CustomerApiFp)(configuration).addCustomerStoreCredit(customer_profile_oid, store_credit_request, options)(fetch, basePath);
+        },
         /**
          * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
          * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
@@ -10068,6 +10224,16 @@ var CustomerApiFactory = function (configuration, fetch, basePath) {
         getCustomerEmailLists: function (options) {
             return (0, exports.CustomerApiFp)(configuration).getCustomerEmailLists(options)(fetch, basePath);
         },
+        /**
+         * Retrieve the customer store credit accumulated through loyalty programs
+         * @summary Retrieve the customer store credit accumulated through loyalty programs
+         * @param {number} customer_profile_oid The customer oid to retrieve.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getCustomerStoreCredit: function (customer_profile_oid, options) {
+            return (0, exports.CustomerApiFp)(configuration).getCustomerStoreCredit(customer_profile_oid, options)(fetch, basePath);
+        },
         /**
          * Retrieves customers from the account.  If no parameters are specified, all customers will be returned.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
          * @summary Retrieve customers
@@ -10202,6 +10368,18 @@ var CustomerApi = /** @class */ (function (_super) {
     function CustomerApi() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
+    /**
+     * Adds store credit to a customer
+     * @summary Adds store credit to a customer
+     * @param {number} customer_profile_oid The customer oid to credit.
+     * @param {CustomerStoreCreditAddRequest} store_credit_request Store credit to add
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    CustomerApi.prototype.addCustomerStoreCredit = function (customer_profile_oid, store_credit_request, options) {
+        return (0, exports.CustomerApiFp)(this.configuration).addCustomerStoreCredit(customer_profile_oid, store_credit_request, options)(this.fetch, this.basePath);
+    };
     /**
      * Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
      * @summary Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
@@ -10269,6 +10447,17 @@ var CustomerApi = /** @class */ (function (_super) {
     CustomerApi.prototype.getCustomerEmailLists = function (options) {
         return (0, exports.CustomerApiFp)(this.configuration).getCustomerEmailLists(options)(this.fetch, this.basePath);
     };
+    /**
+     * Retrieve the customer store credit accumulated through loyalty programs
+     * @summary Retrieve the customer store credit accumulated through loyalty programs
+     * @param {number} customer_profile_oid The customer oid to retrieve.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CustomerApi
+     */
+    CustomerApi.prototype.getCustomerStoreCredit = function (customer_profile_oid, options) {
+        return (0, exports.CustomerApiFp)(this.configuration).getCustomerStoreCredit(customer_profile_oid, options)(this.fetch, this.basePath);
+    };
     /**
      * Retrieves customers from the account.  If no parameters are specified, all customers will be returned.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
      * @summary Retrieve customers

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "3.10.7",
+  "version": "3.10.8",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "keywords": [