@tapline/client 0.2.7 → 0.2.8

package/dist/services/instagram/client.d.ts

@@ -0,0 +1,31 @@
+import type { BaseClient } from '../../base.js';
+import type { GetAudioReelsParams, GetBasicProfileParams, GetEmbedParams, GetHighlightDetailParams, GetHighlightsParams, GetPostCommentsParams, GetPostCountParams, GetPostParams, GetProfileParams, GetUserPostsParams, GetUserReelsParams, InstagramAudioReelsResponse, InstagramBasicProfileResponse, InstagramCommentsResponse, InstagramEmbedResponse, InstagramHighlightDetailResponse, InstagramHighlightsResponse, InstagramPopularSearchResponse, InstagramPostCountResponse, InstagramPostResponse, InstagramProfileResponse, InstagramUserPostsResponse, InstagramUserReelsResponse, SearchPopularParams } from './types.js';
+export declare class InstagramClient {
+    private readonly base;
+    constructor(base: BaseClient);
+    /** Reels that use an audio track, from instagram.com/reels/audio/<audio_id>/: Instagram's media objects with play counts, video versions and creators. Pass `cursor` back while `has_more` is true. Costs 1 credit. */
+    getAudioReels(params: GetAudioReelsParams): Promise<InstagramAudioReelsResponse>;
+    /** A profile summary by numeric user id: username, full name, biography, bio links, profile picture (standard and HD), verification, privacy, follower and following counts and account type. The body is Instagram's profile object at the top level. Costs 1 credit. */
+    getBasicProfile(params: GetBasicProfileParams): Promise<InstagramBasicProfileResponse>;
+    /** One post or reel in Scrape Creators' `xdt_shortcode_media` shape: caption, like and comment counts, image and video URLs, owner, tagged users, carousel children, the first page of comments and, for videos, `video_play_count` (Instagram-only plays) and `video_duration`. `created_at` is ISO 8601 and `taken_at_timestamp` the Unix time. `include_play_count=false` skips the play-count lookup. `trim=true` answers `xdt_shortcode_media` at the top level with Scrape Creators' trimmed fields. Costs 2 credits. */
+    getPost(params: GetPostParams): Promise<InstagramPostResponse>;
+    /** A page of up to 15 comments on a public post or reel: text, ISO 8601 `created_at`, like count and the commenter's id, username, verification and profile picture. Instagram does not show reply counts to logged-out visitors, so `child_comment_count` is null. Pass `cursor` back for the next page; it is null on the last one. Costs 1 credit. */
+    getPostComments(params: GetPostCommentsParams): Promise<InstagramCommentsResponse>;
+    /** A public Instagram profile in Scrape Creators' `/v1/instagram/profile` shape: biography, bio links, follower and following counts, verification, profile pictures and the 12 newest posts under `data.user.edge_owner_to_timeline_media` (pinned first). `edge_owner_to_timeline_media.count` is the size of that batch, not the account's post total; use `/v1/instagram/profile/post-count` for the total. Fields the logged-out web does not show (business contact details, category, highlight count) carry Scrape Creators' defaults. A private account answers its profile with an empty timeline. With `trim=true` the user object keeps Scrape Creators' trimmed field set. Costs 1 credit. */
+    getProfile(params: GetProfileParams): Promise<InstagramProfileResponse>;
+    /** The exact number of posts on a public profile. `is_estimated` is always false: Tapline reads the exact count, so `allow_estimated` has no effect. Costs 1 credit. */
+    getPostCount(params: GetPostCountParams): Promise<InstagramPostCountResponse>;
+    /** Instagram's public popular page for a topic. The first page carries the topic title, Instagram's generated description, suggested related searches and 12 posts; pass `cursor` back for 12 more. Instagram no longer publishes a post total or the description's sources there, so `total_media_count` is null and `source_uris` empty. Costs 2 credits. */
+    searchPopular(params: SearchPopularParams): Promise<InstagramPopularSearchResponse>;
+    /** The HTML of Instagram's embeddable profile widget, instagram.com/<handle>/embed/, as one string. Costs 1 credit. */
+    getEmbed(params: GetEmbedParams): Promise<InstagramEmbedResponse>;
+    /** Everything in one story highlight: cover, title, owner and every story item with its media type, image and video versions, dimensions, timestamps and stickers. The body is Instagram's reel object at the top level. Costs 1 credit. */
+    getHighlightDetail(params: GetHighlightDetailParams): Promise<InstagramHighlightDetailResponse>;
+    /** The story highlight albums a logged-out visitor sees on a profile: id, title, cover image and owner. Send `handle` or `user_id`; `handle` answers faster here, `user_id` costs one extra lookup. Instagram shows logged-out visitors only some albums and no way to page through the rest. Costs 1 credit. */
+    getHighlights(params: GetHighlightsParams): Promise<InstagramHighlightsResponse>;
+    /** A page of 12 of a user's posts, newest first, as Instagram's feed returns them: media type, shortcode, caption, like, comment and play counts, image and video versions, tagged users, `url` and an ISO 8601 `created_at` (`taken_at` stays the Unix time). Pass `next_max_id` back for the next page while `more_available` is true. An unknown handle answers an empty page; a private account answers 404. `trim=true` keeps Scrape Creators' trimmed item fields. Costs 1 credit. */
+    getUserPosts(params: GetUserPostsParams): Promise<InstagramUserPostsResponse>;
+    /** A page of a user's reels: each `items[].media` is Instagram's media object with play, like and comment counts, video versions, thumbnails, `url` and an ISO 8601 `created_at`. Instagram leaves the caption out of this list. Pass `paging_info.max_id` back as `max_id` for the next page. Send `user_id` for a faster answer: `handle` costs one extra lookup. `trim=true` answers flat items and a top-level `max_id`. Costs 1 credit. */
+    getUserReels(params: GetUserReelsParams): Promise<InstagramUserReelsResponse>;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/services/instagram/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../../src/services/instagram/client.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,cAAc,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,aAAa,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,2BAA2B,EAAE,6BAA6B,EAAE,yBAAyB,EAAE,sBAAsB,EAAE,gCAAgC,EAAE,2BAA2B,EAAE,8BAA8B,EAAE,0BAA0B,EAAE,qBAAqB,EAAE,wBAAwB,EAAE,0BAA0B,EAAE,0BAA0B,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAExmB,qBAAa,eAAe;IACd,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C,uNAAuN;IACjN,aAAa,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAItF,0QAA0Q;IACpQ,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,6BAA6B,CAAC;IAI5F,+fAA+f;IACzf,OAAO,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAIpE,yVAAyV;IACnV,eAAe,CAAC,MAAM,EAAE,qBAAqB,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAIxF,2qBAA2qB;IACrqB,UAAU,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAI7E,wKAAwK;IAClK,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAInF,+VAA+V;IACzV,aAAa,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,8BAA8B,CAAC;IAIzF,uHAAuH;IACjH,QAAQ,CAAC,MAAM,EAAE,cAAc,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAIvE,4OAA4O;IACtO,kBAAkB,CAAC,MAAM,EAAE,wBAAwB,GAAG,OAAO,CAAC,gCAAgC,CAAC;IAIrG,iTAAiT;IAC3S,aAAa,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAItF,4dAA4d;IACtd,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAInF,gbAAgb;IAC1a,YAAY,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO,CAAC,0BAA0B,CAAC;CAGpF"}

package/dist/services/instagram/client.js

@@ -0,0 +1,56 @@
+// Generated by generate-client from spec/openapi.json. Do not edit.
+export class InstagramClient {
+    base;
+    constructor(base) {
+        this.base = base;
+    }
+    /** Reels that use an audio track, from instagram.com/reels/audio/<audio_id>/: Instagram's media objects with play counts, video versions and creators. Pass `cursor` back while `has_more` is true. Costs 1 credit. */
+    async getAudioReels(params) {
+        return this.base.get('/v1/instagram/audio/reels', { ...params });
+    }
+    /** A profile summary by numeric user id: username, full name, biography, bio links, profile picture (standard and HD), verification, privacy, follower and following counts and account type. The body is Instagram's profile object at the top level. Costs 1 credit. */
+    async getBasicProfile(params) {
+        return this.base.get('/v1/instagram/basic-profile', { ...params });
+    }
+    /** One post or reel in Scrape Creators' `xdt_shortcode_media` shape: caption, like and comment counts, image and video URLs, owner, tagged users, carousel children, the first page of comments and, for videos, `video_play_count` (Instagram-only plays) and `video_duration`. `created_at` is ISO 8601 and `taken_at_timestamp` the Unix time. `include_play_count=false` skips the play-count lookup. `trim=true` answers `xdt_shortcode_media` at the top level with Scrape Creators' trimmed fields. Costs 2 credits. */
+    async getPost(params) {
+        return this.base.get('/v1/instagram/post', { ...params });
+    }
+    /** A page of up to 15 comments on a public post or reel: text, ISO 8601 `created_at`, like count and the commenter's id, username, verification and profile picture. Instagram does not show reply counts to logged-out visitors, so `child_comment_count` is null. Pass `cursor` back for the next page; it is null on the last one. Costs 1 credit. */
+    async getPostComments(params) {
+        return this.base.get('/v1/instagram/post/comments', { ...params });
+    }
+    /** A public Instagram profile in Scrape Creators' `/v1/instagram/profile` shape: biography, bio links, follower and following counts, verification, profile pictures and the 12 newest posts under `data.user.edge_owner_to_timeline_media` (pinned first). `edge_owner_to_timeline_media.count` is the size of that batch, not the account's post total; use `/v1/instagram/profile/post-count` for the total. Fields the logged-out web does not show (business contact details, category, highlight count) carry Scrape Creators' defaults. A private account answers its profile with an empty timeline. With `trim=true` the user object keeps Scrape Creators' trimmed field set. Costs 1 credit. */
+    async getProfile(params) {
+        return this.base.get('/v1/instagram/profile', { ...params });
+    }
+    /** The exact number of posts on a public profile. `is_estimated` is always false: Tapline reads the exact count, so `allow_estimated` has no effect. Costs 1 credit. */
+    async getPostCount(params) {
+        return this.base.get('/v1/instagram/profile/post-count', { ...params });
+    }
+    /** Instagram's public popular page for a topic. The first page carries the topic title, Instagram's generated description, suggested related searches and 12 posts; pass `cursor` back for 12 more. Instagram no longer publishes a post total or the description's sources there, so `total_media_count` is null and `source_uris` empty. Costs 2 credits. */
+    async searchPopular(params) {
+        return this.base.get('/v1/instagram/search/popular', { ...params });
+    }
+    /** The HTML of Instagram's embeddable profile widget, instagram.com/<handle>/embed/, as one string. Costs 1 credit. */
+    async getEmbed(params) {
+        return this.base.get('/v1/instagram/user/embed', { ...params });
+    }
+    /** Everything in one story highlight: cover, title, owner and every story item with its media type, image and video versions, dimensions, timestamps and stickers. The body is Instagram's reel object at the top level. Costs 1 credit. */
+    async getHighlightDetail(params) {
+        return this.base.get('/v1/instagram/user/highlight/detail', { ...params });
+    }
+    /** The story highlight albums a logged-out visitor sees on a profile: id, title, cover image and owner. Send `handle` or `user_id`; `handle` answers faster here, `user_id` costs one extra lookup. Instagram shows logged-out visitors only some albums and no way to page through the rest. Costs 1 credit. */
+    async getHighlights(params) {
+        return this.base.get('/v1/instagram/user/highlights', { ...params });
+    }
+    /** A page of 12 of a user's posts, newest first, as Instagram's feed returns them: media type, shortcode, caption, like, comment and play counts, image and video versions, tagged users, `url` and an ISO 8601 `created_at` (`taken_at` stays the Unix time). Pass `next_max_id` back for the next page while `more_available` is true. An unknown handle answers an empty page; a private account answers 404. `trim=true` keeps Scrape Creators' trimmed item fields. Costs 1 credit. */
+    async getUserPosts(params) {
+        return this.base.get('/v1/instagram/user/posts', { ...params });
+    }
+    /** A page of a user's reels: each `items[].media` is Instagram's media object with play, like and comment counts, video versions, thumbnails, `url` and an ISO 8601 `created_at`. Instagram leaves the caption out of this list. Pass `paging_info.max_id` back as `max_id` for the next page. Send `user_id` for a faster answer: `handle` costs one extra lookup. `trim=true` answers flat items and a top-level `max_id`. Costs 1 credit. */
+    async getUserReels(params) {
+        return this.base.get('/v1/instagram/user/reels', { ...params });
+    }
+}
+//# sourceMappingURL=client.js.map

package/dist/services/instagram/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/services/instagram/client.ts"],"names":[],"mappings":"AAAA,oEAAoE;AAKpE,MAAM,OAAO,eAAe;IACG;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD,uNAAuN;IACvN,KAAK,CAAC,aAAa,CAAC,MAA2B;QAC7C,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAA8B,2BAA2B,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAChG,CAAC;IAED,0QAA0Q;IAC1Q,KAAK,CAAC,eAAe,CAAC,MAA6B;QACjD,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAgC,6BAA6B,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IACpG,CAAC;IAED,+fAA+f;IAC/f,KAAK,CAAC,OAAO,CAAC,MAAqB;QACjC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAwB,oBAAoB,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IACnF,CAAC;IAED,yVAAyV;IACzV,KAAK,CAAC,eAAe,CAAC,MAA6B;QACjD,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAA4B,6BAA6B,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAChG,CAAC;IAED,2qBAA2qB;IAC3qB,KAAK,CAAC,UAAU,CAAC,MAAwB;QACvC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAA2B,uBAAuB,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IACzF,CAAC;IAED,wKAAwK;IACxK,KAAK,CAAC,YAAY,CAAC,MAA0B;QAC3C,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAA6B,kCAAkC,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IACtG,CAAC;IAED,+VAA+V;IAC/V,KAAK,CAAC,aAAa,CAAC,MAA2B;QAC7C,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAiC,8BAA8B,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IACtG,CAAC;IAED,uHAAuH;IACvH,KAAK,CAAC,QAAQ,CAAC,MAAsB;QACnC,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAyB,0BAA0B,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAC1F,CAAC;IAED,4OAA4O;IAC5O,KAAK,CAAC,kBAAkB,CAAC,MAAgC;QACvD,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAmC,qCAAqC,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAC/G,CAAC;IAED,iTAAiT;IACjT,KAAK,CAAC,aAAa,CAAC,MAA2B;QAC7C,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAA8B,+BAA+B,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IACpG,CAAC;IAED,4dAA4d;IAC5d,KAAK,CAAC,YAAY,CAAC,MAA0B;QAC3C,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAA6B,0BAA0B,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAC9F,CAAC;IAED,gbAAgb;IAChb,KAAK,CAAC,YAAY,CAAC,MAA0B;QAC3C,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAA6B,0BAA0B,EAAE,EAAE,GAAG,MAAM,EAAE,CAAC,CAAC;IAC9F,CAAC;CACF"}

package/dist/services/instagram/index.d.ts

@@ -0,0 +1,3 @@
+export * from './types.js';
+export { InstagramClient } from './client.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/services/instagram/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/services/instagram/index.ts"],"names":[],"mappings":"AAEA,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC"}

package/dist/services/instagram/index.js

@@ -0,0 +1,4 @@
+// Generated by generate-client from spec/openapi.json. Do not edit.
+export * from './types.js';
+export { InstagramClient } from './client.js';
+//# sourceMappingURL=index.js.map

package/dist/services/instagram/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/services/instagram/index.ts"],"names":[],"mappings":"AAAA,oEAAoE;AAEpE,cAAc,YAAY,CAAC;AAC3B,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC"}