late-sdk 0.0.958 → 0.0.960

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.
Files changed (38) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -0
  3. data/docs/CheckPhoneNumberAvailability200Response.md +3 -1
  4. data/docs/CheckPhoneNumberAvailability200ResponseSoldOutAreasInner.md +22 -0
  5. data/docs/CreatePhoneNumberStockWatchRequest.md +3 -1
  6. data/docs/PhoneNumberStockWatch.md +2 -0
  7. data/docs/PhoneNumbersApi.md +1 -1
  8. data/docs/RespondToPhoneNumberReviewerRequestDocumentsInner.md +3 -1
  9. data/docs/SubmitPhoneNumberKycRequest.md +2 -0
  10. data/docs/SubmitPhoneNumberKycRequestDocumentsInnerOneOf1.md +3 -1
  11. data/docs/SubmitWhatsAppNumberKycRequest.md +2 -0
  12. data/docs/WebhookPayloadPhoneNumberStockAvailableStock.md +5 -1
  13. data/lib/zernio-sdk/api/phone_numbers_api.rb +2 -2
  14. data/lib/zernio-sdk/models/check_phone_number_availability200_response.rb +16 -4
  15. data/lib/zernio-sdk/models/check_phone_number_availability200_response_sold_out_areas_inner.rb +168 -0
  16. data/lib/zernio-sdk/models/create_phone_number_stock_watch_request.rb +35 -4
  17. data/lib/zernio-sdk/models/phone_number_stock_watch.rb +12 -1
  18. data/lib/zernio-sdk/models/respond_to_phone_number_reviewer_request_documents_inner.rb +14 -4
  19. data/lib/zernio-sdk/models/submit_phone_number_kyc_request.rb +11 -1
  20. data/lib/zernio-sdk/models/submit_phone_number_kyc_request_documents_inner_one_of1.rb +14 -4
  21. data/lib/zernio-sdk/models/submit_whats_app_number_kyc_request.rb +11 -1
  22. data/lib/zernio-sdk/models/webhook_payload_phone_number_stock_available_stock.rb +24 -4
  23. data/lib/zernio-sdk/version.rb +1 -1
  24. data/lib/zernio-sdk.rb +1 -0
  25. data/openapi.yaml +43 -1
  26. data/spec/api/phone_numbers_api_spec.rb +1 -1
  27. data/spec/models/check_phone_number_availability200_response_sold_out_areas_inner_spec.rb +48 -0
  28. data/spec/models/check_phone_number_availability200_response_spec.rb +6 -0
  29. data/spec/models/create_phone_number_stock_watch_request_spec.rb +6 -0
  30. data/spec/models/phone_number_stock_watch_spec.rb +6 -0
  31. data/spec/models/respond_to_phone_number_reviewer_request_documents_inner_spec.rb +6 -0
  32. data/spec/models/submit_phone_number_kyc_request_documents_inner_one_of1_spec.rb +6 -0
  33. data/spec/models/submit_phone_number_kyc_request_spec.rb +6 -0
  34. data/spec/models/submit_whats_app_number_kyc_request_spec.rb +6 -0
  35. data/spec/models/webhook_payload_phone_number_stock_available_stock_spec.rb +12 -0
  36. data/zernio-sdk-0.0.960.gem +0 -0
  37. metadata +6 -2
  38. data/zernio-sdk-0.0.958.gem +0 -0
@@ -25,13 +25,17 @@ module Zernio
25
25
  # Id of a document already uploaded out-of-band.
26
26
  attr_accessor :document_id
27
27
 
28
+ # Date printed on the document (YYYY-MM-DD), for slots the regulator windows such as proof of address. The pre-submit review trusts it over its own read of the PDF.
29
+ attr_accessor :issued_at
30
+
28
31
  # Attribute mapping from ruby-style variable name to JSON key.
29
32
  def self.attribute_map
30
33
  {
31
34
  :'requirement_id' => :'requirementId',
32
35
  :'filename' => :'filename',
33
36
  :'base64' => :'base64',
34
- :'document_id' => :'documentId'
37
+ :'document_id' => :'documentId',
38
+ :'issued_at' => :'issuedAt'
35
39
  }
36
40
  end
37
41
 
@@ -51,7 +55,8 @@ module Zernio
51
55
  :'requirement_id' => :'String',
52
56
  :'filename' => :'String',
53
57
  :'base64' => :'String',
54
- :'document_id' => :'String'
58
+ :'document_id' => :'String',
59
+ :'issued_at' => :'Date'
55
60
  }
56
61
  end
57
62
 
@@ -94,6 +99,10 @@ module Zernio
94
99
  if attributes.key?(:'document_id')
95
100
  self.document_id = attributes[:'document_id']
96
101
  end
102
+
103
+ if attributes.key?(:'issued_at')
104
+ self.issued_at = attributes[:'issued_at']
105
+ end
97
106
  end
98
107
 
99
108
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -134,7 +143,8 @@ module Zernio
134
143
  requirement_id == o.requirement_id &&
135
144
  filename == o.filename &&
136
145
  base64 == o.base64 &&
137
- document_id == o.document_id
146
+ document_id == o.document_id &&
147
+ issued_at == o.issued_at
138
148
  end
139
149
 
140
150
  # @see the `==` method
@@ -146,7 +156,7 @@ module Zernio
146
156
  # Calculates hash code according to all attributes.
147
157
  # @return [Integer] Hash code
148
158
  def hash
149
- [requirement_id, filename, base64, document_id].hash
159
+ [requirement_id, filename, base64, document_id, issued_at].hash
150
160
  end
151
161
 
152
162
  # Builds the object from hash
@@ -37,6 +37,9 @@ module Zernio
37
37
  # Area code (NDC) the number must be in. Hard constraint: an empty area pool fails with 409 code AREA_CODE_UNAVAILABLE instead of ordering from another area. Omit for any area. Options come from GET /v1/phone-numbers/availability (areaOptions); the purchase 202 kycUrl echoes the areaCode picked at purchase time so it can be passed here.
38
38
  attr_accessor :area_code
39
39
 
40
+ # With areaCode: pre-order that area when it has no stock (an area listed in soldOutAreas with preOrderable true) instead of failing with AREA_CODE_UNAVAILABLE. The carrier sources a number in that area.
41
+ attr_accessor :pre_order
42
+
40
43
  # End user's legal first name. Required when the country has an action/ID-verification (Onfido) requirement.
41
44
  attr_accessor :end_user_first_name
42
45
 
@@ -62,6 +65,7 @@ module Zernio
62
65
  :'reuse_option_id' => :'reuseOptionId',
63
66
  :'reuse_from' => :'reuseFrom',
64
67
  :'area_code' => :'areaCode',
68
+ :'pre_order' => :'preOrder',
65
69
  :'end_user_first_name' => :'endUserFirstName',
66
70
  :'end_user_last_name' => :'endUserLastName',
67
71
  :'values' => :'values',
@@ -91,6 +95,7 @@ module Zernio
91
95
  :'reuse_option_id' => :'String',
92
96
  :'reuse_from' => :'String',
93
97
  :'area_code' => :'String',
98
+ :'pre_order' => :'Boolean',
94
99
  :'end_user_first_name' => :'String',
95
100
  :'end_user_last_name' => :'String',
96
101
  :'values' => :'Hash<String, String>',
@@ -159,6 +164,10 @@ module Zernio
159
164
  self.area_code = attributes[:'area_code']
160
165
  end
161
166
 
167
+ if attributes.key?(:'pre_order')
168
+ self.pre_order = attributes[:'pre_order']
169
+ end
170
+
162
171
  if attributes.key?(:'end_user_first_name')
163
172
  self.end_user_first_name = attributes[:'end_user_first_name']
164
173
  end
@@ -291,6 +300,7 @@ module Zernio
291
300
  reuse_option_id == o.reuse_option_id &&
292
301
  reuse_from == o.reuse_from &&
293
302
  area_code == o.area_code &&
303
+ pre_order == o.pre_order &&
294
304
  end_user_first_name == o.end_user_first_name &&
295
305
  end_user_last_name == o.end_user_last_name &&
296
306
  values == o.values &&
@@ -307,7 +317,7 @@ module Zernio
307
317
  # Calculates hash code according to all attributes.
308
318
  # @return [Integer] Hash code
309
319
  def hash
310
- [profile_id, country, submission_id, quantity, reuse, reuse_option_id, reuse_from, area_code, end_user_first_name, end_user_last_name, values, documents, address].hash
320
+ [profile_id, country, submission_id, quantity, reuse, reuse_option_id, reuse_from, area_code, pre_order, end_user_first_name, end_user_last_name, values, documents, address].hash
311
321
  end
312
322
 
313
323
  # Builds the object from hash
@@ -20,11 +20,15 @@ module Zernio
20
20
  # Id from POST /v1/phone-numbers/kyc/upload-document.
21
21
  attr_accessor :document_id
22
22
 
23
+ # Date printed on the document (YYYY-MM-DD), for slots the regulator windows such as proof of address. The pre-submit review trusts it over its own read of the PDF.
24
+ attr_accessor :issued_at
25
+
23
26
  # Attribute mapping from ruby-style variable name to JSON key.
24
27
  def self.attribute_map
25
28
  {
26
29
  :'requirement_id' => :'requirementId',
27
- :'document_id' => :'documentId'
30
+ :'document_id' => :'documentId',
31
+ :'issued_at' => :'issuedAt'
28
32
  }
29
33
  end
30
34
 
@@ -42,7 +46,8 @@ module Zernio
42
46
  def self.openapi_types
43
47
  {
44
48
  :'requirement_id' => :'String',
45
- :'document_id' => :'String'
49
+ :'document_id' => :'String',
50
+ :'issued_at' => :'Date'
46
51
  }
47
52
  end
48
53
 
@@ -79,6 +84,10 @@ module Zernio
79
84
  else
80
85
  self.document_id = nil
81
86
  end
87
+
88
+ if attributes.key?(:'issued_at')
89
+ self.issued_at = attributes[:'issued_at']
90
+ end
82
91
  end
83
92
 
84
93
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -132,7 +141,8 @@ module Zernio
132
141
  return true if self.equal?(o)
133
142
  self.class == o.class &&
134
143
  requirement_id == o.requirement_id &&
135
- document_id == o.document_id
144
+ document_id == o.document_id &&
145
+ issued_at == o.issued_at
136
146
  end
137
147
 
138
148
  # @see the `==` method
@@ -144,7 +154,7 @@ module Zernio
144
154
  # Calculates hash code according to all attributes.
145
155
  # @return [Integer] Hash code
146
156
  def hash
147
- [requirement_id, document_id].hash
157
+ [requirement_id, document_id, issued_at].hash
148
158
  end
149
159
 
150
160
  # Builds the object from hash
@@ -37,6 +37,9 @@ module Zernio
37
37
  # Area code (NDC) the number must be in. Hard constraint: an empty area pool fails with 409 code AREA_CODE_UNAVAILABLE instead of ordering from another area. Omit for any area. Options come from GET /v1/phone-numbers/availability (areaOptions); the purchase 202 kycUrl echoes the areaCode picked at purchase time so it can be passed here.
38
38
  attr_accessor :area_code
39
39
 
40
+ # With areaCode: pre-order that area when it has no stock (an area listed in soldOutAreas with preOrderable true) instead of failing with AREA_CODE_UNAVAILABLE. The carrier sources a number in that area.
41
+ attr_accessor :pre_order
42
+
40
43
  # End user's legal first name. Required when the country has an action/ID-verification (Onfido) requirement.
41
44
  attr_accessor :end_user_first_name
42
45
 
@@ -62,6 +65,7 @@ module Zernio
62
65
  :'reuse_option_id' => :'reuseOptionId',
63
66
  :'reuse_from' => :'reuseFrom',
64
67
  :'area_code' => :'areaCode',
68
+ :'pre_order' => :'preOrder',
65
69
  :'end_user_first_name' => :'endUserFirstName',
66
70
  :'end_user_last_name' => :'endUserLastName',
67
71
  :'values' => :'values',
@@ -91,6 +95,7 @@ module Zernio
91
95
  :'reuse_option_id' => :'String',
92
96
  :'reuse_from' => :'String',
93
97
  :'area_code' => :'String',
98
+ :'pre_order' => :'Boolean',
94
99
  :'end_user_first_name' => :'String',
95
100
  :'end_user_last_name' => :'String',
96
101
  :'values' => :'Hash<String, String>',
@@ -159,6 +164,10 @@ module Zernio
159
164
  self.area_code = attributes[:'area_code']
160
165
  end
161
166
 
167
+ if attributes.key?(:'pre_order')
168
+ self.pre_order = attributes[:'pre_order']
169
+ end
170
+
162
171
  if attributes.key?(:'end_user_first_name')
163
172
  self.end_user_first_name = attributes[:'end_user_first_name']
164
173
  end
@@ -291,6 +300,7 @@ module Zernio
291
300
  reuse_option_id == o.reuse_option_id &&
292
301
  reuse_from == o.reuse_from &&
293
302
  area_code == o.area_code &&
303
+ pre_order == o.pre_order &&
294
304
  end_user_first_name == o.end_user_first_name &&
295
305
  end_user_last_name == o.end_user_last_name &&
296
306
  values == o.values &&
@@ -307,7 +317,7 @@ module Zernio
307
317
  # Calculates hash code according to all attributes.
308
318
  # @return [Integer] Hash code
309
319
  def hash
310
- [profile_id, country, submission_id, quantity, reuse, reuse_option_id, reuse_from, area_code, end_user_first_name, end_user_last_name, values, documents, address].hash
320
+ [profile_id, country, submission_id, quantity, reuse, reuse_option_id, reuse_from, area_code, pre_order, end_user_first_name, end_user_last_name, values, documents, address].hash
311
321
  end
312
322
 
313
323
  # Builds the object from hash
@@ -21,11 +21,19 @@ module Zernio
21
21
  # Number types deliverable at sweep time. Only types with stock are listed.
22
22
  attr_accessor :types
23
23
 
24
+ # Set when the watch named an area: the area code (NDC) that is back in stock.
25
+ attr_accessor :area_code
26
+
27
+ # The name of that area, when known.
28
+ attr_accessor :area_name
29
+
24
30
  # Attribute mapping from ruby-style variable name to JSON key.
25
31
  def self.attribute_map
26
32
  {
27
33
  :'country' => :'country',
28
- :'types' => :'types'
34
+ :'types' => :'types',
35
+ :'area_code' => :'areaCode',
36
+ :'area_name' => :'areaName'
29
37
  }
30
38
  end
31
39
 
@@ -43,7 +51,9 @@ module Zernio
43
51
  def self.openapi_types
44
52
  {
45
53
  :'country' => :'String',
46
- :'types' => :'Array<WebhookPayloadPhoneNumberStockAvailableStockTypesInner>'
54
+ :'types' => :'Array<WebhookPayloadPhoneNumberStockAvailableStockTypesInner>',
55
+ :'area_code' => :'String',
56
+ :'area_name' => :'String'
47
57
  }
48
58
  end
49
59
 
@@ -82,6 +92,14 @@ module Zernio
82
92
  else
83
93
  self.types = nil
84
94
  end
95
+
96
+ if attributes.key?(:'area_code')
97
+ self.area_code = attributes[:'area_code']
98
+ end
99
+
100
+ if attributes.key?(:'area_name')
101
+ self.area_name = attributes[:'area_name']
102
+ end
85
103
  end
86
104
 
87
105
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -135,7 +153,9 @@ module Zernio
135
153
  return true if self.equal?(o)
136
154
  self.class == o.class &&
137
155
  country == o.country &&
138
- types == o.types
156
+ types == o.types &&
157
+ area_code == o.area_code &&
158
+ area_name == o.area_name
139
159
  end
140
160
 
141
161
  # @see the `==` method
@@ -147,7 +167,7 @@ module Zernio
147
167
  # Calculates hash code according to all attributes.
148
168
  # @return [Integer] Hash code
149
169
  def hash
150
- [country, types].hash
170
+ [country, types, area_code, area_name].hash
151
171
  end
152
172
 
153
173
  # Builds the object from hash
@@ -11,5 +11,5 @@ Generator version: 7.19.0
11
11
  =end
12
12
 
13
13
  module Zernio
14
- VERSION = '0.0.958'
14
+ VERSION = '0.0.960'
15
15
  end
data/lib/zernio-sdk.rb CHANGED
@@ -213,6 +213,7 @@ require 'zernio-sdk/models/channel_picker_channels_inner'
213
213
  require 'zernio-sdk/models/channel_picker_team'
214
214
  require 'zernio-sdk/models/check_phone_number_availability200_response'
215
215
  require 'zernio-sdk/models/check_phone_number_availability200_response_area_options_inner'
216
+ require 'zernio-sdk/models/check_phone_number_availability200_response_sold_out_areas_inner'
216
217
  require 'zernio-sdk/models/check_phone_number_portability200_response'
217
218
  require 'zernio-sdk/models/check_phone_number_portability200_response_results_inner'
218
219
  require 'zernio-sdk/models/check_phone_number_portability_request'
data/openapi.yaml CHANGED
@@ -3044,6 +3044,9 @@ components:
3044
3044
  type: [string, "null"]
3045
3045
  enum: [local, mobile, national, toll_free, null]
3046
3046
  description: 'The watched number type, or null when the watch covers every type in the country.'
3047
+ areaCode:
3048
+ type: [string, "null"]
3049
+ description: 'The watched area code (NDC), or null when the watch covers every area.'
3047
3050
  createdAt: { type: string, format: date-time }
3048
3051
  WebhookPayloadPhoneNumberStockAvailable:
3049
3052
  type: object
@@ -3072,6 +3075,8 @@ components:
3072
3075
  properties:
3073
3076
  numberType: { type: string, description: 'local, mobile, national or toll_free.' }
3074
3077
  availableCount: { type: integer, description: 'Deliverable numbers at sweep time; first come, first served.' }
3078
+ areaCode: { type: string, description: 'Set when the watch named an area: the area code (NDC) that is back in stock.' }
3079
+ areaName: { type: string, description: 'The name of that area, when known.' }
3075
3080
  timestamp:
3076
3081
  type: string
3077
3082
  format: date-time
@@ -37357,6 +37362,19 @@ paths:
37357
37362
  ndc: { type: string, description: 'Area code (national destination code), e.g. "11".' }
37358
37363
  name: { type: string, description: 'Area name: "City, ST" for US/CA (e.g. "Miami, FL"), city otherwise (e.g. "Sao Paulo").' }
37359
37364
  count: { type: integer, description: 'Numbers available in this area: country-wide count for US/CA, numbers seen on the latest inventory page otherwise.' }
37365
+ soldOutAreas:
37366
+ type: array
37367
+ description: >
37368
+ Areas that had stock in the last 90 days and have none
37369
+ now. Pass one as `areaCode` with `preOrder: true` on the
37370
+ KYC submit when `preOrderable` is true, or watch it with
37371
+ POST /v1/phone-numbers/stock-watches.
37372
+ items:
37373
+ type: object
37374
+ properties:
37375
+ ndc: { type: string, description: 'Area code (national destination code).' }
37376
+ name: { type: string, description: 'Area name.' }
37377
+ preOrderable: { type: boolean, description: 'Whether this area can be pre-ordered: the carrier sources a number in it (usually 2 to 4 weeks, never guaranteed).' }
37360
37378
  '400': { description: 'Country not offerable, or the inventory provider rejected the lookup (its 4xx status is forwarded as-is).' }
37361
37379
  '401': { $ref: '#/components/responses/Unauthorized' }
37362
37380
  '502': { description: 'The inventory provider was unreachable or returned an unclassified error.' }
@@ -37753,6 +37771,19 @@ paths:
37753
37771
  ndc: { type: string, description: 'Area code (national destination code), e.g. "11".' }
37754
37772
  name: { type: string, description: 'Area name: "City, ST" for US/CA (e.g. "Miami, FL"), city otherwise (e.g. "Sao Paulo").' }
37755
37773
  count: { type: integer, description: 'Numbers available in this area: country-wide count for US/CA, numbers seen on the latest inventory page otherwise.' }
37774
+ soldOutAreas:
37775
+ type: array
37776
+ description: >
37777
+ Areas that had stock in the last 90 days and have none
37778
+ now. Pass one as `areaCode` with `preOrder: true` on the
37779
+ KYC submit when `preOrderable` is true, or watch it with
37780
+ POST /v1/phone-numbers/stock-watches.
37781
+ items:
37782
+ type: object
37783
+ properties:
37784
+ ndc: { type: string, description: 'Area code (national destination code).' }
37785
+ name: { type: string, description: 'Area name.' }
37786
+ preOrderable: { type: boolean, description: 'Whether this area can be pre-ordered: the carrier sources a number in it (usually 2 to 4 weeks, never guaranteed).' }
37756
37787
  '400': { description: 'Country not offerable, or the inventory provider rejected the lookup (its 4xx status is forwarded as-is).' }
37757
37788
  '401': { $ref: '#/components/responses/Unauthorized' }
37758
37789
  '502': { description: 'The inventory provider was unreachable or returned an unclassified error.' }
@@ -37868,6 +37899,7 @@ paths:
37868
37899
  reuseOptionId: { type: string, description: 'Which reusable verification to use (GET reusable.options[].id). The unambiguous selection key. Omitted = the approved default. No match = 409.' }
37869
37900
  reuseFrom: { type: string, description: 'Legacy fallback for `reuseOptionId`: the source phone number (GET reusable.options[].fromPhoneNumber). Ambiguous when a number labels two verifications, so prefer `reuseOptionId`. Omitted = the approved default. No match = 409.' }
37870
37901
  areaCode: { type: string, pattern: '^\d{1,4}$', description: 'Area code (NDC) the number must be in. Hard constraint: an empty area pool fails with 409 code AREA_CODE_UNAVAILABLE instead of ordering from another area. Omit for any area. Options come from GET /v1/phone-numbers/availability (areaOptions); the purchase 202 kycUrl echoes the areaCode picked at purchase time so it can be passed here.' }
37902
+ preOrder: { type: boolean, description: 'With areaCode: pre-order that area when it has no stock (an area listed in soldOutAreas with preOrderable true) instead of failing with AREA_CODE_UNAVAILABLE. The carrier sources a number in that area.' }
37871
37903
  endUserFirstName: { type: string, description: End user's legal first name. Required when the country has an action/ID-verification (Onfido) requirement. }
37872
37904
  endUserLastName: { type: string, description: End user's legal last name. Same condition as endUserFirstName. }
37873
37905
  values:
@@ -37890,6 +37922,7 @@ paths:
37890
37922
  properties:
37891
37923
  requirementId: { type: string }
37892
37924
  documentId: { type: string, description: Id from POST /v1/phone-numbers/kyc/upload-document. }
37925
+ issuedAt: { type: string, format: date, description: 'Date printed on the document (YYYY-MM-DD), for slots the regulator windows such as proof of address. The pre-submit review trusts it over its own read of the PDF.' }
37893
37926
  address:
37894
37927
  type: object
37895
37928
  properties:
@@ -38519,6 +38552,7 @@ paths:
38519
38552
  properties:
38520
38553
  requirementId: { type: string }
38521
38554
  documentId: { type: string, description: Id from POST /v1/phone-numbers/kyc/upload-document. }
38555
+ issuedAt: { type: string, format: date, description: 'Date printed on the document (YYYY-MM-DD), for slots the regulator windows such as proof of address. The pre-submit review trusts it over its own read of the PDF.' }
38522
38556
  responses:
38523
38557
  '200':
38524
38558
  description: Advisories (empty when the packet looks fine or the review was unavailable).
@@ -38704,6 +38738,7 @@ paths:
38704
38738
  filename: { type: string }
38705
38739
  base64: { type: string, description: Base64-encoded file bytes (or supply documentId instead). }
38706
38740
  documentId: { type: string, description: Id of a document already uploaded out-of-band. }
38741
+ issuedAt: { type: string, format: date, description: 'Date printed on the document (YYYY-MM-DD), for slots the regulator windows such as proof of address. The pre-submit review trusts it over its own read of the PDF.' }
38707
38742
  address:
38708
38743
  type: object
38709
38744
  description: A corrected address record, keyed to its requirement.
@@ -38862,6 +38897,7 @@ paths:
38862
38897
  reuseOptionId: { type: string, description: 'Which reusable verification to use (GET reusable.options[].id). The unambiguous selection key. Omitted = the approved default. No match = 409.' }
38863
38898
  reuseFrom: { type: string, description: 'Legacy fallback for `reuseOptionId`: the source phone number (GET reusable.options[].fromPhoneNumber). Ambiguous when a number labels two verifications, so prefer `reuseOptionId`. Omitted = the approved default. No match = 409.' }
38864
38899
  areaCode: { type: string, pattern: '^\d{1,4}$', description: 'Area code (NDC) the number must be in. Hard constraint: an empty area pool fails with 409 code AREA_CODE_UNAVAILABLE instead of ordering from another area. Omit for any area. Options come from GET /v1/phone-numbers/availability (areaOptions); the purchase 202 kycUrl echoes the areaCode picked at purchase time so it can be passed here.' }
38900
+ preOrder: { type: boolean, description: 'With areaCode: pre-order that area when it has no stock (an area listed in soldOutAreas with preOrderable true) instead of failing with AREA_CODE_UNAVAILABLE. The carrier sources a number in that area.' }
38865
38901
  endUserFirstName: { type: string, description: End user's legal first name. Required when the country has an action/ID-verification (Onfido) requirement. }
38866
38902
  endUserLastName: { type: string, description: End user's legal last name. Same condition as endUserFirstName. }
38867
38903
  values:
@@ -39382,6 +39418,11 @@ paths:
39382
39418
  GET /v1/phone-numbers/countries can also be watched, but anything with
39383
39419
  `preOrderable: true` does not need a watch: submit KYC and the carrier
39384
39420
  sources the number to order.
39421
+
39422
+ Pass `areaCode` (with `numberType`) to watch one sold-out area, for
39423
+ example an entry of `soldOutAreas` from
39424
+ GET /v1/phone-numbers/availability. Area stock is checked live on the
39425
+ same 6h cadence.
39385
39426
  security:
39386
39427
  - bearerAuth: []
39387
39428
  requestBody:
@@ -39397,6 +39438,7 @@ paths:
39397
39438
  type: string
39398
39439
  enum: [local, mobile, national, toll_free]
39399
39440
  description: 'Narrow the watch to one number type. Omit to be notified when any type in the country is back.'
39441
+ areaCode: { type: string, pattern: '^\d{1,4}$', description: 'Narrow the watch to one area code (NDC). Requires numberType.' }
39400
39442
  responses:
39401
39443
  '201':
39402
39444
  description: Watch created.
@@ -39412,7 +39454,7 @@ paths:
39412
39454
  $ref: '#/components/schemas/PhoneNumberStockWatch'
39413
39455
  '400': { $ref: '#/components/responses/BadRequest' }
39414
39456
  '401': { $ref: '#/components/responses/Unauthorized' }
39415
- '409': { description: 'The country is in stock right now (buy instead of watching), or the 20-country watch limit is reached (code invalid_resource_state).' }
39457
+ '409': { description: 'The country (or the watched area) is in stock right now (buy instead of watching), or the 20-watch limit is reached (code invalid_resource_state).' }
39416
39458
  get:
39417
39459
  x-resource-group: "telephony"
39418
39460
  operationId: listPhoneNumberStockWatches
@@ -96,7 +96,7 @@ describe 'PhoneNumbersApi' do
96
96
 
97
97
  # unit tests for create_phone_number_stock_watch
98
98
  # Watch an out-of-stock country
99
- # Get notified the first time an out-of-stock country has deliverable numbers again: an email to the account holder plus the &#x60;phone_number.stock_available&#x60; webhook. Stock is re-checked every 6h. One watch per country and number type; a repeat request returns the existing watch (200). The watch is consumed when it fires, so re-create it if you miss the stock. Up to 20 watches at once. Countries and types marked &#x60;fulfilment: request&#x60; by GET /v1/phone-numbers/countries can also be watched, but anything with &#x60;preOrderable: true&#x60; does not need a watch: submit KYC and the carrier sources the number to order.
99
+ # Get notified the first time an out-of-stock country has deliverable numbers again: an email to the account holder plus the &#x60;phone_number.stock_available&#x60; webhook. Stock is re-checked every 6h. One watch per country and number type; a repeat request returns the existing watch (200). The watch is consumed when it fires, so re-create it if you miss the stock. Up to 20 watches at once. Countries and types marked &#x60;fulfilment: request&#x60; by GET /v1/phone-numbers/countries can also be watched, but anything with &#x60;preOrderable: true&#x60; does not need a watch: submit KYC and the carrier sources the number to order. Pass &#x60;areaCode&#x60; (with &#x60;numberType&#x60;) to watch one sold-out area, for example an entry of &#x60;soldOutAreas&#x60; from GET /v1/phone-numbers/availability. Area stock is checked live on the same 6h cadence.
100
100
  # @param create_phone_number_stock_watch_request
101
101
  # @param [Hash] opts the optional parameters
102
102
  # @return [PhoneNumberStockWatch]
@@ -0,0 +1,48 @@
1
+ =begin
2
+ #Zernio API
3
+
4
+ #API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api Versioning and deprecation: all endpoints are versioned in the URL path (current version: /v1). Breaking changes only ship in a new path version; existing versions keep working. Deprecated operations are marked 'deprecated: true' in this spec and announced in the changelog (https://zernio.com/changelog) before removal. Errors: every 4xx/5xx response is application/json with a machine-readable 'code' and a human-readable 'error' message (see the ErrorResponse schema).
5
+
6
+ The version of the OpenAPI document: 1.0.4
7
+ Contact: support@zernio.com
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.19.0
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for Zernio::CheckPhoneNumberAvailability200ResponseSoldOutAreasInner
18
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
+ # Please update as you see appropriate
20
+ describe Zernio::CheckPhoneNumberAvailability200ResponseSoldOutAreasInner do
21
+ #let(:instance) { Zernio::CheckPhoneNumberAvailability200ResponseSoldOutAreasInner.new }
22
+
23
+ describe 'test an instance of CheckPhoneNumberAvailability200ResponseSoldOutAreasInner' do
24
+ it 'should create an instance of CheckPhoneNumberAvailability200ResponseSoldOutAreasInner' do
25
+ # uncomment below to test the instance creation
26
+ #expect(instance).to be_instance_of(Zernio::CheckPhoneNumberAvailability200ResponseSoldOutAreasInner)
27
+ end
28
+ end
29
+
30
+ describe 'test attribute "ndc"' do
31
+ it 'should work' do
32
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
33
+ end
34
+ end
35
+
36
+ describe 'test attribute "name"' do
37
+ it 'should work' do
38
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
39
+ end
40
+ end
41
+
42
+ describe 'test attribute "pre_orderable"' do
43
+ it 'should work' do
44
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
45
+ end
46
+ end
47
+
48
+ end
@@ -73,4 +73,10 @@ describe Zernio::CheckPhoneNumberAvailability200Response do
73
73
  end
74
74
  end
75
75
 
76
+ describe 'test attribute "sold_out_areas"' do
77
+ it 'should work' do
78
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
79
+ end
80
+ end
81
+
76
82
  end
@@ -43,4 +43,10 @@ describe Zernio::CreatePhoneNumberStockWatchRequest do
43
43
  end
44
44
  end
45
45
 
46
+ describe 'test attribute "area_code"' do
47
+ it 'should work' do
48
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
49
+ end
50
+ end
51
+
46
52
  end
@@ -55,6 +55,12 @@ describe Zernio::PhoneNumberStockWatch do
55
55
  end
56
56
  end
57
57
 
58
+ describe 'test attribute "area_code"' do
59
+ it 'should work' do
60
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
61
+ end
62
+ end
63
+
58
64
  describe 'test attribute "created_at"' do
59
65
  it 'should work' do
60
66
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -51,4 +51,10 @@ describe Zernio::RespondToPhoneNumberReviewerRequestDocumentsInner do
51
51
  end
52
52
  end
53
53
 
54
+ describe 'test attribute "issued_at"' do
55
+ it 'should work' do
56
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
57
+ end
58
+ end
59
+
54
60
  end
@@ -39,4 +39,10 @@ describe Zernio::SubmitPhoneNumberKycRequestDocumentsInnerOneOf1 do
39
39
  end
40
40
  end
41
41
 
42
+ describe 'test attribute "issued_at"' do
43
+ it 'should work' do
44
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
45
+ end
46
+ end
47
+
42
48
  end
@@ -75,6 +75,12 @@ describe Zernio::SubmitPhoneNumberKycRequest do
75
75
  end
76
76
  end
77
77
 
78
+ describe 'test attribute "pre_order"' do
79
+ it 'should work' do
80
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
81
+ end
82
+ end
83
+
78
84
  describe 'test attribute "end_user_first_name"' do
79
85
  it 'should work' do
80
86
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -75,6 +75,12 @@ describe Zernio::SubmitWhatsAppNumberKycRequest do
75
75
  end
76
76
  end
77
77
 
78
+ describe 'test attribute "pre_order"' do
79
+ it 'should work' do
80
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
81
+ end
82
+ end
83
+
78
84
  describe 'test attribute "end_user_first_name"' do
79
85
  it 'should work' do
80
86
  # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
@@ -39,4 +39,16 @@ describe Zernio::WebhookPayloadPhoneNumberStockAvailableStock do
39
39
  end
40
40
  end
41
41
 
42
+ describe 'test attribute "area_code"' do
43
+ it 'should work' do
44
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
45
+ end
46
+ end
47
+
48
+ describe 'test attribute "area_name"' do
49
+ it 'should work' do
50
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
51
+ end
52
+ end
53
+
42
54
  end
Binary file
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: late-sdk
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.958
4
+ version: 0.0.960
5
5
  platform: ruby
6
6
  authors:
7
7
  - OpenAPI-Generator
@@ -279,6 +279,7 @@ files:
279
279
  - docs/ChannelPickerTeam.md
280
280
  - docs/CheckPhoneNumberAvailability200Response.md
281
281
  - docs/CheckPhoneNumberAvailability200ResponseAreaOptionsInner.md
282
+ - docs/CheckPhoneNumberAvailability200ResponseSoldOutAreasInner.md
282
283
  - docs/CheckPhoneNumberPortability200Response.md
283
284
  - docs/CheckPhoneNumberPortability200ResponseResultsInner.md
284
285
  - docs/CheckPhoneNumberPortabilityRequest.md
@@ -2475,6 +2476,7 @@ files:
2475
2476
  - lib/zernio-sdk/models/channel_picker_team.rb
2476
2477
  - lib/zernio-sdk/models/check_phone_number_availability200_response.rb
2477
2478
  - lib/zernio-sdk/models/check_phone_number_availability200_response_area_options_inner.rb
2479
+ - lib/zernio-sdk/models/check_phone_number_availability200_response_sold_out_areas_inner.rb
2478
2480
  - lib/zernio-sdk/models/check_phone_number_portability200_response.rb
2479
2481
  - lib/zernio-sdk/models/check_phone_number_portability200_response_results_inner.rb
2480
2482
  - lib/zernio-sdk/models/check_phone_number_portability_request.rb
@@ -4611,6 +4613,7 @@ files:
4611
4613
  - spec/models/channel_picker_spec.rb
4612
4614
  - spec/models/channel_picker_team_spec.rb
4613
4615
  - spec/models/check_phone_number_availability200_response_area_options_inner_spec.rb
4616
+ - spec/models/check_phone_number_availability200_response_sold_out_areas_inner_spec.rb
4614
4617
  - spec/models/check_phone_number_availability200_response_spec.rb
4615
4618
  - spec/models/check_phone_number_portability200_response_results_inner_spec.rb
4616
4619
  - spec/models/check_phone_number_portability200_response_spec.rb
@@ -6484,7 +6487,7 @@ files:
6484
6487
  - spec/models/you_tube_video_retention_response_retention_curve_inner_spec.rb
6485
6488
  - spec/models/you_tube_video_retention_response_spec.rb
6486
6489
  - spec/spec_helper.rb
6487
- - zernio-sdk-0.0.958.gem
6490
+ - zernio-sdk-0.0.960.gem
6488
6491
  - zernio-sdk.gemspec
6489
6492
  homepage: https://openapi-generator.tech
6490
6493
  licenses:
@@ -7243,6 +7246,7 @@ test_files:
7243
7246
  - spec/models/list_local_services_lead_conversations200_response_data_inner_spec.rb
7244
7247
  - spec/models/upload_phone_number_port_in_document200_response_spec.rb
7245
7248
  - spec/models/analytics_delta_entry_spec.rb
7249
+ - spec/models/check_phone_number_availability200_response_sold_out_areas_inner_spec.rb
7246
7250
  - spec/models/list_partnership_ad_permissions200_response_permissions_inner_spec.rb
7247
7251
  - spec/models/update_google_business_location_details_request_regular_hours_spec.rb
7248
7252
  - spec/models/get_campaign_ad_schedule200_response_spec.rb
Binary file