pinterest_sdk 1.0.0

data/docs/MediaUploadAllOfUploadParameters.md

@@ -0,0 +1,32 @@
+# PinterestSdkClient::MediaUploadAllOfUploadParameters
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **x_amz_date** | **String** |  | [optional] |
+| **x_amz_signature** | **String** |  | [optional] |
+| **x_amz_security_token** | **String** |  | [optional] |
+| **x_amz_algorithm** | **String** |  | [optional] |
+| **key** | **String** |  | [optional] |
+| **policy** | **String** |  | [optional] |
+| **x_amz_credential** | **String** |  | [optional] |
+| **content_type** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::MediaUploadAllOfUploadParameters.new(
+  x_amz_date: null,
+  x_amz_signature: null,
+  x_amz_security_token: null,
+  x_amz_algorithm: null,
+  key: null,
+  policy: null,
+  x_amz_credential: null,
+  content_type: multipart/form-data
+)
+```
+

data/docs/MediaUploadDetails.md

@@ -0,0 +1,22 @@
+# PinterestSdkClient::MediaUploadDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **media_id** | **String** |  | [optional][readonly] |
+| **media_type** | [**MediaUploadType**](MediaUploadType.md) |  | [optional][readonly] |
+| **status** | [**MediaUploadStatus**](MediaUploadStatus.md) |  | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::MediaUploadDetails.new(
+  media_id: null,
+  media_type: null,
+  status: null
+)
+```
+

data/docs/MediaUploadRequest.md

@@ -0,0 +1,18 @@
+# PinterestSdkClient::MediaUploadRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **media_type** | [**MediaUploadType**](MediaUploadType.md) |  |  |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::MediaUploadRequest.new(
+  media_type: null
+)
+```
+

data/docs/MediaUploadStatus.md

@@ -0,0 +1,15 @@
+# PinterestSdkClient::MediaUploadStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::MediaUploadStatus.new()
+```
+

data/docs/MediaUploadType.md

@@ -0,0 +1,15 @@
+# PinterestSdkClient::MediaUploadType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::MediaUploadType.new()
+```
+

data/docs/MetricsReportingLevel.md

@@ -0,0 +1,15 @@
+# PinterestSdkClient::MetricsReportingLevel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::MetricsReportingLevel.new()
+```
+

data/docs/MinPriceFilter.md

@@ -0,0 +1,18 @@
+# PinterestSdkClient::MinPriceFilter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **min_price** | [**CatalogsProductGroupPricingCriteria**](.md) |  |  |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::MinPriceFilter.new(
+  min_price: null
+)
+```
+

data/docs/NonNullableCatalogsCurrency.md

@@ -0,0 +1,15 @@
+# PinterestSdkClient::NonNullableCatalogsCurrency
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::NonNullableCatalogsCurrency.new()
+```
+

data/docs/NullableCurrency.md

@@ -0,0 +1,15 @@
+# PinterestSdkClient::NullableCurrency
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::NullableCurrency.new()
+```
+

data/docs/OauthAccessTokenRequest.md

@@ -0,0 +1,18 @@
+# PinterestSdkClient::OauthAccessTokenRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **grant_type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::OauthAccessTokenRequest.new(
+  grant_type: null
+)
+```
+

data/docs/OauthAccessTokenRequestCode.md

@@ -0,0 +1,20 @@
+# PinterestSdkClient::OauthAccessTokenRequestCode
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  |  |
+| **redirect_uri** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::OauthAccessTokenRequestCode.new(
+  code: null,
+  redirect_uri: null
+)
+```
+

data/docs/OauthAccessTokenRequestCodeAllOf.md

@@ -0,0 +1,20 @@
+# PinterestSdkClient::OauthAccessTokenRequestCodeAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  |  |
+| **redirect_uri** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::OauthAccessTokenRequestCodeAllOf.new(
+  code: null,
+  redirect_uri: null
+)
+```
+

data/docs/OauthAccessTokenRequestRefresh.md

@@ -0,0 +1,20 @@
+# PinterestSdkClient::OauthAccessTokenRequestRefresh
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **refresh_token** | **String** |  |  |
+| **scope** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::OauthAccessTokenRequestRefresh.new(
+  refresh_token: null,
+  scope: null
+)
+```
+

data/docs/OauthAccessTokenRequestRefreshAllOf.md

@@ -0,0 +1,20 @@
+# PinterestSdkClient::OauthAccessTokenRequestRefreshAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **refresh_token** | **String** |  |  |
+| **scope** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::OauthAccessTokenRequestRefreshAllOf.new(
+  refresh_token: null,
+  scope: null
+)
+```
+

data/docs/OauthAccessTokenResponse.md

@@ -0,0 +1,26 @@
+# PinterestSdkClient::OauthAccessTokenResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **response_type** | **String** |  | [optional] |
+| **access_token** | **String** |  |  |
+| **token_type** | **String** |  | [default to 'bearer'] |
+| **expires_in** | **Integer** |  |  |
+| **scope** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::OauthAccessTokenResponse.new(
+  response_type: null,
+  access_token: null,
+  token_type: null,
+  expires_in: null,
+  scope: null
+)
+```
+

data/docs/OauthAccessTokenResponseCode.md

@@ -0,0 +1,20 @@
+# PinterestSdkClient::OauthAccessTokenResponseCode
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **refresh_token** | **String** |  |  |
+| **refresh_token_expires_in** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::OauthAccessTokenResponseCode.new(
+  refresh_token: null,
+  refresh_token_expires_in: null
+)
+```
+

data/docs/OauthAccessTokenResponseCodeAllOf.md

@@ -0,0 +1,20 @@
+# PinterestSdkClient::OauthAccessTokenResponseCodeAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **refresh_token** | **String** |  |  |
+| **refresh_token_expires_in** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::OauthAccessTokenResponseCodeAllOf.new(
+  refresh_token: null,
+  refresh_token_expires_in: null
+)
+```
+

data/docs/OauthAccessTokenResponseRefresh.md

@@ -0,0 +1,15 @@
+# PinterestSdkClient::OauthAccessTokenResponseRefresh
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::OauthAccessTokenResponseRefresh.new()
+```
+

data/docs/OauthApi.md

@@ -0,0 +1,72 @@
+# PinterestSdkClient::OauthApi
+
+All URIs are relative to *https://api.pinterest.com/v5*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**oauth_token**](OauthApi.md#oauth_token) | **POST** /oauth/token | Generate OAuth access token |
+
+
+## oauth_token
+
+> <OauthAccessTokenResponse> oauth_token(grant_type)
+
+Generate OAuth access token
+
+Generate an OAuth access token by using an authorization code or a refresh token.  See <a href='/docs/api/v5/#tag/Authentication'>Authentication</a> for more.
+
+### Examples
+
+```ruby
+require 'time'
+require 'pinterest_sdk'
+
+api_instance = PinterestSdkClient::OauthApi.new
+grant_type = 'authorization_code' # String | 
+
+begin
+  # Generate OAuth access token
+  result = api_instance.oauth_token(grant_type)
+  p result
+rescue PinterestSdkClient::ApiError => e
+  puts "Error when calling OauthApi->oauth_token: #{e}"
+end
+```
+
+#### Using the oauth_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OauthAccessTokenResponse>, Integer, Hash)> oauth_token_with_http_info(grant_type)
+
+```ruby
+begin
+  # Generate OAuth access token
+  data, status_code, headers = api_instance.oauth_token_with_http_info(grant_type)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OauthAccessTokenResponse>
+rescue PinterestSdkClient::ApiError => e
+  puts "Error when calling OauthApi->oauth_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **grant_type** | **String** |  |  |
+
+### Return type
+
+[**OauthAccessTokenResponse**](OauthAccessTokenResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+

data/docs/ObjectiveType.md

@@ -0,0 +1,15 @@
+# PinterestSdkClient::ObjectiveType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::ObjectiveType.new()
+```
+

data/docs/PacingDeliveryType.md

@@ -0,0 +1,15 @@
+# PinterestSdkClient::PacingDeliveryType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::PacingDeliveryType.new()
+```
+

data/docs/Paginated.md

@@ -0,0 +1,20 @@
+# PinterestSdkClient::Paginated
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | **Array<Object>** |  |  |
+| **bookmark** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::Paginated.new(
+  items: null,
+  bookmark: null
+)
+```
+

data/docs/Pin.md

@@ -0,0 +1,38 @@
+# PinterestSdkClient::Pin
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional][readonly] |
+| **created_at** | **Time** |  | [optional][readonly] |
+| **link** | **String** |  | [optional] |
+| **title** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **alt_text** | **String** |  | [optional] |
+| **board_id** | **String** | The board to which this Pin belongs. | [optional] |
+| **board_section_id** | **String** | The board section to which this Pin belongs. | [optional] |
+| **board_owner** | [**BoardOwner**](BoardOwner.md) |  | [optional][readonly] |
+| **media** | [**PinMedia**](PinMedia.md) |  | [optional][readonly] |
+| **media_source** | [**PinMediaSource**](PinMediaSource.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::Pin.new(
+  id: 813744226420795884,
+  created_at: 2020-01-01T20:10:40Z,
+  link: https://www.pinterest.com/,
+  title: null,
+  description: null,
+  alt_text: null,
+  board_id: null,
+  board_section_id: null,
+  board_owner: null,
+  media: null,
+  media_source: null
+)
+```
+

data/docs/PinMedia.md

@@ -0,0 +1,18 @@
+# PinterestSdkClient::PinMedia
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **media_type** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::PinMedia.new(
+  media_type: null
+)
+```
+

data/docs/PinMediaSource.md

@@ -0,0 +1,81 @@
+# PinterestSdkClient::PinMediaSource
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'pinterest_sdk'
+
+PinterestSdkClient::PinMediaSource.openapi_one_of
+# =>
+# [
+#   :'PinMediaSourceImageBase64',
+#   :'PinMediaSourceImageURL',
+#   :'PinMediaSourceVideoID'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'pinterest_sdk'
+
+PinterestSdkClient::PinMediaSource.openapi_discriminator_name
+# => :'source_type'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'pinterest_sdk'
+
+PinterestSdkClient::PinMediaSource.openapi_discriminator_mapping
+# =>
+# {
+#   :'image_base64' => :'PinMediaSourceImageBase64',
+#   :'image_url' => :'PinMediaSourceImageURL',
+#   :'video_id' => :'PinMediaSourceVideoID'
+# }
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'pinterest_sdk'
+
+PinterestSdkClient::PinMediaSource.build(data)
+# => #<PinMediaSourceImageBase64:0x00007fdd4aab02a0>
+
+PinterestSdkClient::PinMediaSource.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `PinMediaSourceImageBase64`
+- `PinMediaSourceImageURL`
+- `PinMediaSourceVideoID`
+- `nil` (if no type matches)
+

data/docs/PinMediaSourceImageBase64.md

@@ -0,0 +1,22 @@
+# PinterestSdkClient::PinMediaSourceImageBase64
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **source_type** | **String** |  |  |
+| **content_type** | **String** |  |  |
+| **data** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::PinMediaSourceImageBase64.new(
+  source_type: null,
+  content_type: null,
+  data: null
+)
+```
+

data/docs/PinMediaSourceImageURL.md

@@ -0,0 +1,20 @@
+# PinterestSdkClient::PinMediaSourceImageURL
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **source_type** | **String** |  |  |
+| **url** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'pinterest_sdk'
+
+instance = PinterestSdkClient::PinMediaSourceImageURL.new(
+  source_type: null,
+  url: null
+)
+```
+