late-sdk 0.0.1347 → 0.0.1348
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/docs/ConnectApi.md +2 -2
- data/lib/zernio-sdk/api/connect_api.rb +2 -2
- data/lib/zernio-sdk/version.rb +1 -1
- data/openapi.yaml +1 -1
- data/spec/api/connect_api_spec.rb +1 -1
- data/zernio-sdk-0.0.1348.gem +0 -0
- metadata +2 -2
- data/zernio-sdk-0.0.1347.gem +0 -0
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 022a1fda5cea463b4e23fe20b18ca8277042eef71628d01e83e988badec36e79
|
|
4
|
+
data.tar.gz: 922132b315521f81045ca4110bec6ef0508074292a46ba7344974c1c9942e885
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 407ca88f0a3756d2b4821fad87ab78a43fcd1d48e1ff3b1bbdbf68195336d00237e226070087d437fd29c255023d3a69d468f8be4eef44a0070a17400a670d65
|
|
7
|
+
data.tar.gz: 9460df55b57bc54627a247972c266d0d5f86f86f290e5f1918a70b8794c4eebeacc766d430343564f5a0016fc3f892b7d8887d94d9e36f722cd99890b40179de
|
data/docs/ConnectApi.md
CHANGED
|
@@ -441,7 +441,7 @@ opts = {
|
|
|
441
441
|
login_mode: 'classic', # String | Meta ads authorization mode. Business login is opt-in for Facebook and Instagram; classic preserves the posting-account flow.
|
|
442
442
|
permission_level: 'full', # String | Business login only. Ad-account permission the connection's system user will hold. `full` asks the owner for Full control (MANAGE; required to create pixels and other account-level assets through Zernio). `advertise` asks for Manage campaigns (ADVERTISE), enough for campaigns, ad sets, creatives, ads, media and reporting, for owners who will not grant billing-level control to an integration. Either way Meta only lets a business admin complete the grant. 503 if the advertise configuration is not set up.
|
|
443
443
|
page_id: '811889972008357', # String | Business login only. Facebook Page ID to select from the token grants for ad creatives and lead forms.
|
|
444
|
-
account_id: 'account_id_example', # String | Existing SocialAccount ID. Required for `twitter` (X Ads). Optional for `tiktok`: omit to enter ads-only mode (no TikTok posting account linked; ad creation uses a Brand Identity instead of a TT_USER). For same-token platforms (`facebook`, `instagram`, `linkedin`, `pinterest`) it picks which posting account the ads connection uses when the profile holds several of that platform; with one it can be omitted, and an id that names no active account of the platform on the profile is ignored. Ignored for standalone platforms (`googleads`).
|
|
444
|
+
account_id: 'account_id_example', # String | Existing SocialAccount ID. Required for `twitter` (X Ads). Optional for `tiktok`: omit to enter ads-only mode (no TikTok posting account linked; ad creation uses a Brand Identity instead of a TT_USER). For same-token platforms (`facebook`, `instagram`, `linkedin`, `pinterest`) it picks which posting account the ads connection uses when the profile holds several of that platform; with one it can be omitted, and an id that names no active account of the platform on the profile is ignored, except with `force=true` when it names the posting account the profile's ads connection hangs off: that account is no longer connected, so the call returns 409 `reconnect_required` instead of reconnecting another account. Reconnect it via GET /v1/connect/{platform} first. Ignored for standalone platforms (`googleads`).
|
|
445
445
|
redirect_url: 'redirect_url_example', # String | Custom URL the browser is sent to once the OAuth flow finishes. Honored on every ads platform, including the separate-token (`tiktok`, `twitter`) and standalone (`googleads`) flows. MUST be an absolute http(s) URL or a custom app scheme for mobile deeplinks (e.g. myapp://callback); a relative path is rejected with 400 INVALID_REDIRECT_URL. On success `tiktok`, `twitter` and `googleads` land on the URL unchanged, while the same-token platforms (`facebook`, `instagram`, `linkedin`, `pinterest`) append `connected`, `profileId`, `accountId`, `username` and, on API-key calls, `connect_token`. On failure the same error contract applies as on GET /v1/connect/{platform}: `error` and `platform` are always appended, other params are optional, and the value list there is not exhaustive. On the tiktok, twitter and googleads flows `platform` carries the ads platform id (`tiktokads`, `xads`, `googleads`), not the value used in the request path. When omitted, the browser lands on the Zernio dashboard.
|
|
446
446
|
headless: true, # Boolean | Enable headless mode (same-token platforms only)
|
|
447
447
|
force: true, # Boolean | Force a fresh OAuth even when an account already exists. Normally the endpoint returns `alreadyConnected: true` whenever a connected account is found, keying off its active state rather than token liveness. Set `force=true` to bypass that and always receivean `authUrl`. Completing the returned OAuth refreshes the stored token on the existing posting and ads accounts in place. An `alreadyConnected` response re-runs ad discovery and webhook subscriptions in the background at most once every 15 minutes per ads account (always when the call changes the ad-account scope), so it is not a sync trigger. To check the connection's health, read GET /v1/ads/accounts?accountId=<ads account ID>.
|
|
@@ -485,7 +485,7 @@ end
|
|
|
485
485
|
| **login_mode** | **String** | Meta ads authorization mode. Business login is opt-in for Facebook and Instagram; classic preserves the posting-account flow. | [optional][default to 'classic'] |
|
|
486
486
|
| **permission_level** | **String** | Business login only. Ad-account permission the connection's system user will hold. `full` asks the owner for Full control (MANAGE; required to create pixels and other account-level assets through Zernio). `advertise` asks for Manage campaigns (ADVERTISE), enough for campaigns, ad sets, creatives, ads, media and reporting, for owners who will not grant billing-level control to an integration. Either way Meta only lets a business admin complete the grant. 503 if the advertise configuration is not set up. | [optional][default to 'full'] |
|
|
487
487
|
| **page_id** | **String** | Business login only. Facebook Page ID to select from the token grants for ad creatives and lead forms. | [optional] |
|
|
488
|
-
| **account_id** | **String** | Existing SocialAccount ID. Required for `twitter` (X Ads). Optional for `tiktok`: omit to enter ads-only mode (no TikTok posting account linked; ad creation uses a Brand Identity instead of a TT_USER). For same-token platforms (`facebook`, `instagram`, `linkedin`, `pinterest`) it picks which posting account the ads connection uses when the profile holds several of that platform; with one it can be omitted, and an id that names no active account of the platform on the profile is ignored. Ignored for standalone platforms (`googleads`). | [optional] |
|
|
488
|
+
| **account_id** | **String** | Existing SocialAccount ID. Required for `twitter` (X Ads). Optional for `tiktok`: omit to enter ads-only mode (no TikTok posting account linked; ad creation uses a Brand Identity instead of a TT_USER). For same-token platforms (`facebook`, `instagram`, `linkedin`, `pinterest`) it picks which posting account the ads connection uses when the profile holds several of that platform; with one it can be omitted, and an id that names no active account of the platform on the profile is ignored, except with `force=true` when it names the posting account the profile's ads connection hangs off: that account is no longer connected, so the call returns 409 `reconnect_required` instead of reconnecting another account. Reconnect it via GET /v1/connect/{platform} first. Ignored for standalone platforms (`googleads`). | [optional] |
|
|
489
489
|
| **redirect_url** | **String** | Custom URL the browser is sent to once the OAuth flow finishes. Honored on every ads platform, including the separate-token (`tiktok`, `twitter`) and standalone (`googleads`) flows. MUST be an absolute http(s) URL or a custom app scheme for mobile deeplinks (e.g. myapp://callback); a relative path is rejected with 400 INVALID_REDIRECT_URL. On success `tiktok`, `twitter` and `googleads` land on the URL unchanged, while the same-token platforms (`facebook`, `instagram`, `linkedin`, `pinterest`) append `connected`, `profileId`, `accountId`, `username` and, on API-key calls, `connect_token`. On failure the same error contract applies as on GET /v1/connect/{platform}: `error` and `platform` are always appended, other params are optional, and the value list there is not exhaustive. On the tiktok, twitter and googleads flows `platform` carries the ads platform id (`tiktokads`, `xads`, `googleads`), not the value used in the request path. When omitted, the browser lands on the Zernio dashboard. | [optional] |
|
|
490
490
|
| **headless** | **Boolean** | Enable headless mode (same-token platforms only) | [optional][default to false] |
|
|
491
491
|
| **force** | **Boolean** | Force a fresh OAuth even when an account already exists. Normally the endpoint returns `alreadyConnected: true` whenever a connected account is found, keying off its active state rather than token liveness. Set `force=true` to bypass that and always receivean `authUrl`. Completing the returned OAuth refreshes the stored token on the existing posting and ads accounts in place. An `alreadyConnected` response re-runs ad discovery and webhook subscriptions in the background at most once every 15 minutes per ads account (always when the call changes the ad-account scope), so it is not a sync trigger. To check the connection's health, read GET /v1/ads/accounts?accountId=<ads account ID>. | [optional][default to false] |
|
|
@@ -374,7 +374,7 @@ module Zernio
|
|
|
374
374
|
# @option opts [String] :login_mode Meta ads authorization mode. Business login is opt-in for Facebook and Instagram; classic preserves the posting-account flow. (default to 'classic')
|
|
375
375
|
# @option opts [String] :permission_level Business login only. Ad-account permission the connection's system user will hold. `full` asks the owner for Full control (MANAGE; required to create pixels and other account-level assets through Zernio). `advertise` asks for Manage campaigns (ADVERTISE), enough for campaigns, ad sets, creatives, ads, media and reporting, for owners who will not grant billing-level control to an integration. Either way Meta only lets a business admin complete the grant. 503 if the advertise configuration is not set up. (default to 'full')
|
|
376
376
|
# @option opts [String] :page_id Business login only. Facebook Page ID to select from the token grants for ad creatives and lead forms.
|
|
377
|
-
# @option opts [String] :account_id Existing SocialAccount ID. Required for `twitter` (X Ads). Optional for `tiktok`: omit to enter ads-only mode (no TikTok posting account linked; ad creation uses a Brand Identity instead of a TT_USER). For same-token platforms (`facebook`, `instagram`, `linkedin`, `pinterest`) it picks which posting account the ads connection uses when the profile holds several of that platform; with one it can be omitted, and an id that names no active account of the platform on the profile is ignored. Ignored for standalone platforms (`googleads`).
|
|
377
|
+
# @option opts [String] :account_id Existing SocialAccount ID. Required for `twitter` (X Ads). Optional for `tiktok`: omit to enter ads-only mode (no TikTok posting account linked; ad creation uses a Brand Identity instead of a TT_USER). For same-token platforms (`facebook`, `instagram`, `linkedin`, `pinterest`) it picks which posting account the ads connection uses when the profile holds several of that platform; with one it can be omitted, and an id that names no active account of the platform on the profile is ignored, except with `force=true` when it names the posting account the profile's ads connection hangs off: that account is no longer connected, so the call returns 409 `reconnect_required` instead of reconnecting another account. Reconnect it via GET /v1/connect/{platform} first. Ignored for standalone platforms (`googleads`).
|
|
378
378
|
# @option opts [String] :redirect_url Custom URL the browser is sent to once the OAuth flow finishes. Honored on every ads platform, including the separate-token (`tiktok`, `twitter`) and standalone (`googleads`) flows. MUST be an absolute http(s) URL or a custom app scheme for mobile deeplinks (e.g. myapp://callback); a relative path is rejected with 400 INVALID_REDIRECT_URL. On success `tiktok`, `twitter` and `googleads` land on the URL unchanged, while the same-token platforms (`facebook`, `instagram`, `linkedin`, `pinterest`) append `connected`, `profileId`, `accountId`, `username` and, on API-key calls, `connect_token`. On failure the same error contract applies as on GET /v1/connect/{platform}: `error` and `platform` are always appended, other params are optional, and the value list there is not exhaustive. On the tiktok, twitter and googleads flows `platform` carries the ads platform id (`tiktokads`, `xads`, `googleads`), not the value used in the request path. When omitted, the browser lands on the Zernio dashboard.
|
|
379
379
|
# @option opts [Boolean] :headless Enable headless mode (same-token platforms only) (default to false)
|
|
380
380
|
# @option opts [Boolean] :force Force a fresh OAuth even when an account already exists. Normally the endpoint returns `alreadyConnected: true` whenever a connected account is found, keying off its active state rather than token liveness. Set `force=true` to bypass that and always receivean `authUrl`. Completing the returned OAuth refreshes the stored token on the existing posting and ads accounts in place. An `alreadyConnected` response re-runs ad discovery and webhook subscriptions in the background at most once every 15 minutes per ads account (always when the call changes the ad-account scope), so it is not a sync trigger. To check the connection's health, read GET /v1/ads/accounts?accountId=<ads account ID>. (default to false)
|
|
@@ -394,7 +394,7 @@ module Zernio
|
|
|
394
394
|
# @option opts [String] :login_mode Meta ads authorization mode. Business login is opt-in for Facebook and Instagram; classic preserves the posting-account flow. (default to 'classic')
|
|
395
395
|
# @option opts [String] :permission_level Business login only. Ad-account permission the connection's system user will hold. `full` asks the owner for Full control (MANAGE; required to create pixels and other account-level assets through Zernio). `advertise` asks for Manage campaigns (ADVERTISE), enough for campaigns, ad sets, creatives, ads, media and reporting, for owners who will not grant billing-level control to an integration. Either way Meta only lets a business admin complete the grant. 503 if the advertise configuration is not set up. (default to 'full')
|
|
396
396
|
# @option opts [String] :page_id Business login only. Facebook Page ID to select from the token grants for ad creatives and lead forms.
|
|
397
|
-
# @option opts [String] :account_id Existing SocialAccount ID. Required for `twitter` (X Ads). Optional for `tiktok`: omit to enter ads-only mode (no TikTok posting account linked; ad creation uses a Brand Identity instead of a TT_USER). For same-token platforms (`facebook`, `instagram`, `linkedin`, `pinterest`) it picks which posting account the ads connection uses when the profile holds several of that platform; with one it can be omitted, and an id that names no active account of the platform on the profile is ignored. Ignored for standalone platforms (`googleads`).
|
|
397
|
+
# @option opts [String] :account_id Existing SocialAccount ID. Required for `twitter` (X Ads). Optional for `tiktok`: omit to enter ads-only mode (no TikTok posting account linked; ad creation uses a Brand Identity instead of a TT_USER). For same-token platforms (`facebook`, `instagram`, `linkedin`, `pinterest`) it picks which posting account the ads connection uses when the profile holds several of that platform; with one it can be omitted, and an id that names no active account of the platform on the profile is ignored, except with `force=true` when it names the posting account the profile's ads connection hangs off: that account is no longer connected, so the call returns 409 `reconnect_required` instead of reconnecting another account. Reconnect it via GET /v1/connect/{platform} first. Ignored for standalone platforms (`googleads`).
|
|
398
398
|
# @option opts [String] :redirect_url Custom URL the browser is sent to once the OAuth flow finishes. Honored on every ads platform, including the separate-token (`tiktok`, `twitter`) and standalone (`googleads`) flows. MUST be an absolute http(s) URL or a custom app scheme for mobile deeplinks (e.g. myapp://callback); a relative path is rejected with 400 INVALID_REDIRECT_URL. On success `tiktok`, `twitter` and `googleads` land on the URL unchanged, while the same-token platforms (`facebook`, `instagram`, `linkedin`, `pinterest`) append `connected`, `profileId`, `accountId`, `username` and, on API-key calls, `connect_token`. On failure the same error contract applies as on GET /v1/connect/{platform}: `error` and `platform` are always appended, other params are optional, and the value list there is not exhaustive. On the tiktok, twitter and googleads flows `platform` carries the ads platform id (`tiktokads`, `xads`, `googleads`), not the value used in the request path. When omitted, the browser lands on the Zernio dashboard.
|
|
399
399
|
# @option opts [Boolean] :headless Enable headless mode (same-token platforms only) (default to false)
|
|
400
400
|
# @option opts [Boolean] :force Force a fresh OAuth even when an account already exists. Normally the endpoint returns `alreadyConnected: true` whenever a connected account is found, keying off its active state rather than token liveness. Set `force=true` to bypass that and always receivean `authUrl`. Completing the returned OAuth refreshes the stored token on the existing posting and ads accounts in place. An `alreadyConnected` response re-runs ad discovery and webhook subscriptions in the background at most once every 15 minutes per ads account (always when the call changes the ad-account scope), so it is not a sync trigger. To check the connection's health, read GET /v1/ads/accounts?accountId=<ads account ID>. (default to false)
|
data/lib/zernio-sdk/version.rb
CHANGED