zernio-sdk 0.0.830 → 0.0.831

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: c7fd0b371a0accafb9fdeea270ee98d73329d3351a4ebbd84bb4a948889b414f
4
- data.tar.gz: aac25418ea74a172b42d62d6ec291e8d784dcbded3a90d055d17f812eff35d7d
3
+ metadata.gz: 1566f198f77264c080c32c6f6d2b8a147e61a1a4c280d2d1400104fbcb045cd2
4
+ data.tar.gz: 026223a99d111867cd93fd8c84b9b45b79ec602873531b862ead083eb22fea2c
5
5
  SHA512:
6
- metadata.gz: 58b7fc738fd83a161b2993a7159d170b67ad4ccdeacfafc68880ab009f6f6961f63b44cfe42790cd8359584c080d5ed73327b48d983a4c41da083e6a9152364d
7
- data.tar.gz: e3385b8b195c68a653729ef0de1bbcea618910a55e0f630263760ded658dbfb2e699861da6924d26c166db099bf0df409e0d0910434b4c99a9b46e12aaaee6ef
6
+ metadata.gz: 0b0de919da3bd72263676fd2c05882cab0a967cc50c30779caed0fa9fc59481eb1ca9976e2512d414da966ea0479149b59f16083bdcfaf5ecafa39b61105dd01
7
+ data.tar.gz: 9b498c98ba0f0ed0afec793c1f36edf26f01e8eb0ddba7d988b2df312aa6d681ad34eace60254f3fddf0c9d6f8039b5c14b92af15f64a42ea7f4974ad6fa5f4b
data/docs/MessagesApi.md CHANGED
@@ -329,7 +329,7 @@ Zernio.configure do |config|
329
329
  end
330
330
 
331
331
  api_instance = Zernio::MessagesApi.new
332
- conversation_id = 'conversation_id_example' # String | The conversation ID (id field from list conversations endpoint). This is the platform-specific conversation identifier, not an internal database ID.
332
+ conversation_id = 'conversation_id_example' # String | Opaque conversation identifier, accepted verbatim from the list endpoint or from the conversationId on inbox webhooks. Format not to be assumed.
333
333
  account_id = 'account_id_example' # String | The social account ID
334
334
 
335
335
  begin
@@ -363,7 +363,7 @@ end
363
363
 
364
364
  | Name | Type | Description | Notes |
365
365
  | ---- | ---- | ----------- | ----- |
366
- | **conversation_id** | **String** | The conversation ID (id field from list conversations endpoint). This is the platform-specific conversation identifier, not an internal database ID. | |
366
+ | **conversation_id** | **String** | Opaque conversation identifier, accepted verbatim from the list endpoint or from the conversationId on inbox webhooks. Format not to be assumed. | |
367
367
  | **account_id** | **String** | The social account ID | |
368
368
 
369
369
  ### Return type
@@ -400,7 +400,7 @@ Zernio.configure do |config|
400
400
  end
401
401
 
402
402
  api_instance = Zernio::MessagesApi.new
403
- conversation_id = 'conversation_id_example' # String | The conversation ID (id field from list conversations endpoint). This is the platform-specific conversation identifier, not an internal database ID.
403
+ conversation_id = 'conversation_id_example' # String | Opaque conversation identifier, accepted verbatim from the list endpoint or from the conversationId on inbox webhooks. Format not to be assumed.
404
404
  account_id = 'account_id_example' # String | Social account ID
405
405
  opts = {
406
406
  limit: 56, # Integer | Number of messages to return per page. Default 100, max 100.
@@ -439,7 +439,7 @@ end
439
439
 
440
440
  | Name | Type | Description | Notes |
441
441
  | ---- | ---- | ----------- | ----- |
442
- | **conversation_id** | **String** | The conversation ID (id field from list conversations endpoint). This is the platform-specific conversation identifier, not an internal database ID. | |
442
+ | **conversation_id** | **String** | Opaque conversation identifier, accepted verbatim from the list endpoint or from the conversationId on inbox webhooks. Format not to be assumed. | |
443
443
  | **account_id** | **String** | Social account ID | |
444
444
  | **limit** | **Integer** | Number of messages to return per page. Default 100, max 100. | [optional][default to 100] |
445
445
  | **cursor** | **String** | Opaque pagination cursor. Pass `pagination.nextCursor` from a prior response verbatim: a cursor we cannot parse returns 400 rather than silently restarting from the first page. | [optional] |
@@ -1014,7 +1014,7 @@ Zernio.configure do |config|
1014
1014
  end
1015
1015
 
1016
1016
  api_instance = Zernio::MessagesApi.new
1017
- conversation_id = 'conversation_id_example' # String | The conversation ID (id field from list conversations endpoint). This is the platform-specific conversation identifier, not an internal database ID.
1017
+ conversation_id = 'conversation_id_example' # String | Opaque conversation identifier, accepted verbatim from the list endpoint or from the conversationId on inbox webhooks. Format not to be assumed.
1018
1018
  update_inbox_conversation_request = Zernio::UpdateInboxConversationRequest.new({account_id: 'account_id_example', status: 'active'}) # UpdateInboxConversationRequest |
1019
1019
 
1020
1020
  begin
@@ -1048,7 +1048,7 @@ end
1048
1048
 
1049
1049
  | Name | Type | Description | Notes |
1050
1050
  | ---- | ---- | ----------- | ----- |
1051
- | **conversation_id** | **String** | The conversation ID (id field from list conversations endpoint). This is the platform-specific conversation identifier, not an internal database ID. | |
1051
+ | **conversation_id** | **String** | Opaque conversation identifier, accepted verbatim from the list endpoint or from the conversationId on inbox webhooks. Format not to be assumed. | |
1052
1052
  | **update_inbox_conversation_request** | [**UpdateInboxConversationRequest**](UpdateInboxConversationRequest.md) | | |
1053
1053
 
1054
1054
  ### Return type
@@ -325,7 +325,7 @@ module Zernio
325
325
 
326
326
  # Get conversation
327
327
  # Retrieve details and metadata for a specific conversation. Requires accountId query parameter.
328
- # @param conversation_id [String] The conversation ID (id field from list conversations endpoint). This is the platform-specific conversation identifier, not an internal database ID.
328
+ # @param conversation_id [String] Opaque conversation identifier, accepted verbatim from the list endpoint or from the conversationId on inbox webhooks. Format not to be assumed.
329
329
  # @param account_id [String] The social account ID
330
330
  # @param [Hash] opts the optional parameters
331
331
  # @return [GetInboxConversation200Response]
@@ -336,7 +336,7 @@ module Zernio
336
336
 
337
337
  # Get conversation
338
338
  # Retrieve details and metadata for a specific conversation. Requires accountId query parameter.
339
- # @param conversation_id [String] The conversation ID (id field from list conversations endpoint). This is the platform-specific conversation identifier, not an internal database ID.
339
+ # @param conversation_id [String] Opaque conversation identifier, accepted verbatim from the list endpoint or from the conversationId on inbox webhooks. Format not to be assumed.
340
340
  # @param account_id [String] The social account ID
341
341
  # @param [Hash] opts the optional parameters
342
342
  # @return [Array<(GetInboxConversation200Response, Integer, Hash)>] GetInboxConversation200Response data, response status code and response headers
@@ -395,7 +395,7 @@ module Zernio
395
395
 
396
396
  # List messages
397
397
  # Fetch messages for a specific conversation, with cursor-based pagination and ordering control. Pagination: pass `pagination.nextCursor` from a prior response back as the `cursor` query param to fetch the next page. The cursor is opaque; do not parse or construct it client-side. Sort order: defaults to `asc` (oldest first, chat style). For the \"show me the latest messages\" pattern, pass `?sortOrder=desc&limit=N`. Twitter, Instagram, Telegram, WhatsApp and Reddit honor the requested order from the local message store. For Facebook and Bluesky, the upstream APIs only return newest-first and have no order parameter — sort order is best-effort and only reverses items within a single page (pages still walk newest→oldest). The response field `sortOrderApplied` tells you what was actually applied. Reddit threads are paginated client-side because Reddit's API has no per-thread cursor. Very long threads may be upstream-truncated by Reddit's inbox/sent windows (~100 most-recent items each); this is a Reddit platform limitation. Instagram and Facebook conversations include history from before the account was connected, replayed from Meta. That replay covers the 500 most recent messages per conversation: a longer thread keeps its newest 500 and older messages are not retrievable. Messages that arrived after the account was connected are unaffected. Replayed messages are stored as already read and emit no webhooks. Twitter/X limitation: X's encrypted \"X Chat\" messages are not accessible via the API. Conversations where the other participant uses encrypted X Chat may only show your outgoing messages. See the list conversations endpoint for more details. This endpoint is read-only and does NOT mark messages as read or send read receipts. To mark a conversation read (and send WhatsApp blue ticks on eligible accounts), call `POST /v1/inbox/conversations/{conversationId}/read`.
398
- # @param conversation_id [String] The conversation ID (id field from list conversations endpoint). This is the platform-specific conversation identifier, not an internal database ID.
398
+ # @param conversation_id [String] Opaque conversation identifier, accepted verbatim from the list endpoint or from the conversationId on inbox webhooks. Format not to be assumed.
399
399
  # @param account_id [String] Social account ID
400
400
  # @param [Hash] opts the optional parameters
401
401
  # @option opts [Integer] :limit Number of messages to return per page. Default 100, max 100. (default to 100)
@@ -409,7 +409,7 @@ module Zernio
409
409
 
410
410
  # List messages
411
411
  # Fetch messages for a specific conversation, with cursor-based pagination and ordering control. Pagination: pass &#x60;pagination.nextCursor&#x60; from a prior response back as the &#x60;cursor&#x60; query param to fetch the next page. The cursor is opaque; do not parse or construct it client-side. Sort order: defaults to &#x60;asc&#x60; (oldest first, chat style). For the \&quot;show me the latest messages\&quot; pattern, pass &#x60;?sortOrder&#x3D;desc&amp;limit&#x3D;N&#x60;. Twitter, Instagram, Telegram, WhatsApp and Reddit honor the requested order from the local message store. For Facebook and Bluesky, the upstream APIs only return newest-first and have no order parameter — sort order is best-effort and only reverses items within a single page (pages still walk newest→oldest). The response field &#x60;sortOrderApplied&#x60; tells you what was actually applied. Reddit threads are paginated client-side because Reddit&#39;s API has no per-thread cursor. Very long threads may be upstream-truncated by Reddit&#39;s inbox/sent windows (~100 most-recent items each); this is a Reddit platform limitation. Instagram and Facebook conversations include history from before the account was connected, replayed from Meta. That replay covers the 500 most recent messages per conversation: a longer thread keeps its newest 500 and older messages are not retrievable. Messages that arrived after the account was connected are unaffected. Replayed messages are stored as already read and emit no webhooks. Twitter/X limitation: X&#39;s encrypted \&quot;X Chat\&quot; messages are not accessible via the API. Conversations where the other participant uses encrypted X Chat may only show your outgoing messages. See the list conversations endpoint for more details. This endpoint is read-only and does NOT mark messages as read or send read receipts. To mark a conversation read (and send WhatsApp blue ticks on eligible accounts), call &#x60;POST /v1/inbox/conversations/{conversationId}/read&#x60;.
412
- # @param conversation_id [String] The conversation ID (id field from list conversations endpoint). This is the platform-specific conversation identifier, not an internal database ID.
412
+ # @param conversation_id [String] Opaque conversation identifier, accepted verbatim from the list endpoint or from the conversationId on inbox webhooks. Format not to be assumed.
413
413
  # @param account_id [String] Social account ID
414
414
  # @param [Hash] opts the optional parameters
415
415
  # @option opts [Integer] :limit Number of messages to return per page. Default 100, max 100. (default to 100)
@@ -1088,7 +1088,7 @@ module Zernio
1088
1088
 
1089
1089
  # Update conversation status
1090
1090
  # Archive or activate a conversation. Requires accountId in request body.
1091
- # @param conversation_id [String] The conversation ID (id field from list conversations endpoint). This is the platform-specific conversation identifier, not an internal database ID.
1091
+ # @param conversation_id [String] Opaque conversation identifier, accepted verbatim from the list endpoint or from the conversationId on inbox webhooks. Format not to be assumed.
1092
1092
  # @param update_inbox_conversation_request [UpdateInboxConversationRequest]
1093
1093
  # @param [Hash] opts the optional parameters
1094
1094
  # @return [UpdateInboxConversation200Response]
@@ -1099,7 +1099,7 @@ module Zernio
1099
1099
 
1100
1100
  # Update conversation status
1101
1101
  # Archive or activate a conversation. Requires accountId in request body.
1102
- # @param conversation_id [String] The conversation ID (id field from list conversations endpoint). This is the platform-specific conversation identifier, not an internal database ID.
1102
+ # @param conversation_id [String] Opaque conversation identifier, accepted verbatim from the list endpoint or from the conversationId on inbox webhooks. Format not to be assumed.
1103
1103
  # @param update_inbox_conversation_request [UpdateInboxConversationRequest]
1104
1104
  # @param [Hash] opts the optional parameters
1105
1105
  # @return [Array<(UpdateInboxConversation200Response, Integer, Hash)>] UpdateInboxConversation200Response data, response status code and response headers
@@ -11,5 +11,5 @@ Generator version: 7.19.0
11
11
  =end
12
12
 
13
13
  module Zernio
14
- VERSION = '0.0.830'
14
+ VERSION = '0.0.831'
15
15
  end
data/openapi.yaml CHANGED
@@ -27032,7 +27032,7 @@ paths:
27032
27032
  in: path
27033
27033
  required: true
27034
27034
  schema: { type: string }
27035
- description: The conversation ID (id field from list conversations endpoint). This is the platform-specific conversation identifier, not an internal database ID.
27035
+ description: 'Opaque conversation identifier, accepted verbatim from the list endpoint or from the conversationId on inbox webhooks. Format not to be assumed.'
27036
27036
  - name: accountId
27037
27037
  in: query
27038
27038
  required: true
@@ -27169,7 +27169,7 @@ paths:
27169
27169
  in: path
27170
27170
  required: true
27171
27171
  schema: { type: string }
27172
- description: The conversation ID (id field from list conversations endpoint). This is the platform-specific conversation identifier, not an internal database ID.
27172
+ description: 'Opaque conversation identifier, accepted verbatim from the list endpoint or from the conversationId on inbox webhooks. Format not to be assumed.'
27173
27173
  requestBody:
27174
27174
  required: true
27175
27175
  content:
@@ -27249,7 +27249,7 @@ paths:
27249
27249
  in: path
27250
27250
  required: true
27251
27251
  schema: { type: string }
27252
- description: The conversation ID (id field from list conversations endpoint). This is the platform-specific conversation identifier, not an internal database ID.
27252
+ description: 'Opaque conversation identifier, accepted verbatim from the list endpoint or from the conversationId on inbox webhooks. Format not to be assumed.'
27253
27253
  - name: accountId
27254
27254
  in: query
27255
27255
  required: true
@@ -89,7 +89,7 @@ describe 'MessagesApi' do
89
89
  # unit tests for get_inbox_conversation
90
90
  # Get conversation
91
91
  # Retrieve details and metadata for a specific conversation. Requires accountId query parameter.
92
- # @param conversation_id The conversation ID (id field from list conversations endpoint). This is the platform-specific conversation identifier, not an internal database ID.
92
+ # @param conversation_id Opaque conversation identifier, accepted verbatim from the list endpoint or from the conversationId on inbox webhooks. Format not to be assumed.
93
93
  # @param account_id The social account ID
94
94
  # @param [Hash] opts the optional parameters
95
95
  # @return [GetInboxConversation200Response]
@@ -102,7 +102,7 @@ describe 'MessagesApi' do
102
102
  # unit tests for get_inbox_conversation_messages
103
103
  # List messages
104
104
  # Fetch messages for a specific conversation, with cursor-based pagination and ordering control. Pagination: pass &#x60;pagination.nextCursor&#x60; from a prior response back as the &#x60;cursor&#x60; query param to fetch the next page. The cursor is opaque; do not parse or construct it client-side. Sort order: defaults to &#x60;asc&#x60; (oldest first, chat style). For the \&quot;show me the latest messages\&quot; pattern, pass &#x60;?sortOrder&#x3D;desc&amp;limit&#x3D;N&#x60;. Twitter, Instagram, Telegram, WhatsApp and Reddit honor the requested order from the local message store. For Facebook and Bluesky, the upstream APIs only return newest-first and have no order parameter — sort order is best-effort and only reverses items within a single page (pages still walk newest→oldest). The response field &#x60;sortOrderApplied&#x60; tells you what was actually applied. Reddit threads are paginated client-side because Reddit&#39;s API has no per-thread cursor. Very long threads may be upstream-truncated by Reddit&#39;s inbox/sent windows (~100 most-recent items each); this is a Reddit platform limitation. Instagram and Facebook conversations include history from before the account was connected, replayed from Meta. That replay covers the 500 most recent messages per conversation: a longer thread keeps its newest 500 and older messages are not retrievable. Messages that arrived after the account was connected are unaffected. Replayed messages are stored as already read and emit no webhooks. Twitter/X limitation: X&#39;s encrypted \&quot;X Chat\&quot; messages are not accessible via the API. Conversations where the other participant uses encrypted X Chat may only show your outgoing messages. See the list conversations endpoint for more details. This endpoint is read-only and does NOT mark messages as read or send read receipts. To mark a conversation read (and send WhatsApp blue ticks on eligible accounts), call &#x60;POST /v1/inbox/conversations/{conversationId}/read&#x60;.
105
- # @param conversation_id The conversation ID (id field from list conversations endpoint). This is the platform-specific conversation identifier, not an internal database ID.
105
+ # @param conversation_id Opaque conversation identifier, accepted verbatim from the list endpoint or from the conversationId on inbox webhooks. Format not to be assumed.
106
106
  # @param account_id Social account ID
107
107
  # @param [Hash] opts the optional parameters
108
108
  # @option opts [Integer] :limit Number of messages to return per page. Default 100, max 100.
@@ -224,7 +224,7 @@ describe 'MessagesApi' do
224
224
  # unit tests for update_inbox_conversation
225
225
  # Update conversation status
226
226
  # Archive or activate a conversation. Requires accountId in request body.
227
- # @param conversation_id The conversation ID (id field from list conversations endpoint). This is the platform-specific conversation identifier, not an internal database ID.
227
+ # @param conversation_id Opaque conversation identifier, accepted verbatim from the list endpoint or from the conversationId on inbox webhooks. Format not to be assumed.
228
228
  # @param update_inbox_conversation_request
229
229
  # @param [Hash] opts the optional parameters
230
230
  # @return [UpdateInboxConversation200Response]