@trillboards/cli 0.1.5 → 0.1.7

package/dist/commands/generated/generated-data-api-ad-sightings-history.d.ts

@@ -0,0 +1,20 @@
+import { BaseCommand } from '../../base-command.js';
+export default class Dataapiadsightingshistory extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static args: {};
+    static flags: {
+        brand: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        brand_id: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        market: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        from: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        to: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        grain: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        limit: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        cursor: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'api-key': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'base-url': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        format: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/generated/generated-data-api-ad-sightings-history.js

@@ -0,0 +1,53 @@
+// AUTO-GENERATED from OpenAPI spec (data-api) -- do not edit manually
+// Regenerate with: npm run generate
+import { Flags } from '@oclif/core';
+import { BaseCommand } from '../../base-command.js';
+import { apiRequest } from '../../http.js';
+import { formatOutput } from '../../output.js';
+export default class Dataapiadsightingshistory extends BaseCommand {
+    static description = "Outdoor creative history by brand, market and month, from the creative ledger.";
+    static examples = [`$ trillboards generated data-api-ad-sightings-history`];
+    static args = {};
+    static flags = {
+        ...BaseCommand.baseFlags,
+        'brand': Flags.string({ description: 'A brand by name, repeatable (competitors). Resolved to its brand id the way the brand search does.' }),
+        'brand_id': Flags.string({ description: 'A resolved brand id, repeatable.' }),
+        'market': Flags.string({ description: 'A market as COUNTRY:CODE, repeatable.' }),
+        'from': Flags.string({ description: 'First month (YYYY-MM) or day. Default: 12 months before `to`.' }),
+        'to': Flags.string({ description: 'Last month (YYYY-MM, inclusive) or day. Default: this month.' }),
+        'grain': Flags.string({ description: 'market_month (default) or fleet_month.' }),
+        'limit': Flags.string({ description: 'Rows per page, 1..500 (default 100). The page limit is reserved; the rows returned are billed.' }),
+        'cursor': Flags.string({ description: 'The `next_cursor` of the previous page.' }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(Dataapiadsightingshistory);
+        this.setParsedFlags(flags);
+        const apiKey = this.getApiKey();
+        if (!apiKey)
+            this.error('Not logged in. Run: trillboards login');
+        let urlPath = '/v1/data/ad-sightings/history';
+        const params = {};
+        if (flags['brand'])
+            params['brand'] = flags['brand'];
+        if (flags['brand_id'])
+            params['brand_id'] = flags['brand_id'];
+        if (flags['market'])
+            params['market'] = flags['market'];
+        if (flags['from'])
+            params['from'] = flags['from'];
+        if (flags['to'])
+            params['to'] = flags['to'];
+        if (flags['grain'])
+            params['grain'] = flags['grain'];
+        if (flags['limit'])
+            params['limit'] = flags['limit'];
+        if (flags['cursor'])
+            params['cursor'] = flags['cursor'];
+        const result = await apiRequest('GET', urlPath, {
+            apiKey,
+            baseUrl: flags['base-url'] ?? 'https://api.trillboards.com',
+            params: Object.keys(params).length > 0 ? params : undefined,
+        });
+        this.log(formatOutput(result, this.getFormat()));
+    }
+}

package/dist/commands/generated/generated-data-api-ad-sightings.d.ts

@@ -0,0 +1,23 @@
+import { BaseCommand } from '../../base-command.js';
+export default class Dataapiadsightings extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static args: {};
+    static flags: {
+        brand: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        brand_id: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        market: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        surface: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        board_id: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        creative_id: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        instrument: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        from: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        to: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        limit: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        cursor: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'api-key': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'base-url': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        format: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/generated/generated-data-api-ad-sightings.js

@@ -0,0 +1,62 @@
+// AUTO-GENERATED from OpenAPI spec (data-api) -- do not edit manually
+// Regenerate with: npm run generate
+import { Flags } from '@oclif/core';
+import { BaseCommand } from '../../base-command.js';
+import { apiRequest } from '../../http.js';
+import { formatOutput } from '../../output.js';
+export default class Dataapiadsightings extends BaseCommand {
+    static description = "Ad-sighting records: outdoor ads our cab cameras read, each with a signed photo link.";
+    static examples = [`$ trillboards generated data-api-ad-sightings`];
+    static args = {};
+    static flags = {
+        ...BaseCommand.baseFlags,
+        'brand': Flags.string({ description: 'A brand, repeatable for a brand set (competitors). Matched however it is typed: "McDonald\'s", "mcdonalds" and "Mc Donalds" find the same records.' }),
+        'brand_id': Flags.string({ description: 'A resolved brand id, repeatable. Combined with `brand` as either-or.' }),
+        'market': Flags.string({ description: 'A market as COUNTRY:CODE (US DMA or CA CMA), repeatable.' }),
+        'surface': Flags.string({ description: 'The surface kind as read (billboard, storefront, bus_shelter, ...), repeatable.' }),
+        'board_id': Flags.string({ description: 'A board the sighting was matched to, repeatable.' }),
+        'creative_id': Flags.string({ description: 'A sighted creative (the campaign artwork), repeatable.' }),
+        'instrument': Flags.string({ description: 'The reading instrument (ssr-v2, ssr-v1, vlmtext-v1, edge_ocr_v1), repeatable.' }),
+        'from': Flags.string({ description: 'Start (inclusive), YYYY-MM-DD or an ISO-8601 instant. Default: 30 days before `to`.' }),
+        'to': Flags.string({ description: 'End (exclusive). Default: now. The span is at most 400 days.' }),
+        'limit': Flags.string({ description: 'Records per page, 1..500 (default 50). The page limit is reserved; the records returned are billed.' }),
+        'cursor': Flags.string({ description: 'The `next_cursor` of the previous page.' }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(Dataapiadsightings);
+        this.setParsedFlags(flags);
+        const apiKey = this.getApiKey();
+        if (!apiKey)
+            this.error('Not logged in. Run: trillboards login');
+        let urlPath = '/v1/data/ad-sightings';
+        const params = {};
+        if (flags['brand'])
+            params['brand'] = flags['brand'];
+        if (flags['brand_id'])
+            params['brand_id'] = flags['brand_id'];
+        if (flags['market'])
+            params['market'] = flags['market'];
+        if (flags['surface'])
+            params['surface'] = flags['surface'];
+        if (flags['board_id'])
+            params['board_id'] = flags['board_id'];
+        if (flags['creative_id'])
+            params['creative_id'] = flags['creative_id'];
+        if (flags['instrument'])
+            params['instrument'] = flags['instrument'];
+        if (flags['from'])
+            params['from'] = flags['from'];
+        if (flags['to'])
+            params['to'] = flags['to'];
+        if (flags['limit'])
+            params['limit'] = flags['limit'];
+        if (flags['cursor'])
+            params['cursor'] = flags['cursor'];
+        const result = await apiRequest('GET', urlPath, {
+            apiKey,
+            baseUrl: flags['base-url'] ?? 'https://api.trillboards.com',
+            params: Object.keys(params).length > 0 ? params : undefined,
+        });
+        this.log(formatOutput(result, this.getFormat()));
+    }
+}

package/dist/commands/generated/generated-device-retained-cctv-review.d.ts

@@ -0,0 +1,13 @@
+import { BaseCommand } from '../../base-command.js';
+export default class Deviceretainedcctvreview extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static args: {};
+    static flags: {
+        data: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'api-key': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'base-url': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        format: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/generated/generated-device-retained-cctv-review.js

@@ -0,0 +1,32 @@
+// AUTO-GENERATED from OpenAPI spec (device-api) -- do not edit manually
+// Regenerate with: npm run generate
+import { Flags } from '@oclif/core';
+import { BaseCommand } from '../../base-command.js';
+import { apiRequest } from '../../http.js';
+import { formatOutput } from '../../output.js';
+export default class Deviceretainedcctvreview extends BaseCommand {
+    static description = "Store original CCTV evidence and its completed local review.";
+    static examples = [`$ trillboards generated device-retained-cctv-review`];
+    static args = {};
+    static flags = {
+        ...BaseCommand.baseFlags,
+        data: Flags.string({ description: 'JSON request body' }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(Deviceretainedcctvreview);
+        this.setParsedFlags(flags);
+        const apiKey = this.getApiKey();
+        if (!apiKey)
+            this.error('Not logged in. Run: trillboards login');
+        let urlPath = '/v2/earner/cctv-retained/reviews';
+        const params = {};
+        const body = flags.data ? JSON.parse(flags.data) : undefined;
+        const result = await apiRequest('POST', urlPath, {
+            apiKey,
+            baseUrl: flags['base-url'] ?? 'https://api.trillboards.com',
+            params: Object.keys(params).length > 0 ? params : undefined,
+            body,
+        });
+        this.log(formatOutput(result, this.getFormat()));
+    }
+}