GiphyClient 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/Gemfile.lock +69 -0
- data/GiphyClient.gemspec +44 -0
- data/README.md +152 -0
- data/Rakefile +7 -0
- data/config.json +18 -0
- data/docs/BaseChannelModel.md +36 -0
- data/docs/BaseChannelModelGifs.md +9 -0
- data/docs/Breadcrumb.md +10 -0
- data/docs/Category.md +11 -0
- data/docs/ChannelWithChildrenModel.md +37 -0
- data/docs/ChannelWithChildrenModelChildren.md +9 -0
- data/docs/DefaultApi.md +731 -0
- data/docs/Gif.md +36 -0
- data/docs/GifImages.md +27 -0
- data/docs/GifImagesDownsized.md +11 -0
- data/docs/GifImagesDownsizedLarge.md +11 -0
- data/docs/GifImagesDownsizedMedium.md +11 -0
- data/docs/GifImagesDownsizedSmall.md +11 -0
- data/docs/GifImagesDownsizedStill.md +10 -0
- data/docs/GifImagesFixedHeight.md +15 -0
- data/docs/GifImagesFixedHeightDownsampled.md +13 -0
- data/docs/GifImagesFixedHeightSmall.md +15 -0
- data/docs/GifImagesFixedHeightSmallStill.md +10 -0
- data/docs/GifImagesFixedHeightStill.md +10 -0
- data/docs/GifImagesFixedWidth.md +15 -0
- data/docs/GifImagesFixedWidthDownsampled.md +13 -0
- data/docs/GifImagesFixedWidthSmall.md +15 -0
- data/docs/GifImagesFixedWidthSmallStill.md +10 -0
- data/docs/GifImagesFixedWidthStill.md +10 -0
- data/docs/GifImagesLooping.md +8 -0
- data/docs/GifImagesOriginal.md +16 -0
- data/docs/GifImagesOriginalStill.md +10 -0
- data/docs/GifImagesPreview.md +11 -0
- data/docs/GifImagesPreviewGif.md +11 -0
- data/docs/InlineResponse200.md +10 -0
- data/docs/InlineResponse2001.md +9 -0
- data/docs/InlineResponse2002.md +9 -0
- data/docs/InlineResponse2003.md +10 -0
- data/docs/InlineResponse2004.md +10 -0
- data/docs/InlineResponse2005.md +10 -0
- data/docs/InlineResponse400.md +8 -0
- data/docs/LastChildModel.md +37 -0
- data/docs/LastChildModelChildren.md +9 -0
- data/docs/MetaContent.md +10 -0
- data/docs/MetaObject.md +8 -0
- data/docs/Pagination.md +10 -0
- data/docs/RandomGif.md +30 -0
- data/docs/ShallowTag.md +9 -0
- data/docs/Tag.md +9 -0
- data/docs/TrendingTag.md +10 -0
- data/docs/User.md +13 -0
- data/generate.sh +12 -0
- data/git_push.sh +55 -0
- data/lib/GiphyClient.rb +84 -0
- data/lib/GiphyClient/api/default_api.rb +952 -0
- data/lib/GiphyClient/api_client.rb +375 -0
- data/lib/GiphyClient/api_error.rb +37 -0
- data/lib/GiphyClient/configuration.rb +195 -0
- data/lib/GiphyClient/models/base_channel_model.rb +464 -0
- data/lib/GiphyClient/models/base_channel_model_gifs.rb +198 -0
- data/lib/GiphyClient/models/breadcrumb.rb +205 -0
- data/lib/GiphyClient/models/category.rb +220 -0
- data/lib/GiphyClient/models/channel_with_children_model.rb +473 -0
- data/lib/GiphyClient/models/channel_with_children_model_children.rb +198 -0
- data/lib/GiphyClient/models/gif.rb +473 -0
- data/lib/GiphyClient/models/gif_images.rb +358 -0
- data/lib/GiphyClient/models/gif_images_downsized.rb +218 -0
- data/lib/GiphyClient/models/gif_images_downsized_large.rb +218 -0
- data/lib/GiphyClient/models/gif_images_downsized_medium.rb +218 -0
- data/lib/GiphyClient/models/gif_images_downsized_small.rb +218 -0
- data/lib/GiphyClient/models/gif_images_downsized_still.rb +208 -0
- data/lib/GiphyClient/models/gif_images_fixed_height.rb +258 -0
- data/lib/GiphyClient/models/gif_images_fixed_height_downsampled.rb +238 -0
- data/lib/GiphyClient/models/gif_images_fixed_height_small.rb +258 -0
- data/lib/GiphyClient/models/gif_images_fixed_height_small_still.rb +208 -0
- data/lib/GiphyClient/models/gif_images_fixed_height_still.rb +208 -0
- data/lib/GiphyClient/models/gif_images_fixed_width.rb +258 -0
- data/lib/GiphyClient/models/gif_images_fixed_width_downsampled.rb +238 -0
- data/lib/GiphyClient/models/gif_images_fixed_width_small.rb +258 -0
- data/lib/GiphyClient/models/gif_images_fixed_width_small_still.rb +208 -0
- data/lib/GiphyClient/models/gif_images_fixed_width_still.rb +208 -0
- data/lib/GiphyClient/models/gif_images_looping.rb +188 -0
- data/lib/GiphyClient/models/gif_images_original.rb +268 -0
- data/lib/GiphyClient/models/gif_images_original_still.rb +208 -0
- data/lib/GiphyClient/models/gif_images_preview.rb +218 -0
- data/lib/GiphyClient/models/gif_images_preview_gif.rb +218 -0
- data/lib/GiphyClient/models/inline_response_200.rb +209 -0
- data/lib/GiphyClient/models/inline_response_200_1.rb +197 -0
- data/lib/GiphyClient/models/inline_response_200_2.rb +197 -0
- data/lib/GiphyClient/models/inline_response_200_3.rb +207 -0
- data/lib/GiphyClient/models/inline_response_200_4.rb +207 -0
- data/lib/GiphyClient/models/inline_response_200_5.rb +207 -0
- data/lib/GiphyClient/models/inline_response_400.rb +187 -0
- data/lib/GiphyClient/models/last_child_model.rb +473 -0
- data/lib/GiphyClient/models/last_child_model_children.rb +198 -0
- data/lib/GiphyClient/models/meta_content.rb +218 -0
- data/lib/GiphyClient/models/meta_object.rb +187 -0
- data/lib/GiphyClient/models/pagination.rb +208 -0
- data/lib/GiphyClient/models/random_gif.rb +401 -0
- data/lib/GiphyClient/models/shallow_tag.rb +198 -0
- data/lib/GiphyClient/models/tag.rb +198 -0
- data/lib/GiphyClient/models/trending_tag.rb +205 -0
- data/lib/GiphyClient/models/user.rb +238 -0
- data/lib/GiphyClient/version.rb +14 -0
- data/public.yaml +1638 -0
- data/spec/api/default_api_spec.rb +260 -0
- data/spec/api_client_spec.rb +225 -0
- data/spec/configuration_spec.rb +41 -0
- data/spec/models/base_channel_model_gifs_spec.rb +47 -0
- data/spec/models/base_channel_model_spec.rb +209 -0
- data/spec/models/breadcrumb_spec.rb +53 -0
- data/spec/models/category_spec.rb +59 -0
- data/spec/models/channel_with_children_model_children_spec.rb +47 -0
- data/spec/models/channel_with_children_model_spec.rb +215 -0
- data/spec/models/gif_images_downsized_large_spec.rb +59 -0
- data/spec/models/gif_images_downsized_medium_spec.rb +59 -0
- data/spec/models/gif_images_downsized_small_spec.rb +59 -0
- data/spec/models/gif_images_downsized_spec.rb +59 -0
- data/spec/models/gif_images_downsized_still_spec.rb +53 -0
- data/spec/models/gif_images_fixed_height_downsampled_spec.rb +71 -0
- data/spec/models/gif_images_fixed_height_small_spec.rb +83 -0
- data/spec/models/gif_images_fixed_height_small_still_spec.rb +53 -0
- data/spec/models/gif_images_fixed_height_spec.rb +83 -0
- data/spec/models/gif_images_fixed_height_still_spec.rb +53 -0
- data/spec/models/gif_images_fixed_width_downsampled_spec.rb +71 -0
- data/spec/models/gif_images_fixed_width_small_spec.rb +83 -0
- data/spec/models/gif_images_fixed_width_small_still_spec.rb +53 -0
- data/spec/models/gif_images_fixed_width_spec.rb +83 -0
- data/spec/models/gif_images_fixed_width_still_spec.rb +53 -0
- data/spec/models/gif_images_looping_spec.rb +41 -0
- data/spec/models/gif_images_original_spec.rb +89 -0
- data/spec/models/gif_images_original_still_spec.rb +53 -0
- data/spec/models/gif_images_preview_gif_spec.rb +59 -0
- data/spec/models/gif_images_preview_spec.rb +59 -0
- data/spec/models/gif_images_spec.rb +155 -0
- data/spec/models/gif_spec.rb +209 -0
- data/spec/models/inline_response_200_1_spec.rb +47 -0
- data/spec/models/inline_response_200_2_spec.rb +47 -0
- data/spec/models/inline_response_200_3_spec.rb +53 -0
- data/spec/models/inline_response_200_4_spec.rb +53 -0
- data/spec/models/inline_response_200_5_spec.rb +53 -0
- data/spec/models/inline_response_200_spec.rb +53 -0
- data/spec/models/inline_response_400_spec.rb +41 -0
- data/spec/models/last_child_model_children_spec.rb +47 -0
- data/spec/models/last_child_model_spec.rb +215 -0
- data/spec/models/meta_content_spec.rb +53 -0
- data/spec/models/meta_object_spec.rb +41 -0
- data/spec/models/pagination_spec.rb +53 -0
- data/spec/models/random_gif_spec.rb +173 -0
- data/spec/models/shallow_tag_spec.rb +47 -0
- data/spec/models/tag_spec.rb +47 -0
- data/spec/models/trending_tag_spec.rb +53 -0
- data/spec/models/user_spec.rb +71 -0
- data/spec/spec_helper.rb +110 -0
- metadata +428 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 8a728e784ccf2f7ce63502b38b9e1a1fbb46f535
|
4
|
+
data.tar.gz: fa14df15c7f2aec3775fc36a7ee013debfe7a71d
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: dc8063ebdfbe4900617457a1237cf4b6a51d7ee6623738c3c9745f82f69fe461a13bb7e58bfc3880c37af26bf29678f360915dbe8e5985ae9b10f294130a2df1
|
7
|
+
data.tar.gz: 428697b3e08f1690c2551bc848acc3f1462271f6369043af8e1ab4766ccd6c26eb84549335b33e59e00b1a15233b84b676ac17d20c1627c8c09acd858ae6f99e
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,69 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
GiphyClient (1.0.0)
|
5
|
+
json (~> 1.8, >= 1.8.3)
|
6
|
+
typhoeus (~> 1.0, >= 1.0.1)
|
7
|
+
|
8
|
+
GEM
|
9
|
+
remote: https://rubygems.org/
|
10
|
+
specs:
|
11
|
+
ZenTest (4.11.1)
|
12
|
+
addressable (2.5.1)
|
13
|
+
public_suffix (~> 2.0, >= 2.0.2)
|
14
|
+
autotest (4.4.6)
|
15
|
+
ZenTest (>= 4.4.1)
|
16
|
+
autotest-fsevent (0.2.12)
|
17
|
+
sys-uname
|
18
|
+
autotest-growl (0.2.16)
|
19
|
+
autotest-rails-pure (4.1.2)
|
20
|
+
crack (0.4.3)
|
21
|
+
safe_yaml (~> 1.0.0)
|
22
|
+
diff-lcs (1.3)
|
23
|
+
ethon (0.10.1)
|
24
|
+
ffi (>= 1.3.0)
|
25
|
+
ffi (1.9.18)
|
26
|
+
hashdiff (0.3.4)
|
27
|
+
json (1.8.6)
|
28
|
+
public_suffix (2.0.5)
|
29
|
+
rake (12.0.0)
|
30
|
+
rspec (3.6.0)
|
31
|
+
rspec-core (~> 3.6.0)
|
32
|
+
rspec-expectations (~> 3.6.0)
|
33
|
+
rspec-mocks (~> 3.6.0)
|
34
|
+
rspec-core (3.6.0)
|
35
|
+
rspec-support (~> 3.6.0)
|
36
|
+
rspec-expectations (3.6.0)
|
37
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
38
|
+
rspec-support (~> 3.6.0)
|
39
|
+
rspec-mocks (3.6.0)
|
40
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
41
|
+
rspec-support (~> 3.6.0)
|
42
|
+
rspec-support (3.6.0)
|
43
|
+
safe_yaml (1.0.4)
|
44
|
+
sys-uname (1.0.3)
|
45
|
+
ffi (>= 1.0.0)
|
46
|
+
typhoeus (1.1.2)
|
47
|
+
ethon (>= 0.9.0)
|
48
|
+
vcr (3.0.3)
|
49
|
+
webmock (1.24.6)
|
50
|
+
addressable (>= 2.3.6)
|
51
|
+
crack (>= 0.3.2)
|
52
|
+
hashdiff
|
53
|
+
|
54
|
+
PLATFORMS
|
55
|
+
ruby
|
56
|
+
|
57
|
+
DEPENDENCIES
|
58
|
+
GiphyClient!
|
59
|
+
autotest (~> 4.4, >= 4.4.6)
|
60
|
+
autotest-fsevent (~> 0.2, >= 0.2.11)
|
61
|
+
autotest-growl (~> 0.2, >= 0.2.16)
|
62
|
+
autotest-rails-pure (~> 4.1, >= 4.1.2)
|
63
|
+
rake (~> 12.0.0)
|
64
|
+
rspec (~> 3.4, >= 3.4.0)
|
65
|
+
vcr (~> 3.0, >= 3.0.1)
|
66
|
+
webmock (~> 1.24, >= 1.24.3)
|
67
|
+
|
68
|
+
BUNDLED WITH
|
69
|
+
1.14.6
|
data/GiphyClient.gemspec
ADDED
@@ -0,0 +1,44 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
#
|
3
|
+
=begin
|
4
|
+
#giphy-api
|
5
|
+
|
6
|
+
#Giphy's public api.
|
7
|
+
|
8
|
+
OpenAPI spec version: 0.9.3
|
9
|
+
|
10
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
11
|
+
|
12
|
+
=end
|
13
|
+
|
14
|
+
$:.push File.expand_path("../lib", __FILE__)
|
15
|
+
require "GiphyClient/version"
|
16
|
+
|
17
|
+
Gem::Specification.new 'giphy-ruby-client', '1.0' do |s|
|
18
|
+
s.name = "GiphyClient"
|
19
|
+
s.version = GiphyClient::VERSION
|
20
|
+
s.platform = Gem::Platform::RUBY
|
21
|
+
s.authors = ["David Hargat"]
|
22
|
+
s.email = [""]
|
23
|
+
s.homepage = "https://github.com/Giphy/giphy-ruby-client"
|
24
|
+
s.summary = "Networking client for the Giphy API."
|
25
|
+
s.description = "Giphy's public api."
|
26
|
+
s.license = "MIT"
|
27
|
+
s.required_ruby_version = ">= 1.9"
|
28
|
+
|
29
|
+
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
30
|
+
s.add_runtime_dependency 'json', '~> 1.8', '>= 1.8.3'
|
31
|
+
|
32
|
+
s.add_development_dependency 'rspec', '~> 3.4', '>= 3.4.0'
|
33
|
+
s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
|
34
|
+
s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
|
35
|
+
s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
|
36
|
+
s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
|
37
|
+
s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
|
38
|
+
s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.11'
|
39
|
+
|
40
|
+
s.files = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
|
41
|
+
s.test_files = `find spec/*`.split("\n")
|
42
|
+
s.executables = []
|
43
|
+
s.require_paths = ["lib"]
|
44
|
+
end
|
data/README.md
ADDED
@@ -0,0 +1,152 @@
|
|
1
|
+
# Giphy Core Client for Ruby
|
2
|
+
|
3
|
+
The **Giphy Core SDK** is a wrapper around [Giphy API](https://github.com/Giphy/GiphyAPI).
|
4
|
+
|
5
|
+
[![Build Status](https://travis-ci.com/Giphy/giphy-ruby-client.svg?token=ytpQbMSuy8sydsqZwbwp&branch=master)](https://travis-ci.com/Giphy/giphy-ruby-client)
|
6
|
+
|
7
|
+
[Giphy](https://www.giphy.com) is the best way to search, share, and discover GIFs on the Internet. Similar to the way other search engines work, the majority of our content comes from indexing based on the best and most popular GIFs and search terms across the web. We organize all those GIFs so you can find the good content easier and share it out through your social channels. We also feature some of our favorite GIF artists and work with brands to create and promote their original GIF content.
|
8
|
+
|
9
|
+
[![](https://media.giphy.com/media/5xaOcLOqNmWHaLeB14I/giphy.gif)]()
|
10
|
+
|
11
|
+
# Getting Started
|
12
|
+
|
13
|
+
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
14
|
+
|
15
|
+
- API version: 0.9.3
|
16
|
+
- Package version: 1.0.0
|
17
|
+
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
18
|
+
|
19
|
+
## Installation
|
20
|
+
|
21
|
+
### Build a gem
|
22
|
+
|
23
|
+
To build the Ruby code into a gem:
|
24
|
+
|
25
|
+
```shell
|
26
|
+
gem build GiphyClient.gemspec
|
27
|
+
```
|
28
|
+
|
29
|
+
Then either install the gem locally:
|
30
|
+
|
31
|
+
```shell
|
32
|
+
gem install ./GiphyClient-1.0.0.gem
|
33
|
+
```
|
34
|
+
(for development, run `gem install --dev ./GiphyClient-1.0.0.gem` to install the development dependencies)
|
35
|
+
|
36
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
37
|
+
|
38
|
+
Finally add this to the Gemfile:
|
39
|
+
|
40
|
+
gem 'GiphyClient', '~> 1.0.0'
|
41
|
+
|
42
|
+
### Install from Git
|
43
|
+
|
44
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
45
|
+
|
46
|
+
gem 'GiphyClient', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
47
|
+
|
48
|
+
### Include the Ruby code directly
|
49
|
+
|
50
|
+
Include the Ruby code directly using `-I` as follows:
|
51
|
+
|
52
|
+
```shell
|
53
|
+
ruby -Ilib script.rb
|
54
|
+
```
|
55
|
+
|
56
|
+
## Getting Started
|
57
|
+
|
58
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
59
|
+
```ruby
|
60
|
+
# Load the gem
|
61
|
+
require 'GiphyClient'
|
62
|
+
|
63
|
+
api_instance = GiphyClient::DefaultApi.new
|
64
|
+
|
65
|
+
api_key = "dc6zaTOxFJmzC" # String | Giphy API Key.
|
66
|
+
|
67
|
+
category = "category_example" # String | Filters results by category.
|
68
|
+
|
69
|
+
opts = {
|
70
|
+
limit: 25, # Integer | The maximum number of records to return.
|
71
|
+
offset: 0, # Integer | An optional results offset. Defaults to 0.
|
72
|
+
}
|
73
|
+
|
74
|
+
begin
|
75
|
+
#Category Tags Endpoint.
|
76
|
+
result = api_instance.gifs_categories_category_get(api_keycategory, , opts)
|
77
|
+
p result
|
78
|
+
rescue GiphyClient::ApiError => e
|
79
|
+
puts "Exception when calling DefaultApi->gifs_categories_category_get: #{e}"
|
80
|
+
end
|
81
|
+
|
82
|
+
```
|
83
|
+
|
84
|
+
## Documentation for API Endpoints
|
85
|
+
|
86
|
+
All URIs are relative to *http://api.giphy.com/v1*
|
87
|
+
|
88
|
+
Class | Method | HTTP request | Description
|
89
|
+
------------ | ------------- | ------------- | -------------
|
90
|
+
*GiphyClient::DefaultApi* | [**gifs_categories_category_get**](docs/DefaultApi.md#gifs_categories_category_get) | **GET** /gifs/categories/{category} | Category Tags Endpoint.
|
91
|
+
*GiphyClient::DefaultApi* | [**gifs_categories_category_tag_get**](docs/DefaultApi.md#gifs_categories_category_tag_get) | **GET** /gifs/categories/{category}/{tag} | Tagged Gifs Endpoint.
|
92
|
+
*GiphyClient::DefaultApi* | [**gifs_categories_get**](docs/DefaultApi.md#gifs_categories_get) | **GET** /gifs/categories | Categories Endpoint.
|
93
|
+
*GiphyClient::DefaultApi* | [**gifs_get**](docs/DefaultApi.md#gifs_get) | **GET** /gifs | Get GIFs by ID Endpoint
|
94
|
+
*GiphyClient::DefaultApi* | [**gifs_gif_id_get**](docs/DefaultApi.md#gifs_gif_id_get) | **GET** /gifs/{gif_id} | Get GIF by ID Endpoint
|
95
|
+
*GiphyClient::DefaultApi* | [**gifs_random_get**](docs/DefaultApi.md#gifs_random_get) | **GET** /gifs/random | Random Endpoint
|
96
|
+
*GiphyClient::DefaultApi* | [**gifs_search_get**](docs/DefaultApi.md#gifs_search_get) | **GET** /gifs/search | Search Endpoint
|
97
|
+
*GiphyClient::DefaultApi* | [**gifs_translate_get**](docs/DefaultApi.md#gifs_translate_get) | **GET** /gifs/translate | Translate Endpoint
|
98
|
+
*GiphyClient::DefaultApi* | [**gifs_trending_get**](docs/DefaultApi.md#gifs_trending_get) | **GET** /gifs/trending | Trending GIFs Endpoint
|
99
|
+
*GiphyClient::DefaultApi* | [**stickers_random_get**](docs/DefaultApi.md#stickers_random_get) | **GET** /stickers/random | Random Sticker Endpoint
|
100
|
+
*GiphyClient::DefaultApi* | [**stickers_search_get**](docs/DefaultApi.md#stickers_search_get) | **GET** /stickers/search | Sticker Search Endpoint
|
101
|
+
*GiphyClient::DefaultApi* | [**stickers_translate_get**](docs/DefaultApi.md#stickers_translate_get) | **GET** /stickers/translate | Sticker Translate Endpoint
|
102
|
+
*GiphyClient::DefaultApi* | [**stickers_trending_get**](docs/DefaultApi.md#stickers_trending_get) | **GET** /stickers/trending | Trending Stickers Endpoint
|
103
|
+
|
104
|
+
|
105
|
+
## Documentation for Models
|
106
|
+
|
107
|
+
- [GiphyClient::BaseChannelModel](docs/BaseChannelModel.md)
|
108
|
+
- [GiphyClient::BaseChannelModelGifs](docs/BaseChannelModelGifs.md)
|
109
|
+
- [GiphyClient::Breadcrumb](docs/Breadcrumb.md)
|
110
|
+
- [GiphyClient::Category](docs/Category.md)
|
111
|
+
- [GiphyClient::ChannelWithChildrenModel](docs/ChannelWithChildrenModel.md)
|
112
|
+
- [GiphyClient::ChannelWithChildrenModelChildren](docs/ChannelWithChildrenModelChildren.md)
|
113
|
+
- [GiphyClient::Gif](docs/Gif.md)
|
114
|
+
- [GiphyClient::GifImages](docs/GifImages.md)
|
115
|
+
- [GiphyClient::GifImagesDownsized](docs/GifImagesDownsized.md)
|
116
|
+
- [GiphyClient::GifImagesDownsizedLarge](docs/GifImagesDownsizedLarge.md)
|
117
|
+
- [GiphyClient::GifImagesDownsizedMedium](docs/GifImagesDownsizedMedium.md)
|
118
|
+
- [GiphyClient::GifImagesDownsizedSmall](docs/GifImagesDownsizedSmall.md)
|
119
|
+
- [GiphyClient::GifImagesDownsizedStill](docs/GifImagesDownsizedStill.md)
|
120
|
+
- [GiphyClient::GifImagesFixedHeight](docs/GifImagesFixedHeight.md)
|
121
|
+
- [GiphyClient::GifImagesFixedHeightDownsampled](docs/GifImagesFixedHeightDownsampled.md)
|
122
|
+
- [GiphyClient::GifImagesFixedHeightSmall](docs/GifImagesFixedHeightSmall.md)
|
123
|
+
- [GiphyClient::GifImagesFixedHeightSmallStill](docs/GifImagesFixedHeightSmallStill.md)
|
124
|
+
- [GiphyClient::GifImagesFixedHeightStill](docs/GifImagesFixedHeightStill.md)
|
125
|
+
- [GiphyClient::GifImagesFixedWidth](docs/GifImagesFixedWidth.md)
|
126
|
+
- [GiphyClient::GifImagesFixedWidthDownsampled](docs/GifImagesFixedWidthDownsampled.md)
|
127
|
+
- [GiphyClient::GifImagesFixedWidthSmall](docs/GifImagesFixedWidthSmall.md)
|
128
|
+
- [GiphyClient::GifImagesFixedWidthSmallStill](docs/GifImagesFixedWidthSmallStill.md)
|
129
|
+
- [GiphyClient::GifImagesFixedWidthStill](docs/GifImagesFixedWidthStill.md)
|
130
|
+
- [GiphyClient::GifImagesLooping](docs/GifImagesLooping.md)
|
131
|
+
- [GiphyClient::GifImagesOriginal](docs/GifImagesOriginal.md)
|
132
|
+
- [GiphyClient::GifImagesOriginalStill](docs/GifImagesOriginalStill.md)
|
133
|
+
- [GiphyClient::GifImagesPreview](docs/GifImagesPreview.md)
|
134
|
+
- [GiphyClient::GifImagesPreviewGif](docs/GifImagesPreviewGif.md)
|
135
|
+
- [GiphyClient::InlineResponse200](docs/InlineResponse200.md)
|
136
|
+
- [GiphyClient::InlineResponse2001](docs/InlineResponse2001.md)
|
137
|
+
- [GiphyClient::InlineResponse2002](docs/InlineResponse2002.md)
|
138
|
+
- [GiphyClient::InlineResponse2003](docs/InlineResponse2003.md)
|
139
|
+
- [GiphyClient::InlineResponse2004](docs/InlineResponse2004.md)
|
140
|
+
- [GiphyClient::InlineResponse2005](docs/InlineResponse2005.md)
|
141
|
+
- [GiphyClient::InlineResponse400](docs/InlineResponse400.md)
|
142
|
+
- [GiphyClient::LastChildModel](docs/LastChildModel.md)
|
143
|
+
- [GiphyClient::LastChildModelChildren](docs/LastChildModelChildren.md)
|
144
|
+
- [GiphyClient::MetaContent](docs/MetaContent.md)
|
145
|
+
- [GiphyClient::MetaObject](docs/MetaObject.md)
|
146
|
+
- [GiphyClient::Pagination](docs/Pagination.md)
|
147
|
+
- [GiphyClient::RandomGif](docs/RandomGif.md)
|
148
|
+
- [GiphyClient::ShallowTag](docs/ShallowTag.md)
|
149
|
+
- [GiphyClient::Tag](docs/Tag.md)
|
150
|
+
- [GiphyClient::TrendingTag](docs/TrendingTag.md)
|
151
|
+
- [GiphyClient::User](docs/User.md)
|
152
|
+
|
data/Rakefile
ADDED
data/config.json
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
{
|
2
|
+
|
3
|
+
"sortParamsByRequiredFlag": true,
|
4
|
+
"ensureUniqueParams": true,
|
5
|
+
"allowUnicodeIdentifiers": true,
|
6
|
+
"gemName": "GiphyClient",
|
7
|
+
"moduleName": "GiphyClient",
|
8
|
+
"gemVersion": "1.0.0",
|
9
|
+
"gemLicense": "MIT",
|
10
|
+
"gemHomepage": "https://github.com/Giphy/giphy-ruby-client",
|
11
|
+
"gemSummary": "Networking client for the Giphy API.",
|
12
|
+
|
13
|
+
"__gemDescription": "",
|
14
|
+
"__gemRequiredRubyVersion": "",
|
15
|
+
"__gemAuthor": "",
|
16
|
+
"__gemAuthorEmail": "",
|
17
|
+
"__hideGenerationTimestamp": ""
|
18
|
+
}
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# GiphyClient::BaseChannelModel
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**type** | **String** | Always \"channel\" | [optional] [default to "channel"]
|
7
|
+
**id** | **Integer** | 123 | [optional]
|
8
|
+
**parent** | **String** | parent's slug | [optional]
|
9
|
+
**create_datetime** | **String** | xyz | [optional]
|
10
|
+
**breadcrumbs** | [**Array<Breadcrumb>**](Breadcrumb.md) | | [optional]
|
11
|
+
**username** | **String** | xyz | [optional]
|
12
|
+
**slug** | **String** | | [optional]
|
13
|
+
**title** | **String** | xyz | [optional]
|
14
|
+
**short_title** | **String** | xyz | [optional]
|
15
|
+
**description** | **String** | xyz | [optional]
|
16
|
+
**featured_gif** | [**Gif**](Gif.md) | | [optional]
|
17
|
+
**banner_image** | **String** | xyz | [optional]
|
18
|
+
**avatar_image** | **String** | xyz | [optional]
|
19
|
+
**screensaver_gif** | [**Gif**](Gif.md) | | [optional]
|
20
|
+
**is_private** | **BOOLEAN** | | [optional]
|
21
|
+
**is_live** | **BOOLEAN** | | [optional]
|
22
|
+
**event_start_datetime** | **String** | xyz | [optional]
|
23
|
+
**event_end_datetime** | **String** | xyz | [optional]
|
24
|
+
**has_children** | **BOOLEAN** | | [optional]
|
25
|
+
**url** | **String** | xyz | [optional]
|
26
|
+
**website_url** | **String** | xyz | [optional]
|
27
|
+
**instagram_url** | **String** | xyz | [optional]
|
28
|
+
**twitter_url** | **String** | xyz | [optional]
|
29
|
+
**facebook_url** | **String** | xyz | [optional]
|
30
|
+
**pinterest_url** | **String** | xyz | [optional]
|
31
|
+
**tumblr_url** | **String** | xyz | [optional]
|
32
|
+
**user** | [**User**](User.md) | | [optional]
|
33
|
+
**trending_tags** | [**Array<TrendingTag>**](TrendingTag.md) | | [optional]
|
34
|
+
**gifs** | [**BaseChannelModelGifs**](BaseChannelModelGifs.md) | | [optional]
|
35
|
+
|
36
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# GiphyClient::BaseChannelModelGifs
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**data** | [**Array<Gif>**](Gif.md) | | [optional]
|
7
|
+
**pagination** | [**Pagination**](Pagination.md) | | [optional]
|
8
|
+
|
9
|
+
|
data/docs/Breadcrumb.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# GiphyClient::Breadcrumb
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**url** | **String** | | [optional]
|
7
|
+
**id** | **Integer** | | [optional]
|
8
|
+
**name** | **String** | | [optional]
|
9
|
+
|
10
|
+
|
data/docs/Category.md
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
# GiphyClient::Category
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | Category name | [optional]
|
7
|
+
**name_encoded** | **String** | Category name, with dashes '-' instead of spaces ' '. | [optional]
|
8
|
+
**subcategories** | [**Array<ShallowTag>**](ShallowTag.md) | subcategories are tags for a given category. Use them with the `/gifs/categories/:category/:tag` endpoint | [optional]
|
9
|
+
**gif** | [**Gif**](Gif.md) | A gif which can be used as the icon for this category. | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,37 @@
|
|
1
|
+
# GiphyClient::ChannelWithChildrenModel
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**type** | **String** | Always \"channel\" | [optional] [default to "channel"]
|
7
|
+
**id** | **Integer** | 123 | [optional]
|
8
|
+
**parent** | **String** | parent's slug | [optional]
|
9
|
+
**create_datetime** | **String** | xyz | [optional]
|
10
|
+
**breadcrumbs** | [**Array<Breadcrumb>**](Breadcrumb.md) | | [optional]
|
11
|
+
**username** | **String** | xyz | [optional]
|
12
|
+
**slug** | **String** | | [optional]
|
13
|
+
**title** | **String** | xyz | [optional]
|
14
|
+
**short_title** | **String** | xyz | [optional]
|
15
|
+
**description** | **String** | xyz | [optional]
|
16
|
+
**featured_gif** | [**Gif**](Gif.md) | | [optional]
|
17
|
+
**banner_image** | **String** | xyz | [optional]
|
18
|
+
**avatar_image** | **String** | xyz | [optional]
|
19
|
+
**screensaver_gif** | [**Gif**](Gif.md) | | [optional]
|
20
|
+
**is_private** | **BOOLEAN** | | [optional]
|
21
|
+
**is_live** | **BOOLEAN** | | [optional]
|
22
|
+
**event_start_datetime** | **String** | xyz | [optional]
|
23
|
+
**event_end_datetime** | **String** | xyz | [optional]
|
24
|
+
**has_children** | **BOOLEAN** | | [optional]
|
25
|
+
**url** | **String** | xyz | [optional]
|
26
|
+
**website_url** | **String** | xyz | [optional]
|
27
|
+
**instagram_url** | **String** | xyz | [optional]
|
28
|
+
**twitter_url** | **String** | xyz | [optional]
|
29
|
+
**facebook_url** | **String** | xyz | [optional]
|
30
|
+
**pinterest_url** | **String** | xyz | [optional]
|
31
|
+
**tumblr_url** | **String** | xyz | [optional]
|
32
|
+
**user** | [**User**](User.md) | | [optional]
|
33
|
+
**trending_tags** | [**Array<TrendingTag>**](TrendingTag.md) | | [optional]
|
34
|
+
**gifs** | [**BaseChannelModelGifs**](BaseChannelModelGifs.md) | | [optional]
|
35
|
+
**children** | [**ChannelWithChildrenModelChildren**](ChannelWithChildrenModelChildren.md) | | [optional]
|
36
|
+
|
37
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# GiphyClient::ChannelWithChildrenModelChildren
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**data** | [**Array<LastChildModel>**](LastChildModel.md) | | [optional]
|
7
|
+
**pagination** | [**Pagination**](Pagination.md) | | [optional]
|
8
|
+
|
9
|
+
|
data/docs/DefaultApi.md
ADDED
@@ -0,0 +1,731 @@
|
|
1
|
+
# GiphyClient::DefaultApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://api.giphy.com/v1*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**gifs_categories_category_get**](DefaultApi.md#gifs_categories_category_get) | **GET** /gifs/categories/{category} | Category Tags Endpoint.
|
8
|
+
[**gifs_categories_category_tag_get**](DefaultApi.md#gifs_categories_category_tag_get) | **GET** /gifs/categories/{category}/{tag} | Tagged Gifs Endpoint.
|
9
|
+
[**gifs_categories_get**](DefaultApi.md#gifs_categories_get) | **GET** /gifs/categories | Categories Endpoint.
|
10
|
+
[**gifs_get**](DefaultApi.md#gifs_get) | **GET** /gifs | Get GIFs by ID Endpoint
|
11
|
+
[**gifs_gif_id_get**](DefaultApi.md#gifs_gif_id_get) | **GET** /gifs/{gif_id} | Get GIF by ID Endpoint
|
12
|
+
[**gifs_random_get**](DefaultApi.md#gifs_random_get) | **GET** /gifs/random | Random Endpoint
|
13
|
+
[**gifs_search_get**](DefaultApi.md#gifs_search_get) | **GET** /gifs/search | Search Endpoint
|
14
|
+
[**gifs_translate_get**](DefaultApi.md#gifs_translate_get) | **GET** /gifs/translate | Translate Endpoint
|
15
|
+
[**gifs_trending_get**](DefaultApi.md#gifs_trending_get) | **GET** /gifs/trending | Trending GIFs Endpoint
|
16
|
+
[**stickers_random_get**](DefaultApi.md#stickers_random_get) | **GET** /stickers/random | Random Sticker Endpoint
|
17
|
+
[**stickers_search_get**](DefaultApi.md#stickers_search_get) | **GET** /stickers/search | Sticker Search Endpoint
|
18
|
+
[**stickers_translate_get**](DefaultApi.md#stickers_translate_get) | **GET** /stickers/translate | Sticker Translate Endpoint
|
19
|
+
[**stickers_trending_get**](DefaultApi.md#stickers_trending_get) | **GET** /stickers/trending | Trending Stickers Endpoint
|
20
|
+
|
21
|
+
|
22
|
+
# **gifs_categories_category_get**
|
23
|
+
> InlineResponse2004 gifs_categories_category_get(api_keycategory, , opts)
|
24
|
+
|
25
|
+
Category Tags Endpoint.
|
26
|
+
|
27
|
+
Returns a list of tags for a given category. NOTE `limit` and `offset` must both be set; otherwise they're ignored.
|
28
|
+
|
29
|
+
### Example
|
30
|
+
```ruby
|
31
|
+
# load the gem
|
32
|
+
require 'GiphyClient'
|
33
|
+
|
34
|
+
api_instance = GiphyClient::DefaultApi.new
|
35
|
+
|
36
|
+
api_key = "dc6zaTOxFJmzC" # String | Giphy API Key.
|
37
|
+
|
38
|
+
category = "category_example" # String | Filters results by category.
|
39
|
+
|
40
|
+
opts = {
|
41
|
+
limit: 25, # Integer | The maximum number of records to return.
|
42
|
+
offset: 0, # Integer | An optional results offset. Defaults to 0.
|
43
|
+
}
|
44
|
+
|
45
|
+
begin
|
46
|
+
#Category Tags Endpoint.
|
47
|
+
result = api_instance.gifs_categories_category_get(api_keycategory, , opts)
|
48
|
+
p result
|
49
|
+
rescue GiphyClient::ApiError => e
|
50
|
+
puts "Exception when calling DefaultApi->gifs_categories_category_get: #{e}"
|
51
|
+
end
|
52
|
+
```
|
53
|
+
|
54
|
+
### Parameters
|
55
|
+
|
56
|
+
Name | Type | Description | Notes
|
57
|
+
------------- | ------------- | ------------- | -------------
|
58
|
+
**api_key** | **String**| Giphy API Key. |
|
59
|
+
**category** | **String**| Filters results by category. |
|
60
|
+
**limit** | **Integer**| The maximum number of records to return. | [optional] [default to 25]
|
61
|
+
**offset** | **Integer**| An optional results offset. Defaults to 0. | [optional] [default to 0]
|
62
|
+
|
63
|
+
### Return type
|
64
|
+
|
65
|
+
[**InlineResponse2004**](InlineResponse2004.md)
|
66
|
+
|
67
|
+
### Authorization
|
68
|
+
|
69
|
+
No authorization required
|
70
|
+
|
71
|
+
### HTTP request headers
|
72
|
+
|
73
|
+
- **Content-Type**: application/json
|
74
|
+
- **Accept**: application/json
|
75
|
+
|
76
|
+
|
77
|
+
|
78
|
+
# **gifs_categories_category_tag_get**
|
79
|
+
> InlineResponse2005 gifs_categories_category_tag_get(api_keycategory, tag, opts)
|
80
|
+
|
81
|
+
Tagged Gifs Endpoint.
|
82
|
+
|
83
|
+
Returns a list of gifs for a given tag (alias to `/gif/search`).
|
84
|
+
|
85
|
+
### Example
|
86
|
+
```ruby
|
87
|
+
# load the gem
|
88
|
+
require 'GiphyClient'
|
89
|
+
|
90
|
+
api_instance = GiphyClient::DefaultApi.new
|
91
|
+
|
92
|
+
api_key = "dc6zaTOxFJmzC" # String | Giphy API Key.
|
93
|
+
|
94
|
+
category = "category_example" # String | Filters results by category.
|
95
|
+
|
96
|
+
tag = "tag_example" # String | Filters results by tag.
|
97
|
+
|
98
|
+
opts = {
|
99
|
+
limit: 25, # Integer | The maximum number of records to return.
|
100
|
+
offset: 0, # Integer | An optional results offset. Defaults to 0.
|
101
|
+
}
|
102
|
+
|
103
|
+
begin
|
104
|
+
#Tagged Gifs Endpoint.
|
105
|
+
result = api_instance.gifs_categories_category_tag_get(api_keycategory, tag, opts)
|
106
|
+
p result
|
107
|
+
rescue GiphyClient::ApiError => e
|
108
|
+
puts "Exception when calling DefaultApi->gifs_categories_category_tag_get: #{e}"
|
109
|
+
end
|
110
|
+
```
|
111
|
+
|
112
|
+
### Parameters
|
113
|
+
|
114
|
+
Name | Type | Description | Notes
|
115
|
+
------------- | ------------- | ------------- | -------------
|
116
|
+
**api_key** | **String**| Giphy API Key. |
|
117
|
+
**category** | **String**| Filters results by category. |
|
118
|
+
**tag** | **String**| Filters results by tag. |
|
119
|
+
**limit** | **Integer**| The maximum number of records to return. | [optional] [default to 25]
|
120
|
+
**offset** | **Integer**| An optional results offset. Defaults to 0. | [optional] [default to 0]
|
121
|
+
|
122
|
+
### Return type
|
123
|
+
|
124
|
+
[**InlineResponse2005**](InlineResponse2005.md)
|
125
|
+
|
126
|
+
### Authorization
|
127
|
+
|
128
|
+
No authorization required
|
129
|
+
|
130
|
+
### HTTP request headers
|
131
|
+
|
132
|
+
- **Content-Type**: application/json
|
133
|
+
- **Accept**: application/json
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
# **gifs_categories_get**
|
138
|
+
> InlineResponse2003 gifs_categories_get(api_key, opts)
|
139
|
+
|
140
|
+
Categories Endpoint.
|
141
|
+
|
142
|
+
Returns a list of categories.
|
143
|
+
|
144
|
+
### Example
|
145
|
+
```ruby
|
146
|
+
# load the gem
|
147
|
+
require 'GiphyClient'
|
148
|
+
|
149
|
+
api_instance = GiphyClient::DefaultApi.new
|
150
|
+
|
151
|
+
api_key = "dc6zaTOxFJmzC" # String | Giphy API Key.
|
152
|
+
|
153
|
+
opts = {
|
154
|
+
limit: 25, # Integer | The maximum number of records to return.
|
155
|
+
}
|
156
|
+
|
157
|
+
begin
|
158
|
+
#Categories Endpoint.
|
159
|
+
result = api_instance.gifs_categories_get(api_key, opts)
|
160
|
+
p result
|
161
|
+
rescue GiphyClient::ApiError => e
|
162
|
+
puts "Exception when calling DefaultApi->gifs_categories_get: #{e}"
|
163
|
+
end
|
164
|
+
```
|
165
|
+
|
166
|
+
### Parameters
|
167
|
+
|
168
|
+
Name | Type | Description | Notes
|
169
|
+
------------- | ------------- | ------------- | -------------
|
170
|
+
**api_key** | **String**| Giphy API Key. |
|
171
|
+
**limit** | **Integer**| The maximum number of records to return. | [optional] [default to 25]
|
172
|
+
|
173
|
+
### Return type
|
174
|
+
|
175
|
+
[**InlineResponse2003**](InlineResponse2003.md)
|
176
|
+
|
177
|
+
### Authorization
|
178
|
+
|
179
|
+
No authorization required
|
180
|
+
|
181
|
+
### HTTP request headers
|
182
|
+
|
183
|
+
- **Content-Type**: application/json
|
184
|
+
- **Accept**: application/json
|
185
|
+
|
186
|
+
|
187
|
+
|
188
|
+
# **gifs_get**
|
189
|
+
> InlineResponse200 gifs_get(api_keyids)
|
190
|
+
|
191
|
+
Get GIFs by ID Endpoint
|
192
|
+
|
193
|
+
A multiget version of the get GIF by ID endpoint.
|
194
|
+
|
195
|
+
### Example
|
196
|
+
```ruby
|
197
|
+
# load the gem
|
198
|
+
require 'GiphyClient'
|
199
|
+
|
200
|
+
api_instance = GiphyClient::DefaultApi.new
|
201
|
+
|
202
|
+
api_key = "dc6zaTOxFJmzC" # String | Giphy API Key.
|
203
|
+
|
204
|
+
ids = "feqkVgjJpYtjy,7rzbxdu0ZEXLy" # String | Filters results by specified GIF IDs, separated by commas.
|
205
|
+
|
206
|
+
|
207
|
+
begin
|
208
|
+
#Get GIFs by ID Endpoint
|
209
|
+
result = api_instance.gifs_get(api_keyids)
|
210
|
+
p result
|
211
|
+
rescue GiphyClient::ApiError => e
|
212
|
+
puts "Exception when calling DefaultApi->gifs_get: #{e}"
|
213
|
+
end
|
214
|
+
```
|
215
|
+
|
216
|
+
### Parameters
|
217
|
+
|
218
|
+
Name | Type | Description | Notes
|
219
|
+
------------- | ------------- | ------------- | -------------
|
220
|
+
**api_key** | **String**| Giphy API Key. |
|
221
|
+
**ids** | **String**| Filters results by specified GIF IDs, separated by commas. |
|
222
|
+
|
223
|
+
### Return type
|
224
|
+
|
225
|
+
[**InlineResponse200**](InlineResponse200.md)
|
226
|
+
|
227
|
+
### Authorization
|
228
|
+
|
229
|
+
No authorization required
|
230
|
+
|
231
|
+
### HTTP request headers
|
232
|
+
|
233
|
+
- **Content-Type**: application/json
|
234
|
+
- **Accept**: application/json
|
235
|
+
|
236
|
+
|
237
|
+
|
238
|
+
# **gifs_gif_id_get**
|
239
|
+
> InlineResponse2001 gifs_gif_id_get(api_keygif_id)
|
240
|
+
|
241
|
+
Get GIF by ID Endpoint
|
242
|
+
|
243
|
+
Returns a GIF given that GIF's unique ID
|
244
|
+
|
245
|
+
### Example
|
246
|
+
```ruby
|
247
|
+
# load the gem
|
248
|
+
require 'GiphyClient'
|
249
|
+
|
250
|
+
api_instance = GiphyClient::DefaultApi.new
|
251
|
+
|
252
|
+
api_key = "dc6zaTOxFJmzC" # String | Giphy API Key.
|
253
|
+
|
254
|
+
gif_id = "gif_id_example" # String | Filters results by specified GIF ID.
|
255
|
+
|
256
|
+
|
257
|
+
begin
|
258
|
+
#Get GIF by ID Endpoint
|
259
|
+
result = api_instance.gifs_gif_id_get(api_keygif_id)
|
260
|
+
p result
|
261
|
+
rescue GiphyClient::ApiError => e
|
262
|
+
puts "Exception when calling DefaultApi->gifs_gif_id_get: #{e}"
|
263
|
+
end
|
264
|
+
```
|
265
|
+
|
266
|
+
### Parameters
|
267
|
+
|
268
|
+
Name | Type | Description | Notes
|
269
|
+
------------- | ------------- | ------------- | -------------
|
270
|
+
**api_key** | **String**| Giphy API Key. |
|
271
|
+
**gif_id** | **String**| Filters results by specified GIF ID. |
|
272
|
+
|
273
|
+
### Return type
|
274
|
+
|
275
|
+
[**InlineResponse2001**](InlineResponse2001.md)
|
276
|
+
|
277
|
+
### Authorization
|
278
|
+
|
279
|
+
No authorization required
|
280
|
+
|
281
|
+
### HTTP request headers
|
282
|
+
|
283
|
+
- **Content-Type**: application/json
|
284
|
+
- **Accept**: application/json
|
285
|
+
|
286
|
+
|
287
|
+
|
288
|
+
# **gifs_random_get**
|
289
|
+
> InlineResponse2002 gifs_random_get(api_key, opts)
|
290
|
+
|
291
|
+
Random Endpoint
|
292
|
+
|
293
|
+
Returns a random GIF, limited by tag. Excluding the tag parameter will return a random GIF from the GIPHY catalog.
|
294
|
+
|
295
|
+
### Example
|
296
|
+
```ruby
|
297
|
+
# load the gem
|
298
|
+
require 'GiphyClient'
|
299
|
+
|
300
|
+
api_instance = GiphyClient::DefaultApi.new
|
301
|
+
|
302
|
+
api_key = "dc6zaTOxFJmzC" # String | Giphy API Key.
|
303
|
+
|
304
|
+
opts = {
|
305
|
+
tag: "burrito", # String | Filters results by specified tag.
|
306
|
+
rating: "g", # String | Filters results by specified rating.
|
307
|
+
fmt: "json" # String | Used to indicate the expected response format. Default is Json.
|
308
|
+
}
|
309
|
+
|
310
|
+
begin
|
311
|
+
#Random Endpoint
|
312
|
+
result = api_instance.gifs_random_get(api_key, opts)
|
313
|
+
p result
|
314
|
+
rescue GiphyClient::ApiError => e
|
315
|
+
puts "Exception when calling DefaultApi->gifs_random_get: #{e}"
|
316
|
+
end
|
317
|
+
```
|
318
|
+
|
319
|
+
### Parameters
|
320
|
+
|
321
|
+
Name | Type | Description | Notes
|
322
|
+
------------- | ------------- | ------------- | -------------
|
323
|
+
**api_key** | **String**| Giphy API Key. |
|
324
|
+
**tag** | **String**| Filters results by specified tag. | [optional]
|
325
|
+
**rating** | **String**| Filters results by specified rating. | [optional]
|
326
|
+
**fmt** | **String**| Used to indicate the expected response format. Default is Json. | [optional] [default to json]
|
327
|
+
|
328
|
+
### Return type
|
329
|
+
|
330
|
+
[**InlineResponse2002**](InlineResponse2002.md)
|
331
|
+
|
332
|
+
### Authorization
|
333
|
+
|
334
|
+
No authorization required
|
335
|
+
|
336
|
+
### HTTP request headers
|
337
|
+
|
338
|
+
- **Content-Type**: application/json
|
339
|
+
- **Accept**: application/json
|
340
|
+
|
341
|
+
|
342
|
+
|
343
|
+
# **gifs_search_get**
|
344
|
+
> InlineResponse200 gifs_search_get(api_keyq, opts)
|
345
|
+
|
346
|
+
Search Endpoint
|
347
|
+
|
348
|
+
Search all Giphy GIFs for a word or phrase. Punctuation will be stripped and ignored. Use a plus or url encode for phrases. Example paul+rudd, ryan+gosling or american+psycho.
|
349
|
+
|
350
|
+
### Example
|
351
|
+
```ruby
|
352
|
+
# load the gem
|
353
|
+
require 'GiphyClient'
|
354
|
+
|
355
|
+
api_instance = GiphyClient::DefaultApi.new
|
356
|
+
|
357
|
+
api_key = "dc6zaTOxFJmzC" # String | Giphy API Key.
|
358
|
+
|
359
|
+
q = "cheeseburgers" # String | Search query term or prhase.
|
360
|
+
|
361
|
+
opts = {
|
362
|
+
limit: 25, # Integer | The maximum number of records to return.
|
363
|
+
offset: 0, # Integer | An optional results offset. Defaults to 0.
|
364
|
+
rating: "g", # String | Filters results by specified rating.
|
365
|
+
lang: "en", # String | Specify default country for regional content; use a 2-letter ISO 639-1 country code. See list of supported languages <a href = \"../language-support\">here</a>.
|
366
|
+
fmt: "json" # String | Used to indicate the expected response format. Default is Json.
|
367
|
+
}
|
368
|
+
|
369
|
+
begin
|
370
|
+
#Search Endpoint
|
371
|
+
result = api_instance.gifs_search_get(api_keyq, opts)
|
372
|
+
p result
|
373
|
+
rescue GiphyClient::ApiError => e
|
374
|
+
puts "Exception when calling DefaultApi->gifs_search_get: #{e}"
|
375
|
+
end
|
376
|
+
```
|
377
|
+
|
378
|
+
### Parameters
|
379
|
+
|
380
|
+
Name | Type | Description | Notes
|
381
|
+
------------- | ------------- | ------------- | -------------
|
382
|
+
**api_key** | **String**| Giphy API Key. |
|
383
|
+
**q** | **String**| Search query term or prhase. |
|
384
|
+
**limit** | **Integer**| The maximum number of records to return. | [optional] [default to 25]
|
385
|
+
**offset** | **Integer**| An optional results offset. Defaults to 0. | [optional] [default to 0]
|
386
|
+
**rating** | **String**| Filters results by specified rating. | [optional]
|
387
|
+
**lang** | **String**| Specify default country for regional content; use a 2-letter ISO 639-1 country code. See list of supported languages <a href = \"../language-support\">here</a>. | [optional]
|
388
|
+
**fmt** | **String**| Used to indicate the expected response format. Default is Json. | [optional] [default to json]
|
389
|
+
|
390
|
+
### Return type
|
391
|
+
|
392
|
+
[**InlineResponse200**](InlineResponse200.md)
|
393
|
+
|
394
|
+
### Authorization
|
395
|
+
|
396
|
+
No authorization required
|
397
|
+
|
398
|
+
### HTTP request headers
|
399
|
+
|
400
|
+
- **Content-Type**: application/json
|
401
|
+
- **Accept**: application/json
|
402
|
+
|
403
|
+
|
404
|
+
|
405
|
+
# **gifs_translate_get**
|
406
|
+
> InlineResponse2001 gifs_translate_get(api_keys)
|
407
|
+
|
408
|
+
Translate Endpoint
|
409
|
+
|
410
|
+
The translate API draws on search, but uses the Giphy `special sauce` to handle translating from one vocabulary to another. In this case, words and phrases to GIFs.
|
411
|
+
|
412
|
+
### Example
|
413
|
+
```ruby
|
414
|
+
# load the gem
|
415
|
+
require 'GiphyClient'
|
416
|
+
|
417
|
+
api_instance = GiphyClient::DefaultApi.new
|
418
|
+
|
419
|
+
api_key = "dc6zaTOxFJmzC" # String | Giphy API Key.
|
420
|
+
|
421
|
+
s = "ryan gosling" # String | Search term.
|
422
|
+
|
423
|
+
|
424
|
+
begin
|
425
|
+
#Translate Endpoint
|
426
|
+
result = api_instance.gifs_translate_get(api_keys)
|
427
|
+
p result
|
428
|
+
rescue GiphyClient::ApiError => e
|
429
|
+
puts "Exception when calling DefaultApi->gifs_translate_get: #{e}"
|
430
|
+
end
|
431
|
+
```
|
432
|
+
|
433
|
+
### Parameters
|
434
|
+
|
435
|
+
Name | Type | Description | Notes
|
436
|
+
------------- | ------------- | ------------- | -------------
|
437
|
+
**api_key** | **String**| Giphy API Key. |
|
438
|
+
**s** | **String**| Search term. |
|
439
|
+
|
440
|
+
### Return type
|
441
|
+
|
442
|
+
[**InlineResponse2001**](InlineResponse2001.md)
|
443
|
+
|
444
|
+
### Authorization
|
445
|
+
|
446
|
+
No authorization required
|
447
|
+
|
448
|
+
### HTTP request headers
|
449
|
+
|
450
|
+
- **Content-Type**: application/json
|
451
|
+
- **Accept**: application/json
|
452
|
+
|
453
|
+
|
454
|
+
|
455
|
+
# **gifs_trending_get**
|
456
|
+
> InlineResponse200 gifs_trending_get(api_key, opts)
|
457
|
+
|
458
|
+
Trending GIFs Endpoint
|
459
|
+
|
460
|
+
Fetch GIFs currently trending online. Hand curated by the GIPHY editorial team. The data returned mirrors the GIFs showcased on the <a href = \"http://www.giphy.com\">GIPHY homepage</a>. Returns 25 results by default.
|
461
|
+
|
462
|
+
### Example
|
463
|
+
```ruby
|
464
|
+
# load the gem
|
465
|
+
require 'GiphyClient'
|
466
|
+
|
467
|
+
api_instance = GiphyClient::DefaultApi.new
|
468
|
+
|
469
|
+
api_key = "dc6zaTOxFJmzC" # String | Giphy API Key.
|
470
|
+
|
471
|
+
opts = {
|
472
|
+
limit: 25, # Integer | The maximum number of records to return.
|
473
|
+
rating: "g", # String | Filters results by specified rating.
|
474
|
+
fmt: "json" # String | Used to indicate the expected response format. Default is Json.
|
475
|
+
}
|
476
|
+
|
477
|
+
begin
|
478
|
+
#Trending GIFs Endpoint
|
479
|
+
result = api_instance.gifs_trending_get(api_key, opts)
|
480
|
+
p result
|
481
|
+
rescue GiphyClient::ApiError => e
|
482
|
+
puts "Exception when calling DefaultApi->gifs_trending_get: #{e}"
|
483
|
+
end
|
484
|
+
```
|
485
|
+
|
486
|
+
### Parameters
|
487
|
+
|
488
|
+
Name | Type | Description | Notes
|
489
|
+
------------- | ------------- | ------------- | -------------
|
490
|
+
**api_key** | **String**| Giphy API Key. |
|
491
|
+
**limit** | **Integer**| The maximum number of records to return. | [optional] [default to 25]
|
492
|
+
**rating** | **String**| Filters results by specified rating. | [optional]
|
493
|
+
**fmt** | **String**| Used to indicate the expected response format. Default is Json. | [optional] [default to json]
|
494
|
+
|
495
|
+
### Return type
|
496
|
+
|
497
|
+
[**InlineResponse200**](InlineResponse200.md)
|
498
|
+
|
499
|
+
### Authorization
|
500
|
+
|
501
|
+
No authorization required
|
502
|
+
|
503
|
+
### HTTP request headers
|
504
|
+
|
505
|
+
- **Content-Type**: application/json
|
506
|
+
- **Accept**: application/json
|
507
|
+
|
508
|
+
|
509
|
+
|
510
|
+
# **stickers_random_get**
|
511
|
+
> InlineResponse2002 stickers_random_get(api_key, opts)
|
512
|
+
|
513
|
+
Random Sticker Endpoint
|
514
|
+
|
515
|
+
Returns a random GIF, limited by tag. Excluding the tag parameter will return a random GIF from the GIPHY catalog.
|
516
|
+
|
517
|
+
### Example
|
518
|
+
```ruby
|
519
|
+
# load the gem
|
520
|
+
require 'GiphyClient'
|
521
|
+
|
522
|
+
api_instance = GiphyClient::DefaultApi.new
|
523
|
+
|
524
|
+
api_key = "dc6zaTOxFJmzC" # String | Giphy API Key.
|
525
|
+
|
526
|
+
opts = {
|
527
|
+
tag: "burrito", # String | Filters results by specified tag.
|
528
|
+
rating: "g", # String | Filters results by specified rating.
|
529
|
+
fmt: "json" # String | Used to indicate the expected response format. Default is Json.
|
530
|
+
}
|
531
|
+
|
532
|
+
begin
|
533
|
+
#Random Sticker Endpoint
|
534
|
+
result = api_instance.stickers_random_get(api_key, opts)
|
535
|
+
p result
|
536
|
+
rescue GiphyClient::ApiError => e
|
537
|
+
puts "Exception when calling DefaultApi->stickers_random_get: #{e}"
|
538
|
+
end
|
539
|
+
```
|
540
|
+
|
541
|
+
### Parameters
|
542
|
+
|
543
|
+
Name | Type | Description | Notes
|
544
|
+
------------- | ------------- | ------------- | -------------
|
545
|
+
**api_key** | **String**| Giphy API Key. |
|
546
|
+
**tag** | **String**| Filters results by specified tag. | [optional]
|
547
|
+
**rating** | **String**| Filters results by specified rating. | [optional]
|
548
|
+
**fmt** | **String**| Used to indicate the expected response format. Default is Json. | [optional] [default to json]
|
549
|
+
|
550
|
+
### Return type
|
551
|
+
|
552
|
+
[**InlineResponse2002**](InlineResponse2002.md)
|
553
|
+
|
554
|
+
### Authorization
|
555
|
+
|
556
|
+
No authorization required
|
557
|
+
|
558
|
+
### HTTP request headers
|
559
|
+
|
560
|
+
- **Content-Type**: application/json
|
561
|
+
- **Accept**: application/json
|
562
|
+
|
563
|
+
|
564
|
+
|
565
|
+
# **stickers_search_get**
|
566
|
+
> InlineResponse200 stickers_search_get(api_keyq, opts)
|
567
|
+
|
568
|
+
Sticker Search Endpoint
|
569
|
+
|
570
|
+
Replicates the functionality and requirements of the classic GIPHY search, but returns animated stickers rather than GIFs.
|
571
|
+
|
572
|
+
### Example
|
573
|
+
```ruby
|
574
|
+
# load the gem
|
575
|
+
require 'GiphyClient'
|
576
|
+
|
577
|
+
api_instance = GiphyClient::DefaultApi.new
|
578
|
+
|
579
|
+
api_key = "dc6zaTOxFJmzC" # String | Giphy API Key.
|
580
|
+
|
581
|
+
q = "cheeseburgers" # String | Search query term or prhase.
|
582
|
+
|
583
|
+
opts = {
|
584
|
+
limit: 25, # Integer | The maximum number of records to return.
|
585
|
+
offset: 0, # Integer | An optional results offset. Defaults to 0.
|
586
|
+
rating: "g", # String | Filters results by specified rating.
|
587
|
+
lang: "en", # String | Specify default country for regional content; use a 2-letter ISO 639-1 country code. See list of supported languages <a href = \"../language-support\">here</a>.
|
588
|
+
fmt: "json" # String | Used to indicate the expected response format. Default is Json.
|
589
|
+
}
|
590
|
+
|
591
|
+
begin
|
592
|
+
#Sticker Search Endpoint
|
593
|
+
result = api_instance.stickers_search_get(api_keyq, opts)
|
594
|
+
p result
|
595
|
+
rescue GiphyClient::ApiError => e
|
596
|
+
puts "Exception when calling DefaultApi->stickers_search_get: #{e}"
|
597
|
+
end
|
598
|
+
```
|
599
|
+
|
600
|
+
### Parameters
|
601
|
+
|
602
|
+
Name | Type | Description | Notes
|
603
|
+
------------- | ------------- | ------------- | -------------
|
604
|
+
**api_key** | **String**| Giphy API Key. |
|
605
|
+
**q** | **String**| Search query term or prhase. |
|
606
|
+
**limit** | **Integer**| The maximum number of records to return. | [optional] [default to 25]
|
607
|
+
**offset** | **Integer**| An optional results offset. Defaults to 0. | [optional] [default to 0]
|
608
|
+
**rating** | **String**| Filters results by specified rating. | [optional]
|
609
|
+
**lang** | **String**| Specify default country for regional content; use a 2-letter ISO 639-1 country code. See list of supported languages <a href = \"../language-support\">here</a>. | [optional]
|
610
|
+
**fmt** | **String**| Used to indicate the expected response format. Default is Json. | [optional] [default to json]
|
611
|
+
|
612
|
+
### Return type
|
613
|
+
|
614
|
+
[**InlineResponse200**](InlineResponse200.md)
|
615
|
+
|
616
|
+
### Authorization
|
617
|
+
|
618
|
+
No authorization required
|
619
|
+
|
620
|
+
### HTTP request headers
|
621
|
+
|
622
|
+
- **Content-Type**: application/json
|
623
|
+
- **Accept**: application/json
|
624
|
+
|
625
|
+
|
626
|
+
|
627
|
+
# **stickers_translate_get**
|
628
|
+
> InlineResponse2001 stickers_translate_get(api_keys)
|
629
|
+
|
630
|
+
Sticker Translate Endpoint
|
631
|
+
|
632
|
+
The translate API draws on search, but uses the Giphy `special sauce` to handle translating from one vocabulary to another. In this case, words and phrases to GIFs.
|
633
|
+
|
634
|
+
### Example
|
635
|
+
```ruby
|
636
|
+
# load the gem
|
637
|
+
require 'GiphyClient'
|
638
|
+
|
639
|
+
api_instance = GiphyClient::DefaultApi.new
|
640
|
+
|
641
|
+
api_key = "dc6zaTOxFJmzC" # String | Giphy API Key.
|
642
|
+
|
643
|
+
s = "ryan gosling" # String | Search term.
|
644
|
+
|
645
|
+
|
646
|
+
begin
|
647
|
+
#Sticker Translate Endpoint
|
648
|
+
result = api_instance.stickers_translate_get(api_keys)
|
649
|
+
p result
|
650
|
+
rescue GiphyClient::ApiError => e
|
651
|
+
puts "Exception when calling DefaultApi->stickers_translate_get: #{e}"
|
652
|
+
end
|
653
|
+
```
|
654
|
+
|
655
|
+
### Parameters
|
656
|
+
|
657
|
+
Name | Type | Description | Notes
|
658
|
+
------------- | ------------- | ------------- | -------------
|
659
|
+
**api_key** | **String**| Giphy API Key. |
|
660
|
+
**s** | **String**| Search term. |
|
661
|
+
|
662
|
+
### Return type
|
663
|
+
|
664
|
+
[**InlineResponse2001**](InlineResponse2001.md)
|
665
|
+
|
666
|
+
### Authorization
|
667
|
+
|
668
|
+
No authorization required
|
669
|
+
|
670
|
+
### HTTP request headers
|
671
|
+
|
672
|
+
- **Content-Type**: application/json
|
673
|
+
- **Accept**: application/json
|
674
|
+
|
675
|
+
|
676
|
+
|
677
|
+
# **stickers_trending_get**
|
678
|
+
> InlineResponse200 stickers_trending_get(api_key, opts)
|
679
|
+
|
680
|
+
Trending Stickers Endpoint
|
681
|
+
|
682
|
+
Fetch GIFs currently trending online. Hand curated by the GIPHY editorial team. The data returned mirrors the GIFs showcased on the <a href = \"http://www.giphy.com\">GIPHY homepage</a>. Returns 25 results by default.
|
683
|
+
|
684
|
+
### Example
|
685
|
+
```ruby
|
686
|
+
# load the gem
|
687
|
+
require 'GiphyClient'
|
688
|
+
|
689
|
+
api_instance = GiphyClient::DefaultApi.new
|
690
|
+
|
691
|
+
api_key = "dc6zaTOxFJmzC" # String | Giphy API Key.
|
692
|
+
|
693
|
+
opts = {
|
694
|
+
limit: 25, # Integer | The maximum number of records to return.
|
695
|
+
rating: "g", # String | Filters results by specified rating.
|
696
|
+
fmt: "json" # String | Used to indicate the expected response format. Default is Json.
|
697
|
+
}
|
698
|
+
|
699
|
+
begin
|
700
|
+
#Trending Stickers Endpoint
|
701
|
+
result = api_instance.stickers_trending_get(api_key, opts)
|
702
|
+
p result
|
703
|
+
rescue GiphyClient::ApiError => e
|
704
|
+
puts "Exception when calling DefaultApi->stickers_trending_get: #{e}"
|
705
|
+
end
|
706
|
+
```
|
707
|
+
|
708
|
+
### Parameters
|
709
|
+
|
710
|
+
Name | Type | Description | Notes
|
711
|
+
------------- | ------------- | ------------- | -------------
|
712
|
+
**api_key** | **String**| Giphy API Key. |
|
713
|
+
**limit** | **Integer**| The maximum number of records to return. | [optional] [default to 25]
|
714
|
+
**rating** | **String**| Filters results by specified rating. | [optional]
|
715
|
+
**fmt** | **String**| Used to indicate the expected response format. Default is Json. | [optional] [default to json]
|
716
|
+
|
717
|
+
### Return type
|
718
|
+
|
719
|
+
[**InlineResponse200**](InlineResponse200.md)
|
720
|
+
|
721
|
+
### Authorization
|
722
|
+
|
723
|
+
No authorization required
|
724
|
+
|
725
|
+
### HTTP request headers
|
726
|
+
|
727
|
+
- **Content-Type**: application/json
|
728
|
+
- **Accept**: application/json
|
729
|
+
|
730
|
+
|
731
|
+
|