@codeqr/ts 0.1.2

package/src/resources/analytics.ts

@@ -0,0 +1,1617 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+export class Analytics extends APIResource {
+  /**
+   * Retrieve analytics for a link, a domain, or the authenticated workspace. The
+   * response type depends on the `event` and `type` query parameters.
+   */
+  retrieve(
+    query: AnalyticsRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<AnalyticsRetrieveResponse> {
+    return this._client.get('/analytics', { query, ...options });
+  }
+}
+
+/**
+ * The continent to retrieve analytics for.
+ */
+export type ContinentCode = 'AF' | 'AN' | 'AS' | 'EU' | 'NA' | 'OC' | 'SA';
+
+/**
+ * The country to retrieve analytics for.
+ */
+export type CountryCode =
+  | 'AF'
+  | 'AL'
+  | 'DZ'
+  | 'AS'
+  | 'AD'
+  | 'AO'
+  | 'AI'
+  | 'AQ'
+  | 'AG'
+  | 'AR'
+  | 'AM'
+  | 'AW'
+  | 'AU'
+  | 'AT'
+  | 'AZ'
+  | 'BS'
+  | 'BH'
+  | 'BD'
+  | 'BB'
+  | 'BY'
+  | 'BE'
+  | 'BZ'
+  | 'BJ'
+  | 'BM'
+  | 'BT'
+  | 'BO'
+  | 'BA'
+  | 'BW'
+  | 'BV'
+  | 'BR'
+  | 'IO'
+  | 'BN'
+  | 'BG'
+  | 'BF'
+  | 'BI'
+  | 'KH'
+  | 'CM'
+  | 'CA'
+  | 'CV'
+  | 'KY'
+  | 'CF'
+  | 'TD'
+  | 'CL'
+  | 'CN'
+  | 'CX'
+  | 'CC'
+  | 'CO'
+  | 'KM'
+  | 'CG'
+  | 'CD'
+  | 'CK'
+  | 'CR'
+  | 'CI'
+  | 'HR'
+  | 'CU'
+  | 'CY'
+  | 'CZ'
+  | 'DK'
+  | 'DJ'
+  | 'DM'
+  | 'DO'
+  | 'EC'
+  | 'EG'
+  | 'SV'
+  | 'GQ'
+  | 'ER'
+  | 'EE'
+  | 'ET'
+  | 'FK'
+  | 'FO'
+  | 'FJ'
+  | 'FI'
+  | 'FR'
+  | 'GF'
+  | 'PF'
+  | 'TF'
+  | 'GA'
+  | 'GM'
+  | 'GE'
+  | 'DE'
+  | 'GH'
+  | 'GI'
+  | 'GR'
+  | 'GL'
+  | 'GD'
+  | 'GP'
+  | 'GU'
+  | 'GT'
+  | 'GN'
+  | 'GW'
+  | 'GY'
+  | 'HT'
+  | 'HM'
+  | 'VA'
+  | 'HN'
+  | 'HK'
+  | 'HU'
+  | 'IS'
+  | 'IN'
+  | 'ID'
+  | 'IR'
+  | 'IQ'
+  | 'IE'
+  | 'IL'
+  | 'IT'
+  | 'JM'
+  | 'JP'
+  | 'JO'
+  | 'KZ'
+  | 'KE'
+  | 'KI'
+  | 'KP'
+  | 'KR'
+  | 'KW'
+  | 'KG'
+  | 'LA'
+  | 'LV'
+  | 'LB'
+  | 'LS'
+  | 'LR'
+  | 'LY'
+  | 'LI'
+  | 'LT'
+  | 'LU'
+  | 'MO'
+  | 'MG'
+  | 'MW'
+  | 'MY'
+  | 'MV'
+  | 'ML'
+  | 'MT'
+  | 'MH'
+  | 'MQ'
+  | 'MR'
+  | 'MU'
+  | 'YT'
+  | 'MX'
+  | 'FM'
+  | 'MD'
+  | 'MC'
+  | 'MN'
+  | 'MS'
+  | 'MA'
+  | 'MZ'
+  | 'MM'
+  | 'NA'
+  | 'NR'
+  | 'NP'
+  | 'NL'
+  | 'NC'
+  | 'NZ'
+  | 'NI'
+  | 'NE'
+  | 'NG'
+  | 'NU'
+  | 'NF'
+  | 'MK'
+  | 'MP'
+  | 'NO'
+  | 'OM'
+  | 'PK'
+  | 'PW'
+  | 'PS'
+  | 'PA'
+  | 'PG'
+  | 'PY'
+  | 'PE'
+  | 'PH'
+  | 'PN'
+  | 'PL'
+  | 'PT'
+  | 'PR'
+  | 'QA'
+  | 'RE'
+  | 'RO'
+  | 'RU'
+  | 'RW'
+  | 'SH'
+  | 'KN'
+  | 'LC'
+  | 'PM'
+  | 'VC'
+  | 'WS'
+  | 'SM'
+  | 'ST'
+  | 'SA'
+  | 'SN'
+  | 'SC'
+  | 'SL'
+  | 'SG'
+  | 'SK'
+  | 'SI'
+  | 'SB'
+  | 'SO'
+  | 'ZA'
+  | 'GS'
+  | 'ES'
+  | 'LK'
+  | 'SD'
+  | 'SR'
+  | 'SJ'
+  | 'SZ'
+  | 'SE'
+  | 'CH'
+  | 'SY'
+  | 'TW'
+  | 'TJ'
+  | 'TZ'
+  | 'TH'
+  | 'TL'
+  | 'TG'
+  | 'TK'
+  | 'TO'
+  | 'TT'
+  | 'TN'
+  | 'TR'
+  | 'TM'
+  | 'TC'
+  | 'TV'
+  | 'UG'
+  | 'UA'
+  | 'AE'
+  | 'GB'
+  | 'US'
+  | 'UM'
+  | 'UY'
+  | 'UZ'
+  | 'VU'
+  | 'VE'
+  | 'VN'
+  | 'VG'
+  | 'VI'
+  | 'WF'
+  | 'EH'
+  | 'YE'
+  | 'ZM'
+  | 'ZW'
+  | 'AX'
+  | 'BQ'
+  | 'CW'
+  | 'GG'
+  | 'IM'
+  | 'JE'
+  | 'ME'
+  | 'BL'
+  | 'MF'
+  | 'RS'
+  | 'SX'
+  | 'SS'
+  | 'XK';
+
+export type AnalyticsRetrieveResponse =
+  | AnalyticsRetrieveResponse.AnalyticsCount
+  | Array<AnalyticsRetrieveResponse.AnalyticsTimesery>
+  | Array<AnalyticsRetrieveResponse.AnalyticsContinent>
+  | Array<AnalyticsRetrieveResponse.AnalyticsCountry>
+  | Array<AnalyticsRetrieveResponse.AnalyticsRegion>
+  | Array<AnalyticsRetrieveResponse.AnalyticsCity>
+  | Array<AnalyticsRetrieveResponse.AnalyticsDevice>
+  | Array<AnalyticsRetrieveResponse.AnalyticsBrowser>
+  | Array<AnalyticsRetrieveResponse.AnalyticsO>
+  | Array<AnalyticsRetrieveResponse.AnalyticsReferer>
+  | Array<AnalyticsRetrieveResponse.AnalyticsRefererURL>
+  | Array<AnalyticsRetrieveResponse.AnalyticsTopLink>
+  | Array<AnalyticsRetrieveResponse.AnalyticsTopURL>;
+
+export namespace AnalyticsRetrieveResponse {
+  export interface AnalyticsCount {
+    /**
+     * The total number of clicks
+     */
+    clicks: number;
+
+    /**
+     * The total number of leads
+     */
+    leads: number;
+
+    /**
+     * The total amount of sales, in cents
+     */
+    saleAmount: number;
+
+    /**
+     * The total number of sales
+     */
+    sales: number;
+
+    /**
+     * The total number of scans
+     */
+    scans: number;
+
+    /**
+     * The total number of views
+     */
+    viwes: number;
+  }
+
+  export interface AnalyticsTimesery {
+    /**
+     * The number of clicks in the interval
+     */
+    clicks: number;
+
+    /**
+     * The number of leads in the interval
+     */
+    leads: number;
+
+    /**
+     * The total amount of sales in the interval, in cents
+     */
+    saleAmount: number;
+
+    /**
+     * The number of sales in the interval
+     */
+    sales: number;
+
+    /**
+     * The number of scans in the interval
+     */
+    scans: number;
+
+    /**
+     * The starting timestamp of the interval
+     */
+    start: string;
+
+    /**
+     * The number of views in the interval
+     */
+    views: number;
+  }
+
+  export interface AnalyticsContinent {
+    /**
+     * The number of clicks from this continent
+     */
+    clicks: number;
+
+    /**
+     * The number of leads from this continent
+     */
+    leads: number;
+
+    /**
+     * The total amount of sales from this continent, in cents
+     */
+    saleAmount: number;
+
+    /**
+     * The number of sales from this continent
+     */
+    sales: number;
+
+    /**
+     * The 2-letter ISO 3166-1 code representing the continent associated with the
+     * location of the user.
+     */
+    continent?: 'AF' | 'AN' | 'AS' | 'EU' | 'NA' | 'OC' | 'SA';
+  }
+
+  export interface AnalyticsCountry {
+    city: '*';
+
+    /**
+     * The number of clicks from this country
+     */
+    clicks: number;
+
+    /**
+     * The 2-letter ISO 3166-1 country code for the country associated with the
+     * location of the user. Learn more: https://codeqr.io/geo
+     */
+    country:
+      | 'AF'
+      | 'AL'
+      | 'DZ'
+      | 'AS'
+      | 'AD'
+      | 'AO'
+      | 'AI'
+      | 'AQ'
+      | 'AG'
+      | 'AR'
+      | 'AM'
+      | 'AW'
+      | 'AU'
+      | 'AT'
+      | 'AZ'
+      | 'BS'
+      | 'BH'
+      | 'BD'
+      | 'BB'
+      | 'BY'
+      | 'BE'
+      | 'BZ'
+      | 'BJ'
+      | 'BM'
+      | 'BT'
+      | 'BO'
+      | 'BA'
+      | 'BW'
+      | 'BV'
+      | 'BR'
+      | 'IO'
+      | 'BN'
+      | 'BG'
+      | 'BF'
+      | 'BI'
+      | 'KH'
+      | 'CM'
+      | 'CA'
+      | 'CV'
+      | 'KY'
+      | 'CF'
+      | 'TD'
+      | 'CL'
+      | 'CN'
+      | 'CX'
+      | 'CC'
+      | 'CO'
+      | 'KM'
+      | 'CG'
+      | 'CD'
+      | 'CK'
+      | 'CR'
+      | 'CI'
+      | 'HR'
+      | 'CU'
+      | 'CY'
+      | 'CZ'
+      | 'DK'
+      | 'DJ'
+      | 'DM'
+      | 'DO'
+      | 'EC'
+      | 'EG'
+      | 'SV'
+      | 'GQ'
+      | 'ER'
+      | 'EE'
+      | 'ET'
+      | 'FK'
+      | 'FO'
+      | 'FJ'
+      | 'FI'
+      | 'FR'
+      | 'GF'
+      | 'PF'
+      | 'TF'
+      | 'GA'
+      | 'GM'
+      | 'GE'
+      | 'DE'
+      | 'GH'
+      | 'GI'
+      | 'GR'
+      | 'GL'
+      | 'GD'
+      | 'GP'
+      | 'GU'
+      | 'GT'
+      | 'GN'
+      | 'GW'
+      | 'GY'
+      | 'HT'
+      | 'HM'
+      | 'VA'
+      | 'HN'
+      | 'HK'
+      | 'HU'
+      | 'IS'
+      | 'IN'
+      | 'ID'
+      | 'IR'
+      | 'IQ'
+      | 'IE'
+      | 'IL'
+      | 'IT'
+      | 'JM'
+      | 'JP'
+      | 'JO'
+      | 'KZ'
+      | 'KE'
+      | 'KI'
+      | 'KP'
+      | 'KR'
+      | 'KW'
+      | 'KG'
+      | 'LA'
+      | 'LV'
+      | 'LB'
+      | 'LS'
+      | 'LR'
+      | 'LY'
+      | 'LI'
+      | 'LT'
+      | 'LU'
+      | 'MO'
+      | 'MG'
+      | 'MW'
+      | 'MY'
+      | 'MV'
+      | 'ML'
+      | 'MT'
+      | 'MH'
+      | 'MQ'
+      | 'MR'
+      | 'MU'
+      | 'YT'
+      | 'MX'
+      | 'FM'
+      | 'MD'
+      | 'MC'
+      | 'MN'
+      | 'MS'
+      | 'MA'
+      | 'MZ'
+      | 'MM'
+      | 'NA'
+      | 'NR'
+      | 'NP'
+      | 'NL'
+      | 'NC'
+      | 'NZ'
+      | 'NI'
+      | 'NE'
+      | 'NG'
+      | 'NU'
+      | 'NF'
+      | 'MK'
+      | 'MP'
+      | 'NO'
+      | 'OM'
+      | 'PK'
+      | 'PW'
+      | 'PS'
+      | 'PA'
+      | 'PG'
+      | 'PY'
+      | 'PE'
+      | 'PH'
+      | 'PN'
+      | 'PL'
+      | 'PT'
+      | 'PR'
+      | 'QA'
+      | 'RE'
+      | 'RO'
+      | 'RU'
+      | 'RW'
+      | 'SH'
+      | 'KN'
+      | 'LC'
+      | 'PM'
+      | 'VC'
+      | 'WS'
+      | 'SM'
+      | 'ST'
+      | 'SA'
+      | 'SN'
+      | 'SC'
+      | 'SL'
+      | 'SG'
+      | 'SK'
+      | 'SI'
+      | 'SB'
+      | 'SO'
+      | 'ZA'
+      | 'GS'
+      | 'ES'
+      | 'LK'
+      | 'SD'
+      | 'SR'
+      | 'SJ'
+      | 'SZ'
+      | 'SE'
+      | 'CH'
+      | 'SY'
+      | 'TW'
+      | 'TJ'
+      | 'TZ'
+      | 'TH'
+      | 'TL'
+      | 'TG'
+      | 'TK'
+      | 'TO'
+      | 'TT'
+      | 'TN'
+      | 'TR'
+      | 'TM'
+      | 'TC'
+      | 'TV'
+      | 'UG'
+      | 'UA'
+      | 'AE'
+      | 'GB'
+      | 'US'
+      | 'UM'
+      | 'UY'
+      | 'UZ'
+      | 'VU'
+      | 'VE'
+      | 'VN'
+      | 'VG'
+      | 'VI'
+      | 'WF'
+      | 'EH'
+      | 'YE'
+      | 'ZM'
+      | 'ZW'
+      | 'AX'
+      | 'BQ'
+      | 'CW'
+      | 'GG'
+      | 'IM'
+      | 'JE'
+      | 'ME'
+      | 'BL'
+      | 'MF'
+      | 'RS'
+      | 'SX'
+      | 'SS'
+      | 'XK';
+
+    /**
+     * The number of leads from this country
+     */
+    leads: number;
+
+    /**
+     * The total amount of sales from this country, in cents
+     */
+    saleAmount: number;
+
+    /**
+     * The number of sales from this country
+     */
+    sales: number;
+  }
+
+  export interface AnalyticsRegion {
+    city: '*';
+
+    /**
+     * The number of clicks from this region
+     */
+    clicks: number;
+
+    /**
+     * The 2-letter country code of the region: https://d.to/geo
+     */
+    country:
+      | 'AF'
+      | 'AL'
+      | 'DZ'
+      | 'AS'
+      | 'AD'
+      | 'AO'
+      | 'AI'
+      | 'AQ'
+      | 'AG'
+      | 'AR'
+      | 'AM'
+      | 'AW'
+      | 'AU'
+      | 'AT'
+      | 'AZ'
+      | 'BS'
+      | 'BH'
+      | 'BD'
+      | 'BB'
+      | 'BY'
+      | 'BE'
+      | 'BZ'
+      | 'BJ'
+      | 'BM'
+      | 'BT'
+      | 'BO'
+      | 'BA'
+      | 'BW'
+      | 'BV'
+      | 'BR'
+      | 'IO'
+      | 'BN'
+      | 'BG'
+      | 'BF'
+      | 'BI'
+      | 'KH'
+      | 'CM'
+      | 'CA'
+      | 'CV'
+      | 'KY'
+      | 'CF'
+      | 'TD'
+      | 'CL'
+      | 'CN'
+      | 'CX'
+      | 'CC'
+      | 'CO'
+      | 'KM'
+      | 'CG'
+      | 'CD'
+      | 'CK'
+      | 'CR'
+      | 'CI'
+      | 'HR'
+      | 'CU'
+      | 'CY'
+      | 'CZ'
+      | 'DK'
+      | 'DJ'
+      | 'DM'
+      | 'DO'
+      | 'EC'
+      | 'EG'
+      | 'SV'
+      | 'GQ'
+      | 'ER'
+      | 'EE'
+      | 'ET'
+      | 'FK'
+      | 'FO'
+      | 'FJ'
+      | 'FI'
+      | 'FR'
+      | 'GF'
+      | 'PF'
+      | 'TF'
+      | 'GA'
+      | 'GM'
+      | 'GE'
+      | 'DE'
+      | 'GH'
+      | 'GI'
+      | 'GR'
+      | 'GL'
+      | 'GD'
+      | 'GP'
+      | 'GU'
+      | 'GT'
+      | 'GN'
+      | 'GW'
+      | 'GY'
+      | 'HT'
+      | 'HM'
+      | 'VA'
+      | 'HN'
+      | 'HK'
+      | 'HU'
+      | 'IS'
+      | 'IN'
+      | 'ID'
+      | 'IR'
+      | 'IQ'
+      | 'IE'
+      | 'IL'
+      | 'IT'
+      | 'JM'
+      | 'JP'
+      | 'JO'
+      | 'KZ'
+      | 'KE'
+      | 'KI'
+      | 'KP'
+      | 'KR'
+      | 'KW'
+      | 'KG'
+      | 'LA'
+      | 'LV'
+      | 'LB'
+      | 'LS'
+      | 'LR'
+      | 'LY'
+      | 'LI'
+      | 'LT'
+      | 'LU'
+      | 'MO'
+      | 'MG'
+      | 'MW'
+      | 'MY'
+      | 'MV'
+      | 'ML'
+      | 'MT'
+      | 'MH'
+      | 'MQ'
+      | 'MR'
+      | 'MU'
+      | 'YT'
+      | 'MX'
+      | 'FM'
+      | 'MD'
+      | 'MC'
+      | 'MN'
+      | 'MS'
+      | 'MA'
+      | 'MZ'
+      | 'MM'
+      | 'NA'
+      | 'NR'
+      | 'NP'
+      | 'NL'
+      | 'NC'
+      | 'NZ'
+      | 'NI'
+      | 'NE'
+      | 'NG'
+      | 'NU'
+      | 'NF'
+      | 'MK'
+      | 'MP'
+      | 'NO'
+      | 'OM'
+      | 'PK'
+      | 'PW'
+      | 'PS'
+      | 'PA'
+      | 'PG'
+      | 'PY'
+      | 'PE'
+      | 'PH'
+      | 'PN'
+      | 'PL'
+      | 'PT'
+      | 'PR'
+      | 'QA'
+      | 'RE'
+      | 'RO'
+      | 'RU'
+      | 'RW'
+      | 'SH'
+      | 'KN'
+      | 'LC'
+      | 'PM'
+      | 'VC'
+      | 'WS'
+      | 'SM'
+      | 'ST'
+      | 'SA'
+      | 'SN'
+      | 'SC'
+      | 'SL'
+      | 'SG'
+      | 'SK'
+      | 'SI'
+      | 'SB'
+      | 'SO'
+      | 'ZA'
+      | 'GS'
+      | 'ES'
+      | 'LK'
+      | 'SD'
+      | 'SR'
+      | 'SJ'
+      | 'SZ'
+      | 'SE'
+      | 'CH'
+      | 'SY'
+      | 'TW'
+      | 'TJ'
+      | 'TZ'
+      | 'TH'
+      | 'TL'
+      | 'TG'
+      | 'TK'
+      | 'TO'
+      | 'TT'
+      | 'TN'
+      | 'TR'
+      | 'TM'
+      | 'TC'
+      | 'TV'
+      | 'UG'
+      | 'UA'
+      | 'AE'
+      | 'GB'
+      | 'US'
+      | 'UM'
+      | 'UY'
+      | 'UZ'
+      | 'VU'
+      | 'VE'
+      | 'VN'
+      | 'VG'
+      | 'VI'
+      | 'WF'
+      | 'EH'
+      | 'YE'
+      | 'ZM'
+      | 'ZW'
+      | 'AX'
+      | 'BQ'
+      | 'CW'
+      | 'GG'
+      | 'IM'
+      | 'JE'
+      | 'ME'
+      | 'BL'
+      | 'MF'
+      | 'RS'
+      | 'SX'
+      | 'SS'
+      | 'XK';
+
+    /**
+     * The number of leads from this region
+     */
+    leads: number;
+
+    /**
+     * The 2-letter ISO 3166-2 region code representing the region associated with the
+     * location of the user.
+     */
+    region: string;
+
+    /**
+     * The total amount of sales from this region, in cents
+     */
+    saleAmount: number;
+
+    /**
+     * The number of sales from this region
+     */
+    sales: number;
+  }
+
+  export interface AnalyticsCity {
+    /**
+     * The name of the city
+     */
+    city: string;
+
+    /**
+     * The number of clicks from this city
+     */
+    clicks: number;
+
+    /**
+     * The 2-letter country code of the city: https://codeqr.io/geo
+     */
+    country:
+      | 'AF'
+      | 'AL'
+      | 'DZ'
+      | 'AS'
+      | 'AD'
+      | 'AO'
+      | 'AI'
+      | 'AQ'
+      | 'AG'
+      | 'AR'
+      | 'AM'
+      | 'AW'
+      | 'AU'
+      | 'AT'
+      | 'AZ'
+      | 'BS'
+      | 'BH'
+      | 'BD'
+      | 'BB'
+      | 'BY'
+      | 'BE'
+      | 'BZ'
+      | 'BJ'
+      | 'BM'
+      | 'BT'
+      | 'BO'
+      | 'BA'
+      | 'BW'
+      | 'BV'
+      | 'BR'
+      | 'IO'
+      | 'BN'
+      | 'BG'
+      | 'BF'
+      | 'BI'
+      | 'KH'
+      | 'CM'
+      | 'CA'
+      | 'CV'
+      | 'KY'
+      | 'CF'
+      | 'TD'
+      | 'CL'
+      | 'CN'
+      | 'CX'
+      | 'CC'
+      | 'CO'
+      | 'KM'
+      | 'CG'
+      | 'CD'
+      | 'CK'
+      | 'CR'
+      | 'CI'
+      | 'HR'
+      | 'CU'
+      | 'CY'
+      | 'CZ'
+      | 'DK'
+      | 'DJ'
+      | 'DM'
+      | 'DO'
+      | 'EC'
+      | 'EG'
+      | 'SV'
+      | 'GQ'
+      | 'ER'
+      | 'EE'
+      | 'ET'
+      | 'FK'
+      | 'FO'
+      | 'FJ'
+      | 'FI'
+      | 'FR'
+      | 'GF'
+      | 'PF'
+      | 'TF'
+      | 'GA'
+      | 'GM'
+      | 'GE'
+      | 'DE'
+      | 'GH'
+      | 'GI'
+      | 'GR'
+      | 'GL'
+      | 'GD'
+      | 'GP'
+      | 'GU'
+      | 'GT'
+      | 'GN'
+      | 'GW'
+      | 'GY'
+      | 'HT'
+      | 'HM'
+      | 'VA'
+      | 'HN'
+      | 'HK'
+      | 'HU'
+      | 'IS'
+      | 'IN'
+      | 'ID'
+      | 'IR'
+      | 'IQ'
+      | 'IE'
+      | 'IL'
+      | 'IT'
+      | 'JM'
+      | 'JP'
+      | 'JO'
+      | 'KZ'
+      | 'KE'
+      | 'KI'
+      | 'KP'
+      | 'KR'
+      | 'KW'
+      | 'KG'
+      | 'LA'
+      | 'LV'
+      | 'LB'
+      | 'LS'
+      | 'LR'
+      | 'LY'
+      | 'LI'
+      | 'LT'
+      | 'LU'
+      | 'MO'
+      | 'MG'
+      | 'MW'
+      | 'MY'
+      | 'MV'
+      | 'ML'
+      | 'MT'
+      | 'MH'
+      | 'MQ'
+      | 'MR'
+      | 'MU'
+      | 'YT'
+      | 'MX'
+      | 'FM'
+      | 'MD'
+      | 'MC'
+      | 'MN'
+      | 'MS'
+      | 'MA'
+      | 'MZ'
+      | 'MM'
+      | 'NA'
+      | 'NR'
+      | 'NP'
+      | 'NL'
+      | 'NC'
+      | 'NZ'
+      | 'NI'
+      | 'NE'
+      | 'NG'
+      | 'NU'
+      | 'NF'
+      | 'MK'
+      | 'MP'
+      | 'NO'
+      | 'OM'
+      | 'PK'
+      | 'PW'
+      | 'PS'
+      | 'PA'
+      | 'PG'
+      | 'PY'
+      | 'PE'
+      | 'PH'
+      | 'PN'
+      | 'PL'
+      | 'PT'
+      | 'PR'
+      | 'QA'
+      | 'RE'
+      | 'RO'
+      | 'RU'
+      | 'RW'
+      | 'SH'
+      | 'KN'
+      | 'LC'
+      | 'PM'
+      | 'VC'
+      | 'WS'
+      | 'SM'
+      | 'ST'
+      | 'SA'
+      | 'SN'
+      | 'SC'
+      | 'SL'
+      | 'SG'
+      | 'SK'
+      | 'SI'
+      | 'SB'
+      | 'SO'
+      | 'ZA'
+      | 'GS'
+      | 'ES'
+      | 'LK'
+      | 'SD'
+      | 'SR'
+      | 'SJ'
+      | 'SZ'
+      | 'SE'
+      | 'CH'
+      | 'SY'
+      | 'TW'
+      | 'TJ'
+      | 'TZ'
+      | 'TH'
+      | 'TL'
+      | 'TG'
+      | 'TK'
+      | 'TO'
+      | 'TT'
+      | 'TN'
+      | 'TR'
+      | 'TM'
+      | 'TC'
+      | 'TV'
+      | 'UG'
+      | 'UA'
+      | 'AE'
+      | 'GB'
+      | 'US'
+      | 'UM'
+      | 'UY'
+      | 'UZ'
+      | 'VU'
+      | 'VE'
+      | 'VN'
+      | 'VG'
+      | 'VI'
+      | 'WF'
+      | 'EH'
+      | 'YE'
+      | 'ZM'
+      | 'ZW'
+      | 'AX'
+      | 'BQ'
+      | 'CW'
+      | 'GG'
+      | 'IM'
+      | 'JE'
+      | 'ME'
+      | 'BL'
+      | 'MF'
+      | 'RS'
+      | 'SX'
+      | 'SS'
+      | 'XK';
+
+    /**
+     * The number of leads from this city
+     */
+    leads: number;
+
+    /**
+     * The total amount of sales from this city, in cents
+     */
+    saleAmount: number;
+
+    /**
+     * The number of sales from this city
+     */
+    sales: number;
+  }
+
+  export interface AnalyticsDevice {
+    /**
+     * The number of clicks from this device
+     */
+    clicks: number;
+
+    /**
+     * The name of the device
+     */
+    device: string;
+
+    /**
+     * The number of leads from this device
+     */
+    leads: number;
+
+    /**
+     * The total amount of sales from this device, in cents
+     */
+    saleAmount: number;
+
+    /**
+     * The number of sales from this device
+     */
+    sales: number;
+  }
+
+  export interface AnalyticsBrowser {
+    /**
+     * The name of the browser
+     */
+    browser: string;
+
+    /**
+     * The number of clicks from this browser
+     */
+    clicks: number;
+
+    /**
+     * The number of leads from this browser
+     */
+    leads: number;
+
+    /**
+     * The total amount of sales from this browser, in cents
+     */
+    saleAmount: number;
+
+    /**
+     * The number of sales from this browser
+     */
+    sales: number;
+  }
+
+  export interface AnalyticsO {
+    /**
+     * The number of clicks from this OS
+     */
+    clicks: number;
+
+    /**
+     * The number of leads from this OS
+     */
+    leads: number;
+
+    /**
+     * The name of the OS
+     */
+    os: string;
+
+    /**
+     * The total amount of sales from this OS, in cents
+     */
+    saleAmount: number;
+
+    /**
+     * The number of sales from this OS
+     */
+    sales: number;
+  }
+
+  export interface AnalyticsReferer {
+    /**
+     * The number of clicks from this referer
+     */
+    clicks: number;
+
+    /**
+     * The number of leads from this referer
+     */
+    leads: number;
+
+    /**
+     * The name of the referer. If unknown, this will be `(direct)`
+     */
+    referer: string;
+
+    /**
+     * The total amount of sales from this referer, in cents
+     */
+    saleAmount: number;
+
+    /**
+     * The number of sales from this referer
+     */
+    sales: number;
+  }
+
+  export interface AnalyticsRefererURL {
+    /**
+     * The number of clicks from this referer to this URL
+     */
+    clicks: number;
+
+    /**
+     * The number of leads from this referer to this URL
+     */
+    leads: number;
+
+    /**
+     * The full URL of the referer. If unknown, this will be `(direct)`
+     */
+    refererUrl: string;
+
+    /**
+     * The total amount of sales from this referer to this URL, in cents
+     */
+    saleAmount: number;
+
+    /**
+     * The number of sales from this referer to this URL
+     */
+    sales: number;
+  }
+
+  export interface AnalyticsTopLink {
+    /**
+     * The unique ID of the short link
+     */
+    id: string;
+
+    /**
+     * The number of clicks from this link
+     */
+    clicks: number;
+
+    /**
+     * The creation timestamp of the short link
+     */
+    createdAt: string;
+
+    /**
+     * The domain of the short link
+     */
+    domain: string;
+
+    /**
+     * The key of the short link
+     */
+    key: string;
+
+    /**
+     * The number of leads from this link
+     */
+    leads: number;
+
+    /**
+     * @deprecated The unique ID of the short link
+     */
+    link: string;
+
+    /**
+     * The short link URL
+     */
+    shortLink: string;
+
+    /**
+     * The destination URL of the short link
+     */
+    url: string;
+  }
+
+  export interface AnalyticsTopURL {
+    /**
+     * The number of clicks from this URL
+     */
+    clicks: number;
+
+    /**
+     * The number of leads from this URL
+     */
+    leads: number;
+
+    /**
+     * The total amount of sales from this URL, in cents
+     */
+    saleAmount: number;
+
+    /**
+     * The number of sales from this URL
+     */
+    sales: number;
+
+    /**
+     * The destination URL
+     */
+    url: string;
+  }
+}
+
+export interface AnalyticsRetrieveParams {
+  /**
+   * The browser to retrieve analytics for.
+   */
+  browser?: string;
+
+  /**
+   * The city to retrieve analytics for.
+   */
+  city?: string;
+
+  /**
+   * The continent to retrieve analytics for.
+   */
+  continent?: ContinentCode;
+
+  /**
+   * The country to retrieve analytics for.
+   */
+  country?: CountryCode;
+
+  /**
+   * The device to retrieve analytics for.
+   */
+  device?: string;
+
+  /**
+   * The domain of the short link.
+   */
+  domain?: string;
+
+  /**
+   * The end date and time when to retrieve analytics from. If not provided, defaults
+   * to the current date.
+   */
+  end?: string;
+
+  /**
+   * The type of event to retrieve analytics for. Defaults to 'analytics'.
+   */
+  event?: 'clicks' | 'leads' | 'sales' | 'scans' | 'views' | 'composite';
+
+  /**
+   * Whether to exclude the root link from the response.
+   */
+  excludeRoot?: boolean;
+
+  /**
+   * This is the ID of the link in the your database. Must be prefixed with 'ext\_'
+   * when passed as a query parameter.
+   */
+  externalId?: string;
+
+  /**
+   * The parameter to group the analytics data points by. Defaults to 'count' if
+   * undefined.
+   */
+  groupBy?:
+    | 'timeseries'
+    | 'clicks'
+    | 'count'
+    | 'totals'
+    | 'top_urls'
+    | 'top_links'
+    | 'top_qrcodes'
+    | 'top_pages'
+    | 'top_events'
+    | 'scans'
+    | 'views'
+    | 'country'
+    | 'city'
+    | 'region'
+    | 'devices'
+    | 'browsers'
+    | 'os'
+    | 'referers'
+    | 'referer_urls'
+    | 'trend_live'
+    | 'kpis'
+    | 'analytics'
+    | 'continents'
+    | 'countries'
+    | 'cities'
+    | 'leads'
+    | 'sales'
+    | 'composite';
+
+  /**
+   * The interval to retrieve analytics for. Takes precedence over start and end.
+   */
+  interval?: '1h' | '24h' | '7d' | '30d' | '90d' | 'ytd' | '1y' | 'all' | 'all_unfiltered';
+
+  /**
+   * The short link slug.
+   */
+  key?: string;
+
+  /**
+   * The unique ID of the short link on CodeQR.
+   */
+  linkId?: string;
+
+  /**
+   * The OS to retrieve analytics for.
+   */
+  os?: string;
+
+  /**
+   * The unique ID of the page on CodeQR.
+   */
+  pageId?: string;
+
+  /**
+   * The unique ID of the QR code on CodeQR.
+   */
+  qrcodeId?: string;
+
+  /**
+   * The referer to retrieve analytics for.
+   */
+  referer?: string;
+
+  /**
+   * Filter for root domains. If true, filter for domains only. If false, filter for
+   * links only. If undefined, return both.
+   */
+  root?: boolean;
+
+  /**
+   * The start date and time when to retrieve analytics from.
+   */
+  start?: string;
+
+  /**
+   * The tag ID to retrieve analytics for.
+   */
+  tagId?: string;
+
+  /**
+   * The IANA time zone code for aligning timeseries granularity (e.g.
+   * America/New_York). Defaults to UTC.
+   */
+  timezone?: string;
+
+  /**
+   * The type of analytics to retrieve.
+   */
+  type?: string;
+
+  /**
+   * The types of analytics to retrieve.
+   */
+  types?: string;
+
+  /**
+   * The URL to retrieve analytics for.
+   */
+  url?: string;
+}
+
+export declare namespace Analytics {
+  export {
+    type ContinentCode as ContinentCode,
+    type CountryCode as CountryCode,
+    type AnalyticsRetrieveResponse as AnalyticsRetrieveResponse,
+    type AnalyticsRetrieveParams as AnalyticsRetrieveParams,
+  };
+}