ultracart_rest_api_v2_typescript 4.1.124 → 4.1.126

package/.openapi-generator/FILES

@@ -796,6 +796,7 @@ src/models/Metric.ts
 src/models/ModelError.ts
 src/models/Notification.ts
 src/models/OauthDeviceAuthorizationResponse.ts
+src/models/OauthMeResponse.ts
 src/models/OauthRevokeSuccessResponse.ts
 src/models/OauthTokenResponse.ts
 src/models/Order.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.124
+## ultracart_rest_api_v2_typescript@4.1.126
 
 Every API method call has a sample for every language SDK.  See https://github.com/UltraCart/sdk_samples
 
 Installation
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.1.124 --save
+npm install ultracart_rest_api_v2_typescript@4.1.126 --save
 ```
 
 ```typescript
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.126 | 08/10/2026 | oauth - add /oauth/me method to assist application in indentifying the connected account |
+| 4.1.125 | 08/06/2026 | order api - ability to query by bin and last 4 in unlimited scenarios for chargeback order association |
 | 4.1.124 | 08/04/2026 | customer - method to remove customer profile from email suppression |
 | 4.1.123 | 08/04/2026 | customer - method to remove customer profile from email suppression |
 | 4.1.122 | 07/29/2026 | auto order api - new methods for payment information and rebill |

package/dist/apis/OauthApi.d.ts

@@ -68,6 +68,19 @@ export interface OauthApiInterface {
      * Initiate a device authorization flow.
      */
     oauthDeviceAuthorize(requestParameters: OauthDeviceAuthorizeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OauthDeviceAuthorizationResponse>;
+    /**
+     * Returns the UltraCart merchant account that authorized your application, along with the permissions that were granted.  Call it immediately after exchanging your authorization code so you can display the connected account to your user and map it within your own system.  Any OAuth access token may call this endpoint regardless of the permissions it holds.  The granted permissions are the ones the merchant approved, which may be narrower than the permissions your application currently requests, because permissions are recorded when the merchant authorizes and do not change afterwards.  If you add a permission to your application, already connected merchants keep the permissions they originally approved until they authorize again, so read this list rather than assuming your application\'s configured permissions.
+     * @summary Identify the merchant account this access token belongs to.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OauthApiInterface
+     */
+    oauthMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Returns the UltraCart merchant account that authorized your application, along with the permissions that were granted.  Call it immediately after exchanging your authorization code so you can display the connected account to your user and map it within your own system.  Any OAuth access token may call this endpoint regardless of the permissions it holds.  The granted permissions are the ones the merchant approved, which may be narrower than the permissions your application currently requests, because permissions are recorded when the merchant authorizes and do not change afterwards.  If you add a permission to your application, already connected merchants keep the permissions they originally approved until they authorize again, so read this list rather than assuming your application\'s configured permissions.
+     * Identify the merchant account this access token belongs to.
+     */
+    oauthMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Revokes the OAuth application associated with the specified client_id and token.
      * @summary Revoke this OAuth application.
@@ -108,6 +121,16 @@ export declare class OauthApi extends runtime.BaseAPI implements OauthApiInterfa
      * Initiate a device authorization flow.
      */
     oauthDeviceAuthorize(requestParameters: OauthDeviceAuthorizeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OauthDeviceAuthorizationResponse>;
+    /**
+     * Returns the UltraCart merchant account that authorized your application, along with the permissions that were granted.  Call it immediately after exchanging your authorization code so you can display the connected account to your user and map it within your own system.  Any OAuth access token may call this endpoint regardless of the permissions it holds.  The granted permissions are the ones the merchant approved, which may be narrower than the permissions your application currently requests, because permissions are recorded when the merchant authorizes and do not change afterwards.  If you add a permission to your application, already connected merchants keep the permissions they originally approved until they authorize again, so read this list rather than assuming your application\'s configured permissions.
+     * Identify the merchant account this access token belongs to.
+     */
+    oauthMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Returns the UltraCart merchant account that authorized your application, along with the permissions that were granted.  Call it immediately after exchanging your authorization code so you can display the connected account to your user and map it within your own system.  Any OAuth access token may call this endpoint regardless of the permissions it holds.  The granted permissions are the ones the merchant approved, which may be narrower than the permissions your application currently requests, because permissions are recorded when the merchant authorizes and do not change afterwards.  If you add a permission to your application, already connected merchants keep the permissions they originally approved until they authorize again, so read this list rather than assuming your application\'s configured permissions.
+     * Identify the merchant account this access token belongs to.
+     */
+    oauthMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Revokes the OAuth application associated with the specified client_id and token.
      * Revoke this OAuth application.

package/dist/apis/OauthApi.js

@@ -253,6 +253,56 @@ var OauthApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Returns the UltraCart merchant account that authorized your application, along with the permissions that were granted.  Call it immediately after exchanging your authorization code so you can display the connected account to your user and map it within your own system.  Any OAuth access token may call this endpoint regardless of the permissions it holds.  The granted permissions are the ones the merchant approved, which may be narrower than the permissions your application currently requests, because permissions are recorded when the merchant authorizes and do not change afterwards.  If you add a permission to your application, already connected merchants keep the permissions they originally approved until they authorize again, so read this list rather than assuming your application\'s configured permissions.
+     * Identify the merchant account this access token belongs to.
+     */
+    OauthApi.prototype.oauthMeRaw = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        queryParameters = {};
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2: return [4 /*yield*/, this.request({
+                            path: "/oauth/me",
+                            method: 'GET',
+                            headers: headerParameters,
+                            query: queryParameters,
+                        }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * Returns the UltraCart merchant account that authorized your application, along with the permissions that were granted.  Call it immediately after exchanging your authorization code so you can display the connected account to your user and map it within your own system.  Any OAuth access token may call this endpoint regardless of the permissions it holds.  The granted permissions are the ones the merchant approved, which may be narrower than the permissions your application currently requests, because permissions are recorded when the merchant authorizes and do not change afterwards.  If you add a permission to your application, already connected merchants keep the permissions they originally approved until they authorize again, so read this list rather than assuming your application\'s configured permissions.
+     * Identify the merchant account this access token belongs to.
+     */
+    OauthApi.prototype.oauthMe = function (initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.oauthMeRaw(initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
     /**
      * Revokes the OAuth application associated with the specified client_id and token.
      * Revoke this OAuth application.

package/dist/models/ItemThirdPartyEmailMarketing.d.ts

@@ -61,7 +61,6 @@ export declare const ItemThirdPartyEmailMarketingProviderNameEnum: {
     readonly Lyris: "Lyris";
     readonly LyrisHq: "LyrisHQ";
     readonly MailChimp: "MailChimp";
-    readonly SilverPop: "SilverPop";
 };
 export type ItemThirdPartyEmailMarketingProviderNameEnum = typeof ItemThirdPartyEmailMarketingProviderNameEnum[keyof typeof ItemThirdPartyEmailMarketingProviderNameEnum];
 /**

package/dist/models/ItemThirdPartyEmailMarketing.js

@@ -29,8 +29,7 @@ exports.ItemThirdPartyEmailMarketingProviderNameEnum = {
     Klaviyo: 'Klaviyo',
     Lyris: 'Lyris',
     LyrisHq: 'LyrisHQ',
-    MailChimp: 'MailChimp',
-    SilverPop: 'SilverPop'
+    MailChimp: 'MailChimp'
 };
 /**
  * Check if a given object implements the ItemThirdPartyEmailMarketing interface.

package/dist/models/OauthMeResponse.d.ts

@@ -0,0 +1,55 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface OauthMeResponse
+ */
+export interface OauthMeResponse {
+    /**
+     * The name of your application as the merchant approved it.
+     * @type {string}
+     * @memberof OauthMeResponse
+     */
+    application_name?: string;
+    /**
+     * Your application's client_id.  Null when authenticating with a simple key, which is not tied to an application.
+     * @type {string}
+     * @memberof OauthMeResponse
+     */
+    client_id?: string;
+    /**
+     * The UltraCart merchant account that authorized your application.  Stable, and the value to key your own records on.
+     * @type {string}
+     * @memberof OauthMeResponse
+     */
+    merchant_id?: string;
+    /**
+     * The account's company name, suitable for displaying to your user.  The merchant can change this, so display it rather than storing it as an identifier.
+     * @type {string}
+     * @memberof OauthMeResponse
+     */
+    merchant_name?: string;
+    /**
+     * The permissions the merchant granted.  May be narrower than the permissions your application currently requests.
+     * @type {Array<string>}
+     * @memberof OauthMeResponse
+     */
+    scopes?: Array<string>;
+}
+/**
+ * Check if a given object implements the OauthMeResponse interface.
+ */
+export declare function instanceOfOauthMeResponse(value: object): boolean;
+export declare function OauthMeResponseFromJSON(json: any): OauthMeResponse;
+export declare function OauthMeResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): OauthMeResponse;
+export declare function OauthMeResponseToJSON(value?: OauthMeResponse | null): any;

package/dist/models/OauthMeResponse.js

@@ -0,0 +1,58 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OauthMeResponseToJSON = exports.OauthMeResponseFromJSONTyped = exports.OauthMeResponseFromJSON = exports.instanceOfOauthMeResponse = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the OauthMeResponse interface.
+ */
+function instanceOfOauthMeResponse(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfOauthMeResponse = instanceOfOauthMeResponse;
+function OauthMeResponseFromJSON(json) {
+    return OauthMeResponseFromJSONTyped(json, false);
+}
+exports.OauthMeResponseFromJSON = OauthMeResponseFromJSON;
+function OauthMeResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'application_name': !(0, runtime_1.exists)(json, 'application_name') ? undefined : json['application_name'],
+        'client_id': !(0, runtime_1.exists)(json, 'client_id') ? undefined : json['client_id'],
+        'merchant_id': !(0, runtime_1.exists)(json, 'merchant_id') ? undefined : json['merchant_id'],
+        'merchant_name': !(0, runtime_1.exists)(json, 'merchant_name') ? undefined : json['merchant_name'],
+        'scopes': !(0, runtime_1.exists)(json, 'scopes') ? undefined : json['scopes'],
+    };
+}
+exports.OauthMeResponseFromJSONTyped = OauthMeResponseFromJSONTyped;
+function OauthMeResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'application_name': value.application_name,
+        'client_id': value.client_id,
+        'merchant_id': value.merchant_id,
+        'merchant_name': value.merchant_name,
+        'scopes': value.scopes,
+    };
+}
+exports.OauthMeResponseToJSON = OauthMeResponseToJSON;

package/dist/models/OauthTokenResponse.d.ts

@@ -45,6 +45,12 @@ export interface OauthTokenResponse {
      * @memberof OauthTokenResponse
      */
     expires_in?: string;
+    /**
+     * The UltraCart merchant account that authorized this token.  Use it to map the token to the merchant within your own system.  Also returned by GET /oauth/me along with the account name.
+     * @type {string}
+     * @memberof OauthTokenResponse
+     */
+    merchant_id?: string;
     /**
      * The refresh token that should be used to fetch a new access token when the expiration occurs
      * @type {string}

package/dist/models/OauthTokenResponse.js

@@ -43,6 +43,7 @@ function OauthTokenResponseFromJSONTyped(json, ignoreDiscriminator) {
         'error_description': !(0, runtime_1.exists)(json, 'error_description') ? undefined : json['error_description'],
         'error_uri': !(0, runtime_1.exists)(json, 'error_uri') ? undefined : json['error_uri'],
         'expires_in': !(0, runtime_1.exists)(json, 'expires_in') ? undefined : json['expires_in'],
+        'merchant_id': !(0, runtime_1.exists)(json, 'merchant_id') ? undefined : json['merchant_id'],
         'refresh_token': !(0, runtime_1.exists)(json, 'refresh_token') ? undefined : json['refresh_token'],
         'scope': !(0, runtime_1.exists)(json, 'scope') ? undefined : json['scope'],
         'token_type': !(0, runtime_1.exists)(json, 'token_type') ? undefined : json['token_type'],
@@ -62,6 +63,7 @@ function OauthTokenResponseToJSON(value) {
         'error_description': value.error_description,
         'error_uri': value.error_uri,
         'expires_in': value.expires_in,
+        'merchant_id': value.merchant_id,
         'refresh_token': value.refresh_token,
         'scope': value.scope,
         'token_type': value.token_type,

package/dist/models/OrderQuery.d.ts

@@ -16,6 +16,18 @@ import { OrderQueryPaymentTransactionFilter } from './OrderQueryPaymentTransacti
  * @interface OrderQuery
  */
 export interface OrderQuery {
+    /**
+     * First six digits (BIN) of the credit card number.  Must be specified together with card_last4 and a payment_date_begin/payment_date_end range.  Requires query_target=cache.
+     * @type {string}
+     * @memberof OrderQuery
+     */
+    card_bin?: string;
+    /**
+     * Last four digits of the credit card number.  Must be specified together with card_bin and a payment_date_begin/payment_date_end range.  Always supply four digits, including for American Express.  Requires query_target=cache.
+     * @type {string}
+     * @memberof OrderQuery
+     */
+    card_last4?: string;
     /**
      * CC Email
      * @type {string}
@@ -185,7 +197,7 @@ export interface OrderQuery {
      */
     payment_method?: OrderQueryPaymentMethodEnum;
     /**
-     * Exact-match filters on the detail name/value pairs of a single payment transaction, AND-ed against the same transaction. Requires query_target=cache which uses the ElasticSearch cache. The origin or database path cannot search transaction details. The rotating gateway is just another pair, name equals rotatingTransactionGatewayCode or rotatingTransactionGatewayName.
+     * Exact-match filters on the detail name/value pairs of a single payment transaction, AND-ed against the same transaction. Requires query_target=cache. The origin or database path cannot search transaction details. The rotating gateway is just another pair, name equals rotatingTransactionGatewayCode or rotatingTransactionGatewayName.
      * @type {Array<OrderQueryPaymentTransactionFilter>}
      * @memberof OrderQuery
      */

package/dist/models/OrderQuery.js

@@ -80,6 +80,8 @@ function OrderQueryFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
+        'card_bin': !(0, runtime_1.exists)(json, 'card_bin') ? undefined : json['card_bin'],
+        'card_last4': !(0, runtime_1.exists)(json, 'card_last4') ? undefined : json['card_last4'],
         'cc_email': !(0, runtime_1.exists)(json, 'cc_email') ? undefined : json['cc_email'],
         'channel_partner_code': !(0, runtime_1.exists)(json, 'channel_partner_code') ? undefined : json['channel_partner_code'],
         'channel_partner_order_id': !(0, runtime_1.exists)(json, 'channel_partner_order_id') ? undefined : json['channel_partner_order_id'],
@@ -135,6 +137,8 @@ function OrderQueryToJSON(value) {
         return null;
     }
     return {
+        'card_bin': value.card_bin,
+        'card_last4': value.card_last4,
         'cc_email': value.cc_email,
         'channel_partner_code': value.channel_partner_code,
         'channel_partner_order_id': value.channel_partner_order_id,

package/dist/models/index.d.ts

@@ -767,6 +767,7 @@ export * from './Metric';
 export * from './ModelError';
 export * from './Notification';
 export * from './OauthDeviceAuthorizationResponse';
+export * from './OauthMeResponse';
 export * from './OauthRevokeSuccessResponse';
 export * from './OauthTokenResponse';
 export * from './Order';

package/dist/models/index.js

@@ -785,6 +785,7 @@ __exportStar(require("./Metric"), exports);
 __exportStar(require("./ModelError"), exports);
 __exportStar(require("./Notification"), exports);
 __exportStar(require("./OauthDeviceAuthorizationResponse"), exports);
+__exportStar(require("./OauthMeResponse"), exports);
 __exportStar(require("./OauthRevokeSuccessResponse"), exports);
 __exportStar(require("./OauthTokenResponse"), exports);
 __exportStar(require("./Order"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.1.124",
+  "version": "4.1.126",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/apis/OauthApi.ts

@@ -93,6 +93,21 @@ export interface OauthApiInterface {
      */
     oauthDeviceAuthorize(requestParameters: OauthDeviceAuthorizeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OauthDeviceAuthorizationResponse>;
 
+    /**
+     * Returns the UltraCart merchant account that authorized your application, along with the permissions that were granted.  Call it immediately after exchanging your authorization code so you can display the connected account to your user and map it within your own system.  Any OAuth access token may call this endpoint regardless of the permissions it holds.  The granted permissions are the ones the merchant approved, which may be narrower than the permissions your application currently requests, because permissions are recorded when the merchant authorizes and do not change afterwards.  If you add a permission to your application, already connected merchants keep the permissions they originally approved until they authorize again, so read this list rather than assuming your application\'s configured permissions. 
+     * @summary Identify the merchant account this access token belongs to.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OauthApiInterface
+     */
+    oauthMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Returns the UltraCart merchant account that authorized your application, along with the permissions that were granted.  Call it immediately after exchanging your authorization code so you can display the connected account to your user and map it within your own system.  Any OAuth access token may call this endpoint regardless of the permissions it holds.  The granted permissions are the ones the merchant approved, which may be narrower than the permissions your application currently requests, because permissions are recorded when the merchant authorizes and do not change afterwards.  If you add a permission to your application, already connected merchants keep the permissions they originally approved until they authorize again, so read this list rather than assuming your application\'s configured permissions. 
+     * Identify the merchant account this access token belongs to.
+     */
+    oauthMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
     /**
      * Revokes the OAuth application associated with the specified client_id and token. 
      * @summary Revoke this OAuth application.
@@ -277,6 +292,38 @@ export class OauthApi extends runtime.BaseAPI implements OauthApiInterface {
         return await response.value();
     }
 
+    /**
+     * Returns the UltraCart merchant account that authorized your application, along with the permissions that were granted.  Call it immediately after exchanging your authorization code so you can display the connected account to your user and map it within your own system.  Any OAuth access token may call this endpoint regardless of the permissions it holds.  The granted permissions are the ones the merchant approved, which may be narrower than the permissions your application currently requests, because permissions are recorded when the merchant authorizes and do not change afterwards.  If you add a permission to your application, already connected merchants keep the permissions they originally approved until they authorize again, so read this list rather than assuming your application\'s configured permissions. 
+     * Identify the merchant account this access token belongs to.
+     */
+    async oauthMeRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", []);
+        }
+
+        const response = await this.request({
+            path: `/oauth/me`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Returns the UltraCart merchant account that authorized your application, along with the permissions that were granted.  Call it immediately after exchanging your authorization code so you can display the connected account to your user and map it within your own system.  Any OAuth access token may call this endpoint regardless of the permissions it holds.  The granted permissions are the ones the merchant approved, which may be narrower than the permissions your application currently requests, because permissions are recorded when the merchant authorizes and do not change afterwards.  If you add a permission to your application, already connected merchants keep the permissions they originally approved until they authorize again, so read this list rather than assuming your application\'s configured permissions. 
+     * Identify the merchant account this access token belongs to.
+     */
+    async oauthMe(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.oauthMeRaw(initOverrides);
+    }
+
     /**
      * Revokes the OAuth application associated with the specified client_id and token. 
      * Revoke this OAuth application.

package/src/models/ItemThirdPartyEmailMarketing.ts

@@ -67,8 +67,7 @@ export const ItemThirdPartyEmailMarketingProviderNameEnum = {
     Klaviyo: 'Klaviyo',
     Lyris: 'Lyris',
     LyrisHq: 'LyrisHQ',
-    MailChimp: 'MailChimp',
-    SilverPop: 'SilverPop'
+    MailChimp: 'MailChimp'
 } as const;
 export type ItemThirdPartyEmailMarketingProviderNameEnum = typeof ItemThirdPartyEmailMarketingProviderNameEnum[keyof typeof ItemThirdPartyEmailMarketingProviderNameEnum];
 

package/src/models/OauthMeResponse.ts

@@ -0,0 +1,99 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface OauthMeResponse
+ */
+export interface OauthMeResponse {
+    /**
+     * The name of your application as the merchant approved it.
+     * @type {string}
+     * @memberof OauthMeResponse
+     */
+    application_name?: string;
+    /**
+     * Your application's client_id.  Null when authenticating with a simple key, which is not tied to an application.
+     * @type {string}
+     * @memberof OauthMeResponse
+     */
+    client_id?: string;
+    /**
+     * The UltraCart merchant account that authorized your application.  Stable, and the value to key your own records on.
+     * @type {string}
+     * @memberof OauthMeResponse
+     */
+    merchant_id?: string;
+    /**
+     * The account's company name, suitable for displaying to your user.  The merchant can change this, so display it rather than storing it as an identifier.
+     * @type {string}
+     * @memberof OauthMeResponse
+     */
+    merchant_name?: string;
+    /**
+     * The permissions the merchant granted.  May be narrower than the permissions your application currently requests.
+     * @type {Array<string>}
+     * @memberof OauthMeResponse
+     */
+    scopes?: Array<string>;
+}
+
+
+
+/**
+ * Check if a given object implements the OauthMeResponse interface.
+ */
+export function instanceOfOauthMeResponse(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function OauthMeResponseFromJSON(json: any): OauthMeResponse {
+    return OauthMeResponseFromJSONTyped(json, false);
+}
+
+export function OauthMeResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): OauthMeResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'application_name': !exists(json, 'application_name') ? undefined : json['application_name'],
+        'client_id': !exists(json, 'client_id') ? undefined : json['client_id'],
+        'merchant_id': !exists(json, 'merchant_id') ? undefined : json['merchant_id'],
+        'merchant_name': !exists(json, 'merchant_name') ? undefined : json['merchant_name'],
+        'scopes': !exists(json, 'scopes') ? undefined : json['scopes'],
+    };
+}
+
+export function OauthMeResponseToJSON(value?: OauthMeResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'application_name': value.application_name,
+        'client_id': value.client_id,
+        'merchant_id': value.merchant_id,
+        'merchant_name': value.merchant_name,
+        'scopes': value.scopes,
+    };
+}
+

package/src/models/OauthTokenResponse.ts

@@ -49,6 +49,12 @@ export interface OauthTokenResponse {
      * @memberof OauthTokenResponse
      */
     expires_in?: string;
+    /**
+     * The UltraCart merchant account that authorized this token.  Use it to map the token to the merchant within your own system.  Also returned by GET /oauth/me along with the account name.
+     * @type {string}
+     * @memberof OauthTokenResponse
+     */
+    merchant_id?: string;
     /**
      * The refresh token that should be used to fetch a new access token when the expiration occurs
      * @type {string}
@@ -104,6 +110,7 @@ export function OauthTokenResponseFromJSONTyped(json: any, ignoreDiscriminator:
         'error_description': !exists(json, 'error_description') ? undefined : json['error_description'],
         'error_uri': !exists(json, 'error_uri') ? undefined : json['error_uri'],
         'expires_in': !exists(json, 'expires_in') ? undefined : json['expires_in'],
+        'merchant_id': !exists(json, 'merchant_id') ? undefined : json['merchant_id'],
         'refresh_token': !exists(json, 'refresh_token') ? undefined : json['refresh_token'],
         'scope': !exists(json, 'scope') ? undefined : json['scope'],
         'token_type': !exists(json, 'token_type') ? undefined : json['token_type'],
@@ -124,6 +131,7 @@ export function OauthTokenResponseToJSON(value?: OauthTokenResponse | null): any
         'error_description': value.error_description,
         'error_uri': value.error_uri,
         'expires_in': value.expires_in,
+        'merchant_id': value.merchant_id,
         'refresh_token': value.refresh_token,
         'scope': value.scope,
         'token_type': value.token_type,

package/src/models/OrderQuery.ts

@@ -26,6 +26,18 @@ import {
  * @interface OrderQuery
  */
 export interface OrderQuery {
+    /**
+     * First six digits (BIN) of the credit card number.  Must be specified together with card_last4 and a payment_date_begin/payment_date_end range.  Requires query_target=cache.
+     * @type {string}
+     * @memberof OrderQuery
+     */
+    card_bin?: string;
+    /**
+     * Last four digits of the credit card number.  Must be specified together with card_bin and a payment_date_begin/payment_date_end range.  Always supply four digits, including for American Express.  Requires query_target=cache.
+     * @type {string}
+     * @memberof OrderQuery
+     */
+    card_last4?: string;
     /**
      * CC Email
      * @type {string}
@@ -195,7 +207,7 @@ export interface OrderQuery {
      */
     payment_method?: OrderQueryPaymentMethodEnum;
     /**
-     * Exact-match filters on the detail name/value pairs of a single payment transaction, AND-ed against the same transaction. Requires query_target=cache which uses the ElasticSearch cache. The origin or database path cannot search transaction details. The rotating gateway is just another pair, name equals rotatingTransactionGatewayCode or rotatingTransactionGatewayName.
+     * Exact-match filters on the detail name/value pairs of a single payment transaction, AND-ed against the same transaction. Requires query_target=cache. The origin or database path cannot search transaction details. The rotating gateway is just another pair, name equals rotatingTransactionGatewayCode or rotatingTransactionGatewayName.
      * @type {Array<OrderQueryPaymentTransactionFilter>}
      * @memberof OrderQuery
      */
@@ -367,6 +379,8 @@ export function OrderQueryFromJSONTyped(json: any, ignoreDiscriminator: boolean)
     }
     return {
         
+        'card_bin': !exists(json, 'card_bin') ? undefined : json['card_bin'],
+        'card_last4': !exists(json, 'card_last4') ? undefined : json['card_last4'],
         'cc_email': !exists(json, 'cc_email') ? undefined : json['cc_email'],
         'channel_partner_code': !exists(json, 'channel_partner_code') ? undefined : json['channel_partner_code'],
         'channel_partner_order_id': !exists(json, 'channel_partner_order_id') ? undefined : json['channel_partner_order_id'],
@@ -423,6 +437,8 @@ export function OrderQueryToJSON(value?: OrderQuery | null): any {
     }
     return {
         
+        'card_bin': value.card_bin,
+        'card_last4': value.card_last4,
         'cc_email': value.cc_email,
         'channel_partner_code': value.channel_partner_code,
         'channel_partner_order_id': value.channel_partner_order_id,

package/src/models/index.ts

@@ -769,6 +769,7 @@ export * from './Metric';
 export * from './ModelError';
 export * from './Notification';
 export * from './OauthDeviceAuthorizationResponse';
+export * from './OauthMeResponse';
 export * from './OauthRevokeSuccessResponse';
 export * from './OauthTokenResponse';
 export * from './Order';