postgrid-node 0.1.0-alpha.2 → 0.1.0-alpha.4

package/src/internal/qs/utils.ts

@@ -0,0 +1,265 @@
+import { RFC1738 } from './formats';
+import type { DefaultEncoder, Format } from './types';
+
+const has = Object.prototype.hasOwnProperty;
+const is_array = Array.isArray;
+
+const hex_table = (() => {
+  const array = [];
+  for (let i = 0; i < 256; ++i) {
+    array.push('%' + ((i < 16 ? '0' : '') + i.toString(16)).toUpperCase());
+  }
+
+  return array;
+})();
+
+function compact_queue<T extends Record<string, any>>(queue: Array<{ obj: T; prop: string }>) {
+  while (queue.length > 1) {
+    const item = queue.pop();
+    if (!item) continue;
+
+    const obj = item.obj[item.prop];
+
+    if (is_array(obj)) {
+      const compacted: unknown[] = [];
+
+      for (let j = 0; j < obj.length; ++j) {
+        if (typeof obj[j] !== 'undefined') {
+          compacted.push(obj[j]);
+        }
+      }
+
+      // @ts-ignore
+      item.obj[item.prop] = compacted;
+    }
+  }
+}
+
+function array_to_object(source: any[], options: { plainObjects: boolean }) {
+  const obj = options && options.plainObjects ? Object.create(null) : {};
+  for (let i = 0; i < source.length; ++i) {
+    if (typeof source[i] !== 'undefined') {
+      obj[i] = source[i];
+    }
+  }
+
+  return obj;
+}
+
+export function merge(
+  target: any,
+  source: any,
+  options: { plainObjects?: boolean; allowPrototypes?: boolean } = {},
+) {
+  if (!source) {
+    return target;
+  }
+
+  if (typeof source !== 'object') {
+    if (is_array(target)) {
+      target.push(source);
+    } else if (target && typeof target === 'object') {
+      if (
+        (options && (options.plainObjects || options.allowPrototypes)) ||
+        !has.call(Object.prototype, source)
+      ) {
+        target[source] = true;
+      }
+    } else {
+      return [target, source];
+    }
+
+    return target;
+  }
+
+  if (!target || typeof target !== 'object') {
+    return [target].concat(source);
+  }
+
+  let mergeTarget = target;
+  if (is_array(target) && !is_array(source)) {
+    // @ts-ignore
+    mergeTarget = array_to_object(target, options);
+  }
+
+  if (is_array(target) && is_array(source)) {
+    source.forEach(function (item, i) {
+      if (has.call(target, i)) {
+        const targetItem = target[i];
+        if (targetItem && typeof targetItem === 'object' && item && typeof item === 'object') {
+          target[i] = merge(targetItem, item, options);
+        } else {
+          target.push(item);
+        }
+      } else {
+        target[i] = item;
+      }
+    });
+    return target;
+  }
+
+  return Object.keys(source).reduce(function (acc, key) {
+    const value = source[key];
+
+    if (has.call(acc, key)) {
+      acc[key] = merge(acc[key], value, options);
+    } else {
+      acc[key] = value;
+    }
+    return acc;
+  }, mergeTarget);
+}
+
+export function assign_single_source(target: any, source: any) {
+  return Object.keys(source).reduce(function (acc, key) {
+    acc[key] = source[key];
+    return acc;
+  }, target);
+}
+
+export function decode(str: string, _: any, charset: string) {
+  const strWithoutPlus = str.replace(/\+/g, ' ');
+  if (charset === 'iso-8859-1') {
+    // unescape never throws, no try...catch needed:
+    return strWithoutPlus.replace(/%[0-9a-f]{2}/gi, unescape);
+  }
+  // utf-8
+  try {
+    return decodeURIComponent(strWithoutPlus);
+  } catch (e) {
+    return strWithoutPlus;
+  }
+}
+
+const limit = 1024;
+
+export const encode: (
+  str: any,
+  defaultEncoder: DefaultEncoder,
+  charset: string,
+  type: 'key' | 'value',
+  format: Format,
+) => string = (str, _defaultEncoder, charset, _kind, format: Format) => {
+  // This code was originally written by Brian White for the io.js core querystring library.
+  // It has been adapted here for stricter adherence to RFC 3986
+  if (str.length === 0) {
+    return str;
+  }
+
+  let string = str;
+  if (typeof str === 'symbol') {
+    string = Symbol.prototype.toString.call(str);
+  } else if (typeof str !== 'string') {
+    string = String(str);
+  }
+
+  if (charset === 'iso-8859-1') {
+    return escape(string).replace(/%u[0-9a-f]{4}/gi, function ($0) {
+      return '%26%23' + parseInt($0.slice(2), 16) + '%3B';
+    });
+  }
+
+  let out = '';
+  for (let j = 0; j < string.length; j += limit) {
+    const segment = string.length >= limit ? string.slice(j, j + limit) : string;
+    const arr = [];
+
+    for (let i = 0; i < segment.length; ++i) {
+      let c = segment.charCodeAt(i);
+      if (
+        c === 0x2d || // -
+        c === 0x2e || // .
+        c === 0x5f || // _
+        c === 0x7e || // ~
+        (c >= 0x30 && c <= 0x39) || // 0-9
+        (c >= 0x41 && c <= 0x5a) || // a-z
+        (c >= 0x61 && c <= 0x7a) || // A-Z
+        (format === RFC1738 && (c === 0x28 || c === 0x29)) // ( )
+      ) {
+        arr[arr.length] = segment.charAt(i);
+        continue;
+      }
+
+      if (c < 0x80) {
+        arr[arr.length] = hex_table[c];
+        continue;
+      }
+
+      if (c < 0x800) {
+        arr[arr.length] = hex_table[0xc0 | (c >> 6)]! + hex_table[0x80 | (c & 0x3f)];
+        continue;
+      }
+
+      if (c < 0xd800 || c >= 0xe000) {
+        arr[arr.length] =
+          hex_table[0xe0 | (c >> 12)]! + hex_table[0x80 | ((c >> 6) & 0x3f)] + hex_table[0x80 | (c & 0x3f)];
+        continue;
+      }
+
+      i += 1;
+      c = 0x10000 + (((c & 0x3ff) << 10) | (segment.charCodeAt(i) & 0x3ff));
+
+      arr[arr.length] =
+        hex_table[0xf0 | (c >> 18)]! +
+        hex_table[0x80 | ((c >> 12) & 0x3f)] +
+        hex_table[0x80 | ((c >> 6) & 0x3f)] +
+        hex_table[0x80 | (c & 0x3f)];
+    }
+
+    out += arr.join('');
+  }
+
+  return out;
+};
+
+export function compact(value: any) {
+  const queue = [{ obj: { o: value }, prop: 'o' }];
+  const refs = [];
+
+  for (let i = 0; i < queue.length; ++i) {
+    const item = queue[i];
+    // @ts-ignore
+    const obj = item.obj[item.prop];
+
+    const keys = Object.keys(obj);
+    for (let j = 0; j < keys.length; ++j) {
+      const key = keys[j]!;
+      const val = obj[key];
+      if (typeof val === 'object' && val !== null && refs.indexOf(val) === -1) {
+        queue.push({ obj: obj, prop: key });
+        refs.push(val);
+      }
+    }
+  }
+
+  compact_queue(queue);
+
+  return value;
+}
+
+export function is_regexp(obj: any) {
+  return Object.prototype.toString.call(obj) === '[object RegExp]';
+}
+
+export function is_buffer(obj: any) {
+  if (!obj || typeof obj !== 'object') {
+    return false;
+  }
+
+  return !!(obj.constructor && obj.constructor.isBuffer && obj.constructor.isBuffer(obj));
+}
+
+export function combine(a: any, b: any) {
+  return [].concat(a, b);
+}
+
+export function maybe_map<T>(val: T[], fn: (v: T) => T) {
+  if (is_array(val)) {
+    const mapped = [];
+    for (let i = 0; i < val.length; i += 1) {
+      mapped.push(fn(val[i]!));
+    }
+    return mapped;
+  }
+  return fn(val);
+}

package/src/pagination.ts

@@ -6,6 +6,8 @@ export interface ListResponse<Item> {
   data: Array<Item>;
 
   totalCount: number;
+
+  limit: number;
 }
 
 export interface ListParams {
@@ -25,11 +27,14 @@ export class List<Item> extends AbstractPage<Item> implements ListResponse<Item>
 
   totalCount: number;
 
+  limit: number;
+
   constructor(client: APIClient, response: Response, body: ListResponse<Item>, options: FinalRequestOptions) {
     super(client, response, body, options);
 
     this.data = body.data || [];
     this.totalCount = body.totalCount || 0;
+    this.limit = body.limit || 0;
   }
 
   getPaginatedItems(): Item[] {
@@ -47,7 +52,7 @@ export class List<Item> extends AbstractPage<Item> implements ListResponse<Item>
   }
 
   nextPageInfo(): PageInfo | null {
-    const offset = (this.options.query as ListParams).skip ?? 0;
+    const offset = this.limit;
     if (!offset) {
       return null;
     }

package/src/resource.ts

@@ -2,7 +2,7 @@
 
 import type { PostGrid } from './index';
 
-export class APIResource {
+export abstract class APIResource {
   protected _client: PostGrid;
 
   constructor(client: PostGrid) {

package/src/resources/bank-accounts.ts

@@ -14,6 +14,19 @@ export class BankAccounts extends APIResource {
    *
    * You must specify _either_ `signatureImage` or `signatureText`. The image can be
    * supplied as either a URL or a multipart file upload.
+   *
+   * @example
+   * ```ts
+   * const bankAccount = await client.bankAccounts.create({
+   *   accountNumber: '1234567',
+   *   bankCountryCode: 'US',
+   *   bankName: 'Test Bank',
+   *   signatureText: 'Example',
+   *   bankPrimaryLine: '145 mulberry st',
+   *   bankSecondaryLine: 'new york ny 10013',
+   *   routingNumber: '123456789',
+   * });
+   * ```
    */
   create(body: BankAccountCreateParams, options?: Core.RequestOptions): Core.APIPromise<BankAccount> {
     return this._client.post('/bank_accounts', { body, ...options });
@@ -21,6 +34,13 @@ export class BankAccounts extends APIResource {
 
   /**
    * Retrieve a bank account by ID.
+   *
+   * @example
+   * ```ts
+   * const bankAccount = await client.bankAccounts.retrieve(
+   *   'id',
+   * );
+   * ```
    */
   retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<BankAccount> {
     return this._client.get(`/bank_accounts/${id}`, options);
@@ -28,6 +48,14 @@ export class BankAccounts extends APIResource {
 
   /**
    * Get a list of bank accounts.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const bankAccount of client.bankAccounts.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: BankAccountListParams,
@@ -46,6 +74,11 @@ export class BankAccounts extends APIResource {
 
   /**
    * Delete a bank account by ID. Note that this operation cannot be undone.
+   *
+   * @example
+   * ```ts
+   * const bankAccount = await client.bankAccounts.delete('id');
+   * ```
    */
   delete(id: string, options?: Core.RequestOptions): Core.APIPromise<BankAccountDeleteResponse> {
     return this._client.delete(`/bank_accounts/${id}`, options);
@@ -106,6 +139,11 @@ export interface BankAccount {
    */
   bankSecondaryLine?: string;
 
+  /**
+   * The designation number of the bank account (for CA).
+   */
+  caDesignationNumber?: string;
+
   /**
    * An optional string describing this resource. Will be visible in the API and the
    * dashboard.
@@ -115,7 +153,7 @@ export interface BankAccount {
   /**
    * See the section on Metadata.
    */
-  metadata?: Record<string, unknown>;
+  metadata?: { [key: string]: unknown };
 
   /**
    * The route number of the bank account (for CA).
@@ -209,6 +247,11 @@ export declare namespace BankAccountCreateParams {
      */
     bankSecondaryLine?: string;
 
+    /**
+     * The designation number of the bank account (for CA).
+     */
+    caDesignationNumber?: string;
+
     /**
      * An optional string describing this resource. Will be visible in the API and the
      * dashboard.
@@ -218,7 +261,7 @@ export declare namespace BankAccountCreateParams {
     /**
      * See the section on Metadata.
      */
-    metadata?: Record<string, unknown>;
+    metadata?: { [key: string]: unknown };
 
     /**
      * The route number of the bank account (for CA).
@@ -269,6 +312,11 @@ export declare namespace BankAccountCreateParams {
      */
     bankSecondaryLine?: string;
 
+    /**
+     * The designation number of the bank account (for CA).
+     */
+    caDesignationNumber?: string;
+
     /**
      * An optional string describing this resource. Will be visible in the API and the
      * dashboard.
@@ -278,7 +326,7 @@ export declare namespace BankAccountCreateParams {
     /**
      * See the section on Metadata.
      */
-    metadata?: Record<string, unknown>;
+    metadata?: { [key: string]: unknown };
 
     /**
      * The route number of the bank account (for CA).
@@ -329,6 +377,11 @@ export declare namespace BankAccountCreateParams {
      */
     bankSecondaryLine?: string;
 
+    /**
+     * The designation number of the bank account (for CA).
+     */
+    caDesignationNumber?: string;
+
     /**
      * An optional string describing this resource. Will be visible in the API and the
      * dashboard.
@@ -338,7 +391,7 @@ export declare namespace BankAccountCreateParams {
     /**
      * See the section on Metadata.
      */
-    metadata?: Record<string, unknown>;
+    metadata?: { [key: string]: unknown };
 
     /**
      * The route number of the bank account (for CA).

package/src/resources/boxes.ts

@@ -25,6 +25,23 @@ export class Boxes extends APIResource {
    * - `bankAccount`: The bank account ID
    * - `amount`: The amount to be sent
    * - `number`: The cheque number
+   *
+   * @example
+   * ```ts
+   * const box = await client.boxes.create({
+   *   cheques: [
+   *     {
+   *       from: 'contact_456',
+   *       to: 'contact_123',
+   *       bankAccount: 'bank_abc',
+   *       amount: 5000,
+   *       number: 1042,
+   *     },
+   *   ],
+   *   from: 'contact_456',
+   *   to: 'contact_123',
+   * });
+   * ```
    */
   create(body: BoxCreateParams, options?: Core.RequestOptions): Core.APIPromise<BoxCreateResponse> {
     return this._client.post('/boxes', { body, ...options });
@@ -32,6 +49,11 @@ export class Boxes extends APIResource {
 
   /**
    * Retrieve a box by ID.
+   *
+   * @example
+   * ```ts
+   * const box = await client.boxes.retrieve('id');
+   * ```
    */
   retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<BoxRetrieveResponse> {
     return this._client.get(`/boxes/${id}`, options);
@@ -39,6 +61,14 @@ export class Boxes extends APIResource {
 
   /**
    * List all boxes.
+   *
+   * @example
+   * ```ts
+   * // Automatically fetches more pages as needed.
+   * for await (const boxListResponse of client.boxes.list()) {
+   *   // ...
+   * }
+   * ```
    */
   list(
     query?: BoxListParams,
@@ -57,6 +87,11 @@ export class Boxes extends APIResource {
 
   /**
    * Cancel a box by ID (cannot be undone).
+   *
+   * @example
+   * ```ts
+   * const response = await client.boxes.cancel('id');
+   * ```
    */
   cancel(id: string, options?: Core.RequestOptions): Core.APIPromise<BoxCancelResponse> {
     return this._client.delete(`/boxes/${id}`, options);
@@ -187,12 +222,12 @@ export interface BoxCreateResponse {
    * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
    * PDFs uploaded with the order.
    */
-  mergeVariables?: Record<string, unknown>;
+  mergeVariables?: { [key: string]: unknown };
 
   /**
    * See the section on Metadata.
    */
-  metadata?: Record<string, unknown>;
+  metadata?: { [key: string]: unknown };
 
   /**
    * The tracking number of this order. Populated after an express/certified order
@@ -248,7 +283,7 @@ export namespace BoxCreateResponse {
      * A set of dynamic merge variables for customizing the cheque or accompanying
      * documents (optional).
      */
-    mergeVariables?: Record<string, unknown>;
+    mergeVariables?: { [key: string]: unknown };
 
     /**
      * An optional message template to be printed on or with the cheque.
@@ -379,12 +414,12 @@ export interface BoxRetrieveResponse {
    * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
    * PDFs uploaded with the order.
    */
-  mergeVariables?: Record<string, unknown>;
+  mergeVariables?: { [key: string]: unknown };
 
   /**
    * See the section on Metadata.
    */
-  metadata?: Record<string, unknown>;
+  metadata?: { [key: string]: unknown };
 
   /**
    * The tracking number of this order. Populated after an express/certified order
@@ -440,7 +475,7 @@ export namespace BoxRetrieveResponse {
      * A set of dynamic merge variables for customizing the cheque or accompanying
      * documents (optional).
      */
-    mergeVariables?: Record<string, unknown>;
+    mergeVariables?: { [key: string]: unknown };
 
     /**
      * An optional message template to be printed on or with the cheque.
@@ -571,12 +606,12 @@ export interface BoxListResponse {
    * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
    * PDFs uploaded with the order.
    */
-  mergeVariables?: Record<string, unknown>;
+  mergeVariables?: { [key: string]: unknown };
 
   /**
    * See the section on Metadata.
    */
-  metadata?: Record<string, unknown>;
+  metadata?: { [key: string]: unknown };
 
   /**
    * The tracking number of this order. Populated after an express/certified order
@@ -632,7 +667,7 @@ export namespace BoxListResponse {
      * A set of dynamic merge variables for customizing the cheque or accompanying
      * documents (optional).
      */
-    mergeVariables?: Record<string, unknown>;
+    mergeVariables?: { [key: string]: unknown };
 
     /**
      * An optional message template to be printed on or with the cheque.
@@ -763,12 +798,12 @@ export interface BoxCancelResponse {
    * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
    * PDFs uploaded with the order.
    */
-  mergeVariables?: Record<string, unknown>;
+  mergeVariables?: { [key: string]: unknown };
 
   /**
    * See the section on Metadata.
    */
-  metadata?: Record<string, unknown>;
+  metadata?: { [key: string]: unknown };
 
   /**
    * The tracking number of this order. Populated after an express/certified order
@@ -824,7 +859,7 @@ export namespace BoxCancelResponse {
      * A set of dynamic merge variables for customizing the cheque or accompanying
      * documents (optional).
      */
-    mergeVariables?: Record<string, unknown>;
+    mergeVariables?: { [key: string]: unknown };
 
     /**
      * An optional message template to be printed on or with the cheque.
@@ -898,12 +933,12 @@ export interface BoxCreateParams {
    * template _exactly_ as they are case-sensitive. Note that these _do not_ apply to
    * PDFs uploaded with the order.
    */
-  mergeVariables?: Record<string, unknown>;
+  mergeVariables?: { [key: string]: unknown };
 
   /**
    * See the section on Metadata.
    */
-  metadata?: Record<string, unknown>;
+  metadata?: { [key: string]: unknown };
 
   /**
    * This order will transition from `ready` to `printing` on the day after this
@@ -947,7 +982,7 @@ export namespace BoxCreateParams {
      * A set of dynamic merge variables for customizing the cheque or accompanying
      * documents (optional).
      */
-    mergeVariables?: Record<string, unknown>;
+    mergeVariables?: { [key: string]: unknown };
 
     /**
      * An optional message template to be printed on or with the cheque.

package/src/resources/campaigns.ts

@@ -166,7 +166,7 @@ export interface CampaignCreateResponse {
   /**
    * See the section on Metadata.
    */
-  metadata?: Record<string, unknown>;
+  metadata?: { [key: string]: unknown };
 
   /**
    * A temporary URL to preview the first rendered order, available once the campaign
@@ -290,7 +290,7 @@ export interface CampaignRetrieveResponse {
   /**
    * See the section on Metadata.
    */
-  metadata?: Record<string, unknown>;
+  metadata?: { [key: string]: unknown };
 
   /**
    * A temporary URL to preview the first rendered order, available once the campaign
@@ -414,7 +414,7 @@ export interface CampaignUpdateResponse {
   /**
    * See the section on Metadata.
    */
-  metadata?: Record<string, unknown>;
+  metadata?: { [key: string]: unknown };
 
   /**
    * A temporary URL to preview the first rendered order, available once the campaign
@@ -538,7 +538,7 @@ export interface CampaignListResponse {
   /**
    * See the section on Metadata.
    */
-  metadata?: Record<string, unknown>;
+  metadata?: { [key: string]: unknown };
 
   /**
    * A temporary URL to preview the first rendered order, available once the campaign
@@ -671,7 +671,7 @@ export interface CampaignSendResponse {
   /**
    * See the section on Metadata.
    */
-  metadata?: Record<string, unknown>;
+  metadata?: { [key: string]: unknown };
 
   /**
    * A temporary URL to preview the first rendered order, available once the campaign
@@ -749,7 +749,7 @@ export interface CampaignCreateParams {
   /**
    * See the section on Metadata.
    */
-  metadata?: Record<string, unknown>;
+  metadata?: { [key: string]: unknown };
 
   /**
    * The ID of the postcard profile used for this campaign, if applicable.
@@ -800,7 +800,7 @@ export interface CampaignUpdateParams {
    * Optional key-value data associated with the campaign. Set to `null` to remove
    * existing metadata.
    */
-  metadata?: Record<string, string> | null;
+  metadata?: { [key: string]: string } | null;
 
   /**
    * The ID of the postcard profile to use. Setting this will remove other profile
@@ -831,7 +831,7 @@ export interface CampaignSendParams {
    * The date and time the campaign should be sent. Must be in the future. If
    * omitted, defaults to the earliest possible processing date.
    */
-  sendDate?: string | string;
+  sendDate?: (string & {}) | string;
 }
 
 Campaigns.CampaignListResponsesList = CampaignListResponsesList;